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格式的返回结果。