全部产品
云市场

Java SDK 使用方法

更新时间:2019-01-24 16:13:55

Java SDK 使用方法

下载地址

AIRec Java SDK 让 Java 开发人员可以非常方便地使用 Java 程序操作智能推荐服务。开发者可以直接使用 Maven依赖添加SDK,也可以下载包到本地。目前,SDK 支持 J2SE 6.0 及以上版本。

点击 此处 可以获得最新版 SDK , 点击 此处 可以查看最新版SDK源码。

使用步骤

为快速开始使用 AIRec Java SDK,请按照如下步骤进行。

步骤1 创建阿里云账号

具体方法请参考 阿里云账号注册流程。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。

步骤2 获取阿里云访问密钥

为了使用 AIRec Java SDK,您必须申请阿里云的 访问秘钥

登录阿里云 秘钥管理页面 。选择一对用于 SDK 的访问密钥对。如果没有,请创建一对新访问密钥,且保证它处于启用状态。有关如何创建访问密钥,参见 准备流程

步骤3 安装 Java 开发环境

AIRec Java SDK 支持 持 J2SE 6.0 及以上的 Java 运行环境,您可以从 Java 官方网站 下载并按说明安装 Java 开发环境

步骤4 安装Java SDK

建议使用 Apache Maven 获取最新版本的 SDK,您可以添加如下配置到您的 Maven 项目。其中 aliyun-java-sdk-core 是核心库, 建议使用 4.2.2 及以上的版本。aliyun-java-sdk-core 依赖了 gson 2.8.2 版本,建议您手动添加 gson 依赖。如果您的业务中已经使用了 gson 低版本,建议升级至 2.8.2 及以上版本。

  1. <dependency>
  2. <groupId>com.aliyun</groupId>
  3. <artifactId>aliyun-java-sdk-airec</artifactId>
  4. <version>1.0.0</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>com.aliyun</groupId>
  8. <artifactId>aliyun-java-sdk-core</artifactId>
  9. <version>4.2.2</version>
  10. </dependency>
  11. <dependency>
  12. <groupId>com.google.code.gson</groupId>
  13. <artifactId>gson</artifactId>
  14. <version>2.8.5</version>
  15. </dependency>

步骤5 开始使用SDK

以获取实例详情的方法 DescribeInstance 为例,介绍 SDK 使用的完整流程,其中 IClientProfile 和 IAcsClient 两个类包含在 aliyun-java-sdk-core 目录中,其他的类均包含在 aliyun-java-sdk-airec 目录中。

  1. package com.aliyun.airec;
  2. import com.aliyuncs.DefaultAcsClient;
  3. import com.aliyuncs.airec.model.v20181012.DescribeInstanceRequest;
  4. import com.aliyuncs.airec.model.v20181012.DescribeInstanceResponse;
  5. import com.aliyuncs.http.FormatType;
  6. import com.aliyuncs.profile.DefaultProfile;
  7. import com.aliyuncs.profile.IClientProfile;
  8. public class DescribeInstance {
  9. public static void main(String args[]) {
  10. // 1.创建 Profile。
  11. // 生成 IClientProfile 的对象 profile,该对象存放 AccessKeyID 和 AccessKeySecret 和默认的地域信息,如示例中的 cn-hangzhou
  12. IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyID, accessKeySecret);
  13. // 2.设置 Endpoint。
  14. // 调用 DefaultProfile 的 addEndpoint 方法,传入 regionId、product 名称、服务接入地址。
  15. DefaultProfile.addEndpoint("cn-hangzhou", "Airec", "airec.cn-hangzhou.aliyuncs.com");
  16. // 3.创建 Client。
  17. // 从 IClientProfile 类中再生成 IAcsClient 的对象 client,后续获得 response 都需要从 IClientProfile 中获得
  18. DefaultAcsClient client = new DefaultAcsClient(profile);
  19. // 4.创建 Request。
  20. // 创建一个对应方法的 Request,类的命名规则一般为 API 的方法名加上 Request,如获取实例详情的 API 方法名为 DescribeInstance,
  21. // 那么对应的请求类名就是 DescribeInstanceRequest,直接使用构造函数生成一个默认的类 request。
  22. DescribeInstanceRequest request = new DescribeInstanceRequest();
  23. // 5.设置 Request的参数。
  24. // 设置 Request 的参数。请求类生成好之后需要通过 Request 类的 setXxx 方法设置必要的信息,即 API 参数中必须要提供的信息,
  25. // 如这里设置实例 ID,则设置对应的实例 ID。API 返回的数据为 JSON 格式,则这里需要设置 AcceptFormat 为 JSON。
  26. request.setInstanceId("airec-cn-xxx");
  27. request.setAcceptFormat(FormatType.JSON);
  28. try {
  29. // 6.使用 Client 对应的方法传入 Request,获得 Response。
  30. DescribeInstanceResponse response = client.getAcsResponse(request);
  31. // 7.在 Response 中获得返回的参数值。
  32. // 接着可以调用 response 中对应的 getXxx 方法获得返回的参数值了,如获得实例的名称,则调用 getName 方法。
  33. System.out.println(response.getResult().getName());
  34. } catch (Exception e) {
  35. e.printStackTrace();
  36. }
  37. }
  38. }