Java SDK使用说明_物联网平台-阿里云帮助中心

物联网平台提供的Java SDK，可帮助开发人员通过Java程序更便捷地操作物联网平台。开发人员可以添加包含Maven依赖的SDK，也可以下载安装包到本地直接安装。

安装SDK

安装Java开发环境。
您可以从Java 官方网站下载，并按说明安装Java开发环境。推荐安装Java 8及以上版本。

安装IoT Java SDK。

访问Apache Maven 官网下载Maven软件。

添加Maven项目依赖。

新版IoT Java SDK的Maven依赖坐标：

<!-- https://mvnrepository.com/artifact/com.aliyun/iot20180120 -->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>iot20180120</artifactId>
    <version>3.0.8</version>
</dependency>

阿里云Java SDK公共包Maven依赖坐标：

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>tea-openapi</artifactId>
  <version>0.2.2</version>
</dependency>

Java SDK源码的更多信息，请参见alibabacloud-java-sdk。

初始化SDK

创建Config对象config，存放SDK初始化信息（AccessKey ID、AccessKey Secret、地域ID等）。
创建Client对象实例client，通过com.aliyun.iot20180120.Client(config)方法，加载config中的SDK信息，完成SDK客户端初始化。
后续调用API的Request和Response参数从com.aliyun.iot20180120.models中获取。

以华东2（上海）地域及其服务接入地址为例，初始代码如下。实际场景设置中，需使用您的物联网平台服务所在地域。

Config config = new Config();
// 您的AccessKey ID。
config.accessKeyId = "<your accessKey>";
// 您的AccessKey Secret。
config.accessKeySecret = "<your accessSecret>";
// 您的可用区ID。
config.regionId = "cn-shanghai";
//初始化SDK客户端。
Client client = new com.aliyun.iot20180120.Client(config);

参数	说明
accessKeyId	您阿里云账号的AccessKey ID。您可在阿里云官网控制台AccessKey管理中创建或查看您的AccessKey。
accessKeySecret	您阿里云账号的AccessKey Secret。
regionId	您的物联网平台服务的地域ID，用于拼接服务接入地址，格式为：iot.${RegionId}.aliyuncs.com。您可在物联网平台控制台左上方，查看当前服务所在地域。地域ID的表达方法，请参见支持的地域。

SDK客户端的HTTP请求配置、代理配置、超时机制、重试机制等配置方式，请参见阿里云升级版Java SDK使用指南。

发起调用

物联网平台云端SDK为每个API封装两个类，分别命名为${API名称}+"Request"和${API名称}+"Response"，分别用于承载API的调用请求和调用结果。

调用步骤

已完成SDK客户端初始化。具体内容，请参见初始化SDK。
创建对应API的调用请求，生成${API名称}+"Request"类对象实例request。
通过对象实例request，使用set+${请求参数的名称}方法，设置API所需的请求参数值。
创建${API名称}+"Response"类的对象实例response承载响应结果：使用Client对象实例client的${API名称}(request)方法，获取API对应request的响应结果，包含服务端响应的body和headers。
通过对象实例response的body成员对象，使用get+${返回参数的名称}方法，可获取对应返回参数的值。
例如：response.getBody().getSuccess()用于获取是否调用成功的标识，其中Success为API的通用返回参数。通用返回参数还包含RequestId、ErrorMessage和Code。
使用catch()方法处理异常报错。

物联网平台云端API，请参见API列表。有关request中请求参数说明，及response中返回参数说明，请参见对应API文档。

本文以调用Pub接口发布消息到Topic为例。请求参数信息，请参见Pub。

重要

以下代码中${iotInstanceId}为实例ID值。您可在物联网平台控制台的实例概览页面，查看当前实例的ID值。

若有ID值，必须传入该ID值，否则调用API会失败。
若无实例概览页面或ID值，则无需传入ID值。您需删除IotInstanceId相关的请求代码，或传入空值""，否则调用API会失败。

实例的详细说明，请参见实例概述。购买实例方法，请参见购买企业版实例。常见问题，请参见物联网平台实例相关问题。

PubRequest request = new PubRequest()
    .setIotInstanceId("${iotInstanceId}")
    .setProductKey("${productKey}")
    .setMessageContent(Base64.getEncoder().encodeToString("hello world".getBytes()))
    .setTopicFullName("/${productKey}/${deviceName}/user/get")
    .setQos(0);//目前支持QoS0和QoS1。 
try {
    PubResponse response = client.pub(request);
    // response中包含服务端响应的body和headers。 
    //获取本次调用requestId。
    System.out.println(response.getBody().getRequestId());
    //调用是否成功。
    System.out.println(response.getBody().getSuccess());
    
    //调用成功。
    if (response.getBody().getSuccess()) {
        //获取云端消息ID。
        System.out.println(response.getBody().getMessageId());
        
        //do业务逻辑。
        
    } else {
    //调用失败。            
        //获取调用失败错误码。
        System.out.println(response.getBody().getCode());
        //获取调用失败错误描述。
        System.out.println(response.getBody().getErrorMessage());
     }
} catch (TeaException error) {
    //服务端业务异常。
    System.out.println(error.getCode());
    System.out.println(error.getMessage());
} catch (Exception e) {
    //其他运行时异常。
    e.printStackTrace();
}

完整示例代码

说明

实际场景中，请参照上文的参数说明，替换对应参数值。

import com.aliyun.iot20180120.Client;
import com.aliyun.iot20180120.models.PubRequest;
import com.aliyun.iot20180120.models.PubResponse;
import com.aliyun.tea.TeaException;
import com.aliyun.teaopenapi.models.Config;
import java.util.Base64;

public class IotSdkDemo {
    /**
     * 使用AK&SK初始化Client。
     */
    private static Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
        Config config = new Config();
        config.accessKeyId = accessKeyId;
        config.accessKeySecret = accessKeySecret;
        // 您的可用区ID。
        config.regionId = "cn-shanghai";
        return new Client(config);
    }

    public static void main(String[] args) {
        try {
            Client client = createClient(accessKey, accessKeySecret);
            PubRequest request = new PubRequest()
                .setIotInstanceId("${iotInstanceId}")
                .setProductKey("${productKey}")
                .setMessageContent(Base64.getEncoder().encodeToString("hello world".getBytes()))
                .setTopicFullName("/${productKey}/${deviceName}/user/get")
                .setQos(0);//目前支持QoS0和QoS1。 
            
            PubResponse response = client.pub(request);            
            //获取本次调用requestId。
      System.out.println(response.getBody().getRequestId());
      //调用是否成功。
      System.out.println(response.getBody().getSuccess());
            
         //调用成功。
       if (response.getBody().getSuccess()) {
          //获取云端消息ID。
          System.out.println(response.getBody().getMessageId());
        
          //do业务逻辑。
      } else {
       //调用失败。            
          //获取调用失败错误码。
             System.out.println(response.getBody().getCode());
          //获取调用失败错误描述。
          System.out.println(response.getBody().getErrorMessage());
      }
        } catch (TeaException error) {
            //服务端业务异常。
      System.out.println(error.getCode());
      System.out.println(error.getMessage());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

附录：示例代码

前往物联网平台云端SDK示例中心查看或下载API调用的示例代码。示例代码中包含Java、Python、PHP、Node.js、Go、C++和.NET等版本SDK示例。

阿里云OpenAPI开发者门户提供API在线调试工具。在API调试页面，您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下，可查看API调用的真实请求URL和JSON格式的返回结果。