运行 Java SDK 前，您需要先安装 SDK，本文提供 SDK 的运行环境要求及安装方式。

环境准备

• SDK 要求在 JDK 1.8 及以上版本运行。

• 本文所有示例代码在 IntelliJ IDEA 和 Android Studio 上可正常运行，并使用 Maven 3.6.3 版本作为包管理工具。

安装 SDK

目前，云手机 Java SDK 支持通过 Maven 安装和通过 Gradle 安装两种安装方式。为确保您拥有最新和最稳定的功能，请参考 Changelog 选择最新版本 SDK 集成。

通过 Maven 安装

在 pom.xml 文件中进行如下配置。

1. 添加 SNAPSHOT 的 Maven 仓库，SNAPSHOT 策略配置请自行查阅文档。

<repository>
    <id>snapshots-repo</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</repository>

2. 引入最新依赖

<dependency>
    <groupId>com.volcengine</groupId>
    <artifactId>volc-sdk-java</artifactId>
    <version>2.X.X-SNAPSHOT</version>
</dependency>

请注意将示例中的版本号 “2.X.X-SNAPSHOT” 替换为实际所需部署的特定版本。

通过 Gradle 安装

示例项目：volc-sdk-java/android-example/src/main/java/com/volcengine/example/tls/android-demo

1. 在项目根目录的 settings.gradle 文件中配置 Maven 仓库地址。

dependencyResolutionManagement {
    repositories {
        maven {  url 'https://oss.sonatype.org/content/repositories/snapshots/' }
    }
}

2. 在 App 的 build.gradle 文件中添加 SDK 依赖。

implementation 'com.volcengine:volc-sdk-java:2.X.X-SNAPSHOT'

请注意将示例中的版本号 “2.X.X-SNAPSHOT” 替换为实际所需部署的特定版本。

配置安全凭证

可选择以下任意一种方式设置 AK/SK。

方法一：在代码中设置

ACEPService service = ACEPService.getInstance();
service.setAccessKey("ak");
service.setSecretKey("sk");

方法二：在环境变量中设置

VOLC_ACCESSKEY="ak"
VOLC_SECRETKEY="sk"

• 在 Linux 或 macOS 系统中配置
  请在命令行终端执行以下命令，并传入已准备好的 AK 和 SK。注意：请将代码中的 "ak" 及 "sk" 分别替换为您的 AK 及 SK。

export VOLC_ACCESSKEY="ak"
export VOLC_SECRETKEY="sk"

• 在 Windows 系统中配置
  新建系统环境变量，添加环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，并传入已准备好的 AK 和 SK。

方法三：在文件中设置

在本地的 ~/.volc/config 中添加的内容如下所示。

{
    "ak":"Your-AK",
    "sk":"Your-SK"
}

调用示例

以下为完整初始化及接口调用示例，以 DetailPod 为例：

package com.volcengine.ACEP.demo;

import com.volcengine.model.acep.*;
import com.volcengine.service.acep.ACEPService;

public class DetailPodDemo {

  public static void main(String[] args) {
    
    // 若通过方式二或者方式三方式设置ak、sk会自动读取，不用直接指定设置ak、sk
    ACEPService service = ACEPService.getInstance();

    // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
    String ak = System.getenv("VOLC_ACCESSKEY");
    String sk = System.getenv("VOLC_SECRETKEY");

    //如果需直接指定ak、sk，则通过以下代码设置
    service.setAccessKey(ak);
    service.setSecretKey(sk);

    DetailPodQuery query = new DetailPodQuery();

    // 实例所归属的业务 ID，可在**云手机控制台 > 业务管理 > 业务详情**中获取。
    query.setProductId("163571455047xxxx");
    // 实例 ID，可通过调用 [ListPod](https://www.volcengine.com/docs/6394/1221468) 接口获取。
    query.setPodId("163571455047xxxx");

    try {
      DetailPodRes resp = service.detailPod(query);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}