全部產品
Search
文件中心

IoT Platform:Java SDK使用說明

更新時間:Sep 12, 2024

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

安裝SDK

  1. 安裝Java開發環境。

    您可以從Java 官方網站下載,並按說明安裝Java開發環境。推薦安裝Java 8及以上版本。

  2. 安裝IoT Java SDK。

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

    2. 添加Maven專案依賴。

      重要

      以下version為樣本值,最新版本資訊,請參見OpenAPI門戶物聯網平台的SDK安裝方式

      • IoT Java SDK的Maven依賴座標:

        <!-- https://mvnrepository.com/artifact/com.aliyun/iot20180120 -->
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>iot20180120</artifactId>
            <version>4.2.0</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

  1. 建立Config對象config,存放SDK初始化資訊(AccessKey IDAccessKey Secret、地區ID等)。

  2. 建立Client對象執行個體client,通過com.aliyun.iot20180120.Client(config)方法,載入config中的SDK資訊,完成SDK用戶端初始化。

    後續調用API的RequestResponse參數從com.aliyun.iot20180120.models中擷取。

以華東2(上海)地區及其服務接入地址為例,初始代碼如下。實際情境設定中,需使用您的物聯網平台服務所在地區。

Config config = new Config()
    // 您的AccessKey ID
    .setAccessKeyId(accessKeyId)
    // 您的AccessKey Secret
    .setAccessKeySecret(accessKeySecret);
// 訪問的網域名稱
config.endpoint = "iot.cn-beijing.aliyuncs.com";

Client client = new Client(config);

參數

說明

accessKeyId

您阿里雲帳號的AccessKey ID

您可在阿里雲官網控制台AccessKey管理中建立或查看您的AccessKey。

accessKeySecret

您阿里雲帳號的AccessKey Secret

regionId

您的物聯網平台服務的地區ID,用於拼接服務接入地址,格式為:iot.${RegionId}.aliyuncs.com。

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

地區ID的表達方法,請參見地區和可用性區域

重要

為避免將AccessKey寫入程式碼到業務代碼中帶來的安全風險,可採用配置環境變數的方法管理AccessKey。

您需在本地作業系統中添加環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET,並分別寫入已準備好的AccessKey ID和AccessKey Secret。

在範例程式碼中可通過以下方法擷取:

  • System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")

  • System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")

發起調用

物聯網平台雲端SDK為每個API封裝兩個類,分別命名為${API名稱}+"Request"${API名稱}+"Response",分別用於承載API的調用請求和調用結果。

調用步驟

  1. 已完成SDK用戶端初始化。具體內容,請參見初始化SDK

  2. 建立對應API的調用請求,產生${API名稱}+"Request"類對象執行個體request

  3. 通過對象執行個體request,使用set+${請求參數的名稱}方法,設定API所需的請求參數值。

  4. 建立${API名稱}+"Response"類的對象執行個體response承載響應結果:使用Client對象執行個體client${API名稱}(request)方法,擷取API對應request的響應結果,包含服務端響應的bodyheaders

  5. 通過對象執行個體responsebody成員對象,使用get+${返回參數的名稱}方法,可擷取對應返回參數的值。

    例如:response.getbody.getSuccess()用於擷取是否調用成功的標識,其中Success為API的通用返回參數。通用返回參數還包含RequestIdErrorMessageCode

  6. 使用catch()方法處理異常報錯。

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

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

重要

以下代碼中iotInstanceId為執行個體ID。執行個體的詳細說明,請參見執行個體概述

購買執行個體方法,請參見購買企業版執行個體

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 {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填,您的 AccessKey ID
                .setAccessKeyId(accessKeyId)
                // 必填,您的 AccessKey Secret
                .setAccessKeySecret(accessKeySecret);
        // Endpoint 請參考 https://api.aliyun.com/product/Iot
        config.endpoint = "iot.cn-beijing.aliyuncs.com";
        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格式的返回結果。