Java SDK使用說明 - IoT Platform

物聯網平台提供的Java SDK，可以協助開發人員通過Java程式更便捷地操作物聯網平台。開發人員可以添加包含Maven依賴的SDK，也可以下載安裝包到本地直接安裝。

安裝SDK

安裝Java開發環境。
您可以從Java 官方網站下載，並按說明安裝Java開發環境。

安裝IoT Java SDK。

訪問Apache Maven 官網下載Maven軟體。

添加Maven專案依賴。

新版IoT Java SDK的Maven依賴座標：

<!-- https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-iot -->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-iot</artifactId>
    <version>7.41.0</version>
</dependency>

阿里雲Java SDK公用包Maven依賴座標：

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>4.5.6</version>
</dependency>

初始化SDK

首先建立IClientProfile對象profile，存放SDK初始化資訊，然後建立DefaultAcsClient對象執行個體client，通過DefaultAcsClient(profile)方法，載入profile中的SDK資訊，完成SDK用戶端初始化。

String accessKey = System.getenv("ACCESS_KEY_ID");
String accessSecret = System.getenv("ACCESS_KEY_SECRET");
IClientProfile profile = DefaultProfile.getProfile("${RegionId}", accessKey, accessSecret);
DefaultAcsClient client = new DefaultAcsClient(profile); //初始化SDK用戶端。

參數

說明

profile

profile對象用於存放SDK初始化資訊，其中${RegionId}是您的物聯網平台服務的地區代碼。

您可在物聯網平台控制台左上方，查看當前服務所在地區。

地區代碼的表達方法，請參見地區和可用性區域。

以調用華東2（上海）地區的API為例，初始化代碼如下。

String accessKey = System.getenv("ACCESS_KEY_ID");
String accessSecret = System.getenv("ACCESS_KEY_SECRET");
IClientProfile profile = DefaultProfile.getProfile("cn-shanghai", accessKey, accessSecret);
DefaultAcsClient client = new DefaultAcsClient(profile); //初始化SDK用戶端。

發起調用

物聯網平台雲端SDK為每個API封裝兩個類，分別命名為${API名稱}+"Request"和${API名稱}+"Response"。

${API名稱}+"Request"：用於API的調用請求。通過該類的對象執行個體request，使用set+${請求參數的名稱}方法，佈建要求參數值。
${API名稱}+"Response"：使用DefaultAcsClient對象執行個體client的getAcsResponse(request)方法，承載API的調用結果。通過該類的對象執行個體response，使用get+${返回參數的名稱}的方法，可擷取對應返回參數的值。
例如：response.getSuccess()用於擷取是否調用成功的標識，其中Success為API的通用返回參數。通用返回參數還包含RequestId、ErrorMessage和Code。

物聯網平台雲端API，請參見API列表。有關request中請求參數說明，及response中返回參數說明，請參見對應API文檔。

本文以調用Pub介面發布訊息到Topic為例。請求參數資訊，請參見Pub。

重要

以下代碼中${iotInstanceId}為執行個體ID值。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID值。

若有ID值，必須傳入該ID值，否則調用API會失敗。
若無執行個體概覽頁面或ID值，則無需傳入。您需刪除IotInstanceId相關的請求代碼，或傳入空值""，否則調用API會失敗。

執行個體的詳細內容，請參見執行個體概述。購買執行個體方法，請參見購買企業版執行個體。常見問題，請參見物聯網平台執行個體相關問題。

PubRequest request = new PubRequest(); 
request.setIotInstanceId("${iotInstanceId}"); 
request.setProductKey("${productKey}"); 
request.setMessageContent(Base64.encodeBase64String("hello world".getBytes())); 
request.setTopicFullName("/${productKey}/${deviceName}/user/get"); 
request.setQos(0); //目前支援QoS0和QoS1。 
try 
{ 
   PubResponse response = client.getAcsResponse(request); 
   System.out.println(response.getSuccess()); 
   System.out.println(response.getCode());
   System.out.println(response.getErrorMessage());
} 
catch (ServerException e) 
{
   e.printStackTrace();
}
catch (ClientException e)
{
   System.out.println("ErrCode:" + e.getErrCode());
   System.out.println("ErrMsg:" + e.getErrMsg());
   e.printStackTrace();
}

附錄：範例程式碼

前往物聯網平台雲端SDK樣本中心查看或下載API調用的範例程式碼。範例程式碼中包含Java、Python、PHP、.NET和Go版本SDK樣本。

阿里雲OpenAPI開發人員門戶提供API線上調試工具。在API調試頁面，您可以快速檢索和體驗調用API。系統會根據您輸入的參數同步產生各語言SDK的程式碼範例。各語言SDK程式碼範例顯示在頁面右側SDK樣本頁簽下供您參考。在調用結果頁簽下，可查看API調用的真實請求URL和JSON格式的返回結果。