You need to enable JavaScript to run this app.
导航

安装 Java SDK

最近更新时间2023.08.18 19:13:49

首次发布时间2023.08.18 19:13:49

使用火山引擎 Java SDK 进行各类操作前,您需要安装 Java SDK。本文介绍 Java SDK 的安装方法。

前提条件

  • 已创建并获取火山引擎访问密钥 AccessKey。获取方式请参考密钥管理
  • 访问密钥 AccessKey 拥有所有 API 的全部权限。建议您通过 IAM 用户进行 API 相关操作和日常运维。使用 IAM 用户前,主账号需要为 IAM 用户授予消息队列 Kafka版相关资源和操作的权限。

准备开发环境

Java SDK 支持 JDK 1.7 及后续版本,安装火山引擎 Java SDK 之前,请确认已准备对应的 Java 开发环境,详细说明请参考 Java 官方网站
您可以执行以下命令检查当前 Java 的版本信息。

java -version

安装 SDK

建议通过在 Maven 项目中加入依赖项的方式引入 Java SDK。
在 Maven 工程中使用 Volcengine Java SDK,只需在 pom.xml 中加入相应依赖即可,Maven项目管理工具会自动下载相关 JAR 包。其中,version 部分应指定为最新的版本号。

<dependency>
    <groupId>com.volcengine</groupId>
    <artifactId>volcengine-java-sdk-kafka</artifactId>
    <version>0.1.71</version>
</dependency>

说明

如果您的 Java JDK 版本为 JDK 9 或以上版本,还需要额外添加 javax.annotation-api 依赖,请在 pom.xml 中添加如下内容。

<dependency>
    <groupId>javax.annotation</groupId>
    <artifactId>javax.annotation-api</artifactId>
    <version>1.3.2</version>
</dependency>

初始化客户端
初始化客户端的示例代码如下:

package com.volcengine.kafka.examples;

import com.volcengine.ApiClient;
import com.volcengine.kafka.KafkaApi;
import com.volcengine.sign.Credentials;


public class TestKafka {
    public static void main(String[] args) throws Exception {
        String ak = "Your AK";
        String sk = "Your SK";
        String region = "cn-beijing";

        ApiClient apiClient = new ApiClient()
                .setCredentials(Credentials.getCredentials(ak, sk))
                .setRegion(region);

        KafkaApi api = new KafkaApi(apiClient);
    }
}