本文介紹如何使用Paho Android Service接入阿里云物聯網平臺,并進行數據收發。
前提條件
已在物聯網平臺控制臺,對應實例下,創建產品和設備,并獲取MQTT接入域名和設備證書信息(ProductKey、DeviceName和DeviceSecret)。具體操作,請參見:
背景信息
Paho Android Service是一個基于Java語言的Paho MQTT庫開發的MQTT客戶端服務包。
準備開發環境
本示例使用的Android Studio版本為3.5.1,gradle版本為3.5.1。
請訪問Android Studio官網下載Android Studio。Android開發相關教程,請查看Android Studio官方文檔。
安裝Paho Android Client
- 創建一個新的Android工程。
重要 在應用 build.gradle文件中的 targetSdkVersion需要小于或等于30。若不符合要求,請進行修正。
- 在gradle文件中,添加Paho Android Client依賴。本示例使用1.1.1版本的PahoAndroidClient,需添加以下依賴:
- 在工程build.gradle中,添加Paho倉庫地址。本示例使用release倉庫。
repositories { maven { url "https://repo.eclipse.org/content/repositories/paho-releases/" } }
- 在應用build.gradle中,添加Paho Android Service。本示例中,使用1.1.1 release版本的Paho服務,底層基于paho.client.mqttv3-1.1.0版本。
dependencies { implementation 'org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.1.0' implementation 'org.eclipse.paho:org.eclipse.paho.android.service:1.1.1' }
- 在工程build.gradle中,添加Paho倉庫地址。本示例使用release倉庫。
- 為了使App能夠綁定到Paho Android Service,需要在AndroidManifest.xml中添加以下信息:
- 聲明以下服務:
<!-- Mqtt Service --> <service android:name="org.eclipse.paho.android.service.MqttService"> </service>
- 添加Paho MQTT Service所需的權限。
<uses-permission android:name="android.permission.WAKE_LOCK" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.READ_PHONE_STATE" />
- 聲明以下服務:
接入物聯網平臺
- 下載android_sameple_code.zip,然后解壓獲取阿里云提供的計算MQTT連接參數所需的源碼文件AiotMqttOption.java。
AiotMqttOption.java文件中定義了AiotMqttOption()類,類說明如下:
- 原型:
class AiotMqttOption
- 功能:
用于計算設備接入物聯網平臺的MQTT連接參數username、password和clientid。
- 成員:
類型定義 方法描述 public AiotMqttOption getMqttOption(String productKey, String deviceName, String deviceSecret)
根據設備的productKey、deviceName和deviceSecret計算出MQTT連接參數username、password和clientid。
public String getUsername()
用于獲取MQTT建連參數username。
public String getPassword()
用于獲取MQTT建連參數password。
public String getClientid()
用于獲取MQTT建連參數clientid。
- 原型:
- 將AiotMqttOption.java導入Android項目。
- 在Android項目中,添加實現設備接入物聯網平臺的程序文件。
您需編寫程序調用AiotMqttOption.java中的AiotMqttOption()類計算MQTT連接參數,實現接入物聯網平臺和通信。
開發說明和示例代碼如下:
- 計算MQTT連接參數clientId、username和password,并將username和password設置到MqttConnectOptions對象中。
final private String PRODUCTKEY = "a11xsrW****"; final private String DEVICENAME = "paho_android"; final private String DEVICESECRET = "tLMT9QWD36U2SArglGqcHCDK9rK9****"; /* 獲取MQTT連接信息clientId、username、password。 */ AiotMqttOption aiotMqttOption = new AiotMqttOption().getMqttOption(PRODUCTKEY, DEVICENAME, DEVICESECRET); if (aiotMqttOption == null) { Log.e(TAG, "device info error"); } else { clientId = aiotMqttOption.getClientId(); userName = aiotMqttOption.getUsername(); passWord = aiotMqttOption.getPassword(); } /* 創建MqttConnectOptions對象,并配置username和password。 */ MqttConnectOptions mqttConnectOptions = new MqttConnectOptions(); mqttConnectOptions.setUserName(userName); mqttConnectOptions.setPassword(passWord.toCharArray());
- 接入物聯網平臺。
創建一個MqttAndroidClient對象,設置回調接口,然后使用mqttConnectOptions調用connect方法,即可建立連接。
/* 創建MqttAndroidClient對象,并設置回調接口。 */ mqttAndroidClient = new MqttAndroidClient(getApplicationContext(), host, clientId); mqttAndroidClient.setCallback(new MqttCallback() { @Override public void connectionLost(Throwable cause) { Log.i(TAG, "connection lost"); } @Override public void messageArrived(String topic, MqttMessage message) throws Exception { Log.i(TAG, "topic: " + topic + ", msg: " + new String(message.getPayload())); } @Override public void deliveryComplete(IMqttDeliveryToken token) { Log.i(TAG, "msg delivered"); } }); /* 建立MQTT連接。 */ try { mqttAndroidClient.connect(mqttConnectOptions, null, new IMqttActionListener() { @Override public void onSuccess(IMqttToken asyncActionToken) { Log.i(TAG, "connect succeed"); subscribeTopic(SUB_TOPIC); } @Override public void onFailure(IMqttToken asyncActionToken, Throwable exception) { Log.i(TAG, "connect failed"); } }); } catch (MqttException e) { e.printStackTrace(); }
- 發布消息。封裝publish方法,用于向Topic
/${prodcutKey}/${deviceName}/user/update
發布指定payload的消息。public void publishMessage(String payload) { try { if (mqttAndroidClient.isConnected() == false) { mqttAndroidClient.connect(); } MqttMessage message = new MqttMessage(); message.setPayload(payload.getBytes()); message.setQos(0); mqttAndroidClient.publish(PUB_TOPIC, message,null, new IMqttActionListener() { @Override public void onSuccess(IMqttToken asyncActionToken) { Log.i(TAG, "publish succeed!"); } @Override public void onFailure(IMqttToken asyncActionToken, Throwable exception) { Log.i(TAG, "publish failed!"); } }); } catch (MqttException e) { Log.e(TAG, e.toString()); e.printStackTrace(); } }
通信Topic介紹,請參見什么是Topic。
- 封裝subscribe方法,用于實現訂閱指定Topic,獲取云端下發的消息。
public void subscribeTopic(String topic) { try { mqttAndroidClient.subscribe(topic, 0, null, new IMqttActionListener() { @Override public void onSuccess(IMqttToken asyncActionToken) { Log.i(TAG, "subscribed succeed"); } @Override public void onFailure(IMqttToken asyncActionToken, Throwable exception) { Log.i(TAG, "subscribed failed"); } }); } catch (MqttException e) { e.printStackTrace(); } }
關于設備、服務器和物聯網平臺的通信方式介紹,請參見通信方式概述。
- 計算MQTT連接參數clientId、username和password,并將username和password設置到MqttConnectOptions對象中。
- 編譯項目。
示例Demo
使用Demo代碼程序接入物聯網平臺。
- 下載代碼Demo包,并解壓縮。
- 將aiot-android-demo導入Android Studio。
- 在app/src/main/java/com.linkkit.aiot_android_demo下的MainActivity文件中,替換設備信息為您的設備信息。
- 替換PRODUCTKEY、DEVICENAME和DEVICESECRET的值為您的設備證書信息。
- 修改代碼
final String host = "tcp://" + PRODUCTKEY + ".iot-as-mqtt.cn-shanghai.aliyuncs.com:443";
中的值為對應的接入域名。
- 構建應用,并運行。
運行成功后,可在Logcat中查看本地日志。
2019-12-04 19:44:01.824 5952-5987/com.linkkit.aiot_android_demo W/OpenGLRenderer: Failed to choose config with EGL_SWAP_BEHAVIOR_PRESERVED, retrying without... 2019-12-04 19:44:01.829 5952-5987/com.linkkit.aiot_android_demo D/EGL_emulation: eglCreateContext: 0xec073240: maj 3 min 0 rcv 3 2019-12-04 19:44:01.830 5952-5987/com.linkkit.aiot_android_demo D/EGL_emulation: eglMakeCurrent: 0xec073240: ver 3 0 (tinfo 0xec09b470) 2019-12-04 19:44:01.852 5952-5987/com.linkkit.aiot_android_demo W/Gralloc3: mapper 3.x is not supported 2019-12-04 19:44:01.854 5952-5987/com.linkkit.aiot_android_demo D/HostConnection: createUnique: call ... ... 2019-12-04 19:44:01.860 5952-5987/com.linkkit.aiot_android_demo D/eglCodecCommon: allocate: Ask for block of size 0x1000 2019-12-04 19:44:01.861 5952-5987/com.linkkit.aiot_android_demo D/eglCodecCommon: allocate: ioctl allocate returned offset 0x3ff706000 size 0x2000 2019-12-04 19:44:01.897 5952-5987/com.linkkit.aiot_android_demo D/EGL_emulation: eglMakeCurrent: 0xec073240: ver 3 0 (tinfo 0xec09b470) 2019-12-04 19:44:02.245 5952-6023/com.linkkit.aiot_android_demo D/AlarmPingSender: Register alarmreceiver to MqttServiceMqttService.pingSender.a11xsrW****.paho_android|timestamp=1575459841629,_v=sdk-android-1.0.0,securemode=2,signmethod=hmacsha256| 2019-12-04 19:44:02.256 5952-6023/com.linkkit.aiot_android_demo D/AlarmPingSender: Schedule next alarm at 1575459902256 2019-12-04 19:44:02.256 5952-6023/com.linkkit.aiot_android_demo D/AlarmPingSender: Alarm scheule using setExactAndAllowWhileIdle, next: 60000 2019-12-04 19:44:02.272 5952-5952/com.linkkit.aiot_android_demo I/AiotMqtt: connect succeed 2019-12-04 19:44:02.301 5952-5952/com.linkkit.aiot_android_demo I/AiotMqtt: subscribed succeed
登錄物聯網平臺控制臺,在對應實例下,可查看設備狀態和日志。
錯誤碼
如果設備通過MQTT協議接入物聯網平臺失敗,請根據錯誤碼排查問題。服務端錯誤碼說明,請參見錯誤排查。