Java SDK使用說明
物聯網平臺提供的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.24.0</version> </dependency>
阿里云Java SDK公共包Maven依賴坐標:
<dependency> <groupId>com.aliyun</groupId> <artifactId>aliyun-java-sdk-core</artifactId> <version>4.5.6</version> </dependency>
SDK 客戶端初始化
示例采用讀取環境變量的方式創建憑證,運行代碼前需配置以下兩個環境變量。了解更多請參見Credentials 設置。
export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.auth.EnvironmentVariableCredentialsProvider;
import com.aliyuncs.profile.DefaultProfile;
public class Sample {
public static void main(String[] args) {
// 地域Id,用于自動尋址,更多請參見 Endpoint 配置章節
String regionId = "cn-shanghai";
// 通過讀取環境變量
EnvironmentVariableCredentialsProvider credentialsProvider = new EnvironmentVariableCredentialsProvider();
DefaultProfile profile = DefaultProfile.getProfile(regionId);
// 通過 SDK Core 保存用戶的 profile 信息并初始化 client
DefaultAcsClient client = new DefaultAcsClient(profile, credentialsProvider);
}
}
單 Client 的模式存在線程不安全的問題,而且通過一個 profile 信息在不同產品之間混用造成的權限管理問題
發起調用
物聯網平臺云端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();
}
附錄
阿里云OpenAPI開發者門戶提供API在線調試工具。在API調試頁面,您可以快速檢索和體驗調用API。系統會根據您輸入的參數同步生成各語言SDK的代碼示例。各語言SDK代碼示例顯示在頁面右側SDK示例頁簽下供您參考。在調用結果頁簽下,可查看API調用的真實請求URL和JSON格式的返回結果。