Java RESTful API 接口说明

最近更新时间:2020-07-31 15:47:24

为满足用户使用 Java 操作 TcaplusDB 表,TcaplusDB 基于 RESTful API 封装了 Java SDK。本文主要为您介绍基于此 Java RESTful API 来操作 TcaplusDB PB 表(基于 protobuf 协议)。

准备工作

1. 创建 TcaplusDB 表

创建 TcaplusDB 示例表,示例表为game_players.proto,请参见 创建表格

2. 创建 CVM 实例

  • 创建一台 CVM 实例来运行 SDK 示例程序,配置建议为1核2GB、Centos 7,该 CVM 需创建在 TcaplusDB 实例所在 VPC 网络中。
  • 通过 SDK 下载 Java RESTful API SDK 安装包。

3. 准备 Java 环境

SDK 依赖 Java 1.8 以上环境,CVM 操作系统为 CentOS 7 及以上版本时,执行yum install -y java即可。

4. 接口说明

目前 SDK 示例支持8个接口,详情如下:

接口名 接口用途
addRecord 增加一条 TcaplusDB 记录,记录必须包含所有主键字段值
getRecord 查询一条 TcaplusDB 记录,必须指定主键字段查询
setRecord 更新一条 TcaplusDB 记录,必须指定主键字段更新,若记录不存在则插入一条新记录
deleteRecord 删除一条 TcaplusDB 记录,必须指定主键字段删除
fieldSetRecord 更新指定字段,必须指定主键字段更新
fieldGetRecord 获取指定字段,必须指定主键字段获取
fieldIncRecord 更新指定字段,只针对数值类型字段,自增或自减场景,必须指定主键字段更新
partkeyGetRecord 根据指定的索引名和对应的索引字段值获取相应 TcaplusDB 记录(一条或多条),必须指定对应的索引字段值

使用步骤

上传整个 SDK 包tcaplusdb-restapi-java-sdk-1.0-assembly.zip 到 CVM 目录,请参见 如何将本地文件拷贝到云服务器,解压后目录名tcaplusdb-restapi-java-sdk-1.0

1. 配置准备

配置文件在tcaplusdb-restapi-java-sdk-1.0/conf/config.properties。配置内容如下:

#replace with your table endpoint
endpoint=http://10.xx.xx.16

#replace with your table access id
access_id=60

#replace with your table access password
access_password=Tcaxxx19

#replace with your table group id
table_group_id=1

#replace with your table name
table_name=game_players

#optional, configure the returning fields for GetRecord API, multiple fields with comma delimeter
get_select_fields=

#required, configure the returing fields for FieldGetRecord API
field_get_select_fields=game_server_id,is_online

#optional, configure the returning fields for PartkeyGetRecord API
part_key_get_select_fields=game_server_id,is_online

#required, configure the updating fields for FieldSetRecord API
field_set_fields=game_server_id,pay.amount

#required, configure the index keys for PartkeyGetRecord API
part_key_index_keys=player_id,player_name

#required, configure the index name for PartkeyGetRecord API
part_key_index_name=index_1

#optional, configure the limit number of records per request to return for PartkeyGetRecord API, value range: >0
part_key_limit = 10

#optional, configure the offset position to return for PartkeyGetRecord API, value range: >=0
part_key_offset = 0

2. 准备数据

示例为每个 RESTful API 接口单独准备测试数据,以 json 文件方式放在tcaplusdb-restapi-java-sdk-1.0/conf目录。

文件名 文件说明
add_data.json 用于 addRecord 示例接口,增加一条记录
set_data.json 用于 updateRecord 示例接口,更新一条记录字段值
delete_data.json 用于 deleteRecord 示例接口,删除记录的主键值
get_data.json 用于 getRecord 示例接口,获取记录的主键值
field_get_data.json 用于 fieldGetRecord 示例接口,获取部分字段的值
field_set_data.json 用于 fieldSetRecord 示例接口,更新部分字段的值
field_inc_data.json 用于 fieldIncRecord 示例接口,增加部分字段的值,针对数值类型字段
partkey_get_data.json 用于 partkeyGetRecord 示例接口,根据索引获取记录值

3. 执行脚本

主要执行脚本在tcaplusdb-restapi-java-sdk-1.0/bin/run.sh,执行方法如下:

#增加一条记录
sh bin/run.sh add
#获取一条记录
sh bin/run.sh get
#更新一条记录
sh bin/run.sh set
#删除一条记录
sh bin/run.sh delete
#更新部分字段
sh bin/run.sh field_set
#获取部分字段
sh bin/run.sh field_get
#更新部分字段值(数据类型)
sh bin/run.sh field_inc
#根据索引获取一条记录
sh bin/run.sh partkey_get

接口数据说明

addRecord 接口

增加一条记录,插入的数据格式为 JSON 格式,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com", "game_server_id":2,"login_timestamp":[],"logout_timestamp":[],"is_online":true,"pay":{"pay_id":1,"amount":20,"method":3}}

getRecord 接口

查询一条记录,指定记录的主键字段,数据格式为 JSON,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com"}

查询接口还支持指定要返回的字段列表,在配置文件config.properties中定义了get_select_fields配置项,用于指定要返回的字段名,如果配置为空则默认返回记录所有字段,如果不为空则返回指定的字段值。

setRecord 接口

更新一条记录,更新记录必须包含主键字段,数据格式为 JSON,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com", "game_server_id":2,"login_timestamp":[],"logout_timestamp":[],"is_online":false,"pay":{"pay_id":1,"amount":30,"method":3}}

deleteRecord 接口

删除一条记录,输入数据必须包含主键字段,数据格式为 JSON,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com"}

fieldSetRecord 接口

更新部分字段值,输入数据必须包含主键字段,数据格式为 JSON,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com", "game_server_id":3,"is_online":false, "login_timestamp":[],"logout_timestamp":[],"pay":{"pay_id":1,"amount":40,"method":3}}

同时还需要指定更新的部分字段名,在配置文件config.properties中定义了field_set_fields配置项,指定对应的字段名即可,用逗号隔开,不能为空

fieldGetRecord 接口

获取部分字段值,输入数据必须包含主键字段,数据格式为 JSON,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com"}

同时还需要指定要获取的部分字段名,在配置文件config.properties中定义了field_get_select_fields配置项, 指定需要返回的字段值,不能为空

fieldIncRecord 接口

更新部分字段值,与 fieldSetRecord 接口不同的是,此接口只支持更新数值类型的字段值,如增加或减少相应值,输入数据必须包含主键字段和要更新数值字段,数据格式为 JSON,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com", "pay":{"amount":50}}

假设 pay.amount 初始值为100,请求传参值为50,则最终 pay.amount 值为150。

partkeyGetRecord 接口

根据指定索引获取对应记录,可能对应多条记录,支持返回指定字段的值,输入数据必须包含索引字段,数据格式为JSON,示例数据如下所示:

{"player_id":1,"player_name":"test","player_email":"test@email.com"}

同时还必须指定对应的索引名和索引字段名,在配置文件config.properties中定义:part_key_index_name表示索引名,part_key_index_keys表示索引字段名,这两个配置项不能为空

如果要返回指定字段,支持在配置文件中配置part_key_get_select_fields来指定要返回的字段,可以为空。

对于此接口,1个请求返回的最大包大小为256KB,limit 的设置依赖于单条记录大小。推荐设置策略:

  • 单条记录小于256KB:limit 参考设置为 256KB / [单条记录大小],如记录大小为10KB,则 limit 推荐设置20 - 25左右。
  • 单条记录大于等于256KB:limit 设置为1,即一次请求只返回一条记录。

对于设置 limit 和 offset 的场景,如果要根据索引键获取全量的数据,则需要依据响应包中返回的TotalNum 和 RemainNum标识来判断数据是否获取完全。

设置 limit 和 offset 的场景演示可按如下步骤进行:

#step1,准备批量演示数据,参考 conf/batch_add_data.json. 设置 limit 和 offset 值
part_key_limit = 2
part_key_offset = 0

#step2,批量增加演示数据,用 batch_add 命令,增加3条记录
sh bin/run.sh batch_add

#step3,调用 partkey_get 命令,会执行 partkeyGetRecord 两次:一次不带 limit 和 offset , 一次带 limit 和 offset,观察两次执行的结果差异。
sh bin/run.sh partkey_get

#step4,不带 limit 和 offset 的响应数据如下,总共4条数据
{"MultiRecords":[{"RecordVersion":3,"Record":{"game_server_id":3,"is_online":true,"player_email":"test@email.com","player_id":1,"player_name":"test"}},{"RecordVersion":1,"Record":{"game_server_id":3,"is_online":true,"player_email":"test1@email.com","player_id":1,"player_name":"test"}},{"RecordVersion":1,"Record":{"game_server_id":4,"is_online":true,"player_email":"test2@email.com","player_id":1,"player_name":"test"}},{"RecordVersion":1,"Record":{"game_server_id":5,"is_online":true,"player_email":"test3@email.com","player_id":1,"player_name":"test"}}],"TotalNum":4,"RemainNum":0,"ErrorCode":0,"ErrorMsg":"Succeed"}

#step5,带 limit 和 offset 的响应数据如下,只返回2条和 limit 配置值一致
{"MultiRecords":[{"RecordVersion":3,"Record":{"game_server_id":3,"is_online":true,"player_email":"test@email.com","player_id":1,"player_name":"test"}},{"RecordVersion":1,"Record":{"game_server_id":3,"is_online":true,"player_email":"test1@email.com","player_id":1,"player_name":"test"}}],"TotalNum":4,"RemainNum":2,"ErrorCode":0,"ErrorMsg":"Succeed"}
目录