TiKV Java Client 使用教程

TiKV Java Client 使用教程

项目地址:https://gitcode.com/gh_mirrors/cl/client-java

1. 项目的目录结构及介绍

client-java/
├── client-java-api/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   ├── org/
│   │   │   │   │   ├── tikv/
│   │   │   │   │   │   ├── RawKVClient.java
│   │   │   │   │   │   ├── TransactionClient.java
│   │   │   │   │   │   ├── ...
│   │   │   │   │   ├── ...
│   │   │   ├── resources/
│   │   ├── test/
│   │   │   ├── java/
│   │   │   │   ├── org/
│   │   │   │   │   ├── tikv/
│   │   │   │   │   │   ├── RawKVClientTest.java
│   │   │   │   │   │   ├── TransactionClientTest.java
│   │   │   │   │   │   ├── ...
│   │   │   │   │   ├── ...
├── client-java-proto/
│   ├── src/
│   │   ├── main/
│   │   │   ├── proto/
│   │   │   │   ├── kvrpcpb.proto
│   │   │   │   ├── ...
├── client-java-examples/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   ├── org/
│   │   │   │   │   ├── tikv/
│   │   │   │   │   │   ├── RawKVExample.java
│   │   │   │   │   │   ├── TransactionExample.java
│   │   │   │   │   │   ├── ...
├── client-java-parent/
│   ├── pom.xml
├── pom.xml
├── README.md

目录结构介绍

• client-java-api: 包含 TiKV Java Client 的核心 API 代码，包括 RawKVClient 和 TransactionClient 等主要客户端类。
• client-java-proto: 包含与 TiKV 通信所需的 protobuf 文件。
• client-java-examples: 包含使用 TiKV Java Client 的示例代码，如 RawKVExample 和 TransactionExample。
• client-java-parent: 项目的父 POM 文件，管理所有子模块的依赖和构建配置。
• pom.xml: 项目的根 POM 文件，定义了整个项目的依赖和构建配置。
• README.md: 项目的介绍文档，包含项目的概述、安装和使用说明。

2. 项目的启动文件介绍

启动文件

• RawKVClient.java: 用于与 TiKV 进行原始 KV 操作的客户端类。
• TransactionClient.java: 用于与 TiKV 进行事务操作的客户端类。

使用示例

import org.tikv.raw.RawKVClient;
import org.tikv.raw.TiConfiguration;

public class RawKVExample {
    public static void main(String[] args) {
        TiConfiguration conf = TiConfiguration.createRawDefault("127.0.0.1:2379");
        try (RawKVClient client = RawKVClient.create(conf)) {
            client.put("key".getBytes(), "value".getBytes());
            byte[] value = client.get("key".getBytes());
            System.out.println(new String(value));
        }
    }
}

3. 项目的配置文件介绍

配置文件

• TiConfiguration: 用于配置 TiKV 客户端的参数，如 PD 地址、连接超时时间等。

配置示例

TiConfiguration conf = TiConfiguration.createRawDefault("127.0.0.1:2379");
conf.setTimeout(1000); // 设置连接超时时间为 1000 毫秒

配置参数

• PD 地址: 指定 TiKV 集群的 PD 地址，格式为 host:port。
• 连接超时时间: 设置客户端与 TiKV 集群的连接超时时间，单位为毫秒。
• 其他配置: 如 TLS 配置、重试策略等，可根据实际需求进行配置。

通过以上配置，可以灵活地调整 TiKV Java Client 的行为，以适应不同的应用场景。

client-java TiKV Java Client 项目地址: https://gitcode.com/gh_mirrors/cl/client-java