本文提供设备通过CoAP协议接入物联网平台的示例代码。
背景信息
CoAP协议适用于资源受限的低功耗设备,尤其是NB-IoT的设备。配置设备通过CoAP协议与物联网平台连接并通信的说明,请参见CoAP连接通信。
说明 目前仅华东2(上海)、华北2(北京)、华南1(深圳)地域支持设备通过CoAP通道接入物联网平台。
配置设备通过CoAP协议接入物联网平台时,需要填写相应的参数,计算设备端签名,步骤较为复杂。为了便于您理解相关配置,本文提供基于Californium框架的接入示例代码。本示例中,为保证数据安全,使用对称加密。
开发环境
本文使用Java开发环境:
- 操作系统:Windows10
- JDK版本:JDK8
- 集成开发环境:IntelliJ IDEA社区版
pom.xml配置
在pom.xml文件中,添加以下依赖,引入Californium开源框架、Apache commons工具包和阿里云fastjson包。
<dependency>
<groupId>org.eclipse.californium</groupId>
<artifactId>californium-core</artifactId>
<version>2.0.0-M17</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.5</version>
</dependency>
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
<version>1.13</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.61</version>
</dependency>
示例代码
注意 本文为旧版公共实例下设备的接入示例代码。若接入企业版实例或新版公共实例下设备,还需修改代码中的CoAP接入地址serverURI,值为
"${CoAP接入地址}:5682"
。
例如:private static String serverURI = "iot-***.coap.iothub.aliyuncs.com:5682";
。
获取${CoAP接入地址}
的方法,请参见查看实例终端节点。
/*
* Copyright © 2019 Alibaba. All rights reserved.
*/
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
import javax.crypto.Cipher;
import javax.crypto.Mac;
import javax.crypto.spec.IvParameterSpec;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.lang3.RandomUtils;
import org.eclipse.californium.core.CoapClient;
import org.eclipse.californium.core.CoapResponse;
import org.eclipse.californium.core.Utils;
import org.eclipse.californium.core.coap.CoAP;
import org.eclipse.californium.core.coap.CoAP.Code;
import org.eclipse.californium.core.coap.CoAP.Type;
import org.eclipse.californium.core.coap.MediaTypeRegistry;
import org.eclipse.californium.core.coap.Option;
import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.OptionSet;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.elements.exception.ConnectorException;
import com.alibaba.fastjson.JSONObject;
/**
* CoAP客户端连接阿里云物联网平台,基于eclipse californium开发。
* 自主接入开发流程及参数填写,请参见《CoAP连接通信》的使用对称加密自主接入章节。
*/
public class IotCoapClientWithAes {
// ===================需要用户填写的参数,开始。===========================
// 地域ID,以华东2(上海)为例。
private static String regionId = "cn-shanghai";
// 产品productKey。
private static String productKey = "您的设备productKey";
// 设备名成deviceName。
private static String deviceName = "您的设备deviceName";
// 设备密钥deviceSecret。
private static String deviceSecret = "您的设备deviceSecret";
// ===================需要用户填写的参数,结束。===========================
// 定义加密方式,MAC算法可选以下算法:HmacMD5、HmacSHA1,需与signmethod一致。
private static final String HMAC_ALGORITHM = "hmacsha1";
// CoAP接入地址,对称加密端口号是5682。
private static String serverURI = "coap://" + productKey + ".coap." + regionId + ".link.aliyuncs.com:5682";
// 发送消息用的Topic。需要在控制台自定义Topic,设备操作权限需选择为“发布”。
private static String updateTopic = "/" + productKey + "/" + deviceName + "/user/update";
// token option
private static final int COAP2_OPTION_TOKEN = 2088;
// seq option
private static final int COAP2_OPTION_SEQ = 2089;
// 加密算法sha256。
private static final String SHA_256 = "SHA-256";
private static final int DIGITAL_16 = 16;
private static final int DIGITAL_48 = 48;
// CoAP客户端。
private CoapClient coapClient = new CoapClient();
// token有效期7天,失效后需要重新获取。
private String token = null;
private String random = null;
@SuppressWarnings("unused")
private long seqOffset = 0;
/**
* 初始化CoAP客户端。
*
* @param productKey,产品key。
* @param deviceName,设备名称。
* @param deviceSecret ,设备密钥。
*/
public void connect(String productKey, String deviceName, String deviceSecret) {
try {
// 认证uri,/auth。
String uri = serverURI + "/auth";
// 只支持POST方法。
Request request = new Request(Code.POST, Type.CON);
// 设置option。
OptionSet optionSet = new OptionSet();
optionSet.addOption(new Option(OptionNumberRegistry.CONTENT_FORMAT, MediaTypeRegistry.APPLICATION_JSON));
optionSet.addOption(new Option(OptionNumberRegistry.ACCEPT, MediaTypeRegistry.APPLICATION_JSON));
request.setOptions(optionSet);
// 设置认证uri。
request.setURI(uri);
// 设置认证请求payload。
request.setPayload(authBody(productKey, deviceName, deviceSecret));
// 发送认证请求。
CoapResponse response = coapClient.advanced(request);
System.out.println(Utils.prettyPrint(response));
System.out.println();
// 解析请求响应。
JSONObject json = JSONObject.parseObject(response.getResponseText());
token = json.getString("token");
random = json.getString("random");
seqOffset = json.getLongValue("seqOffset");
} catch (ConnectorException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 发送消息。
*
* @param topic,发送消息的Topic。
* @param payload,消息内容。
*/
public void publish(String topic, byte[] payload) {
try {
// 消息发布uri,/topic/