項目需要,要實現Android端消息推送,預研了極光推送、阿里雲MQTT,最終選擇阿里雲MQTT。
具體實現步驟如下:
1、添加依賴項:
在項目根目錄下的build.gradle中添加:
repositories {
maven {
url "https://repo.eclipse.org/content/repositories/paho-releases/"
}
}
在app目錄下的build.gradle中添加:
dependencies {
compile 'org.eclipse.paho:org.eclipse.paho.android.service:1.1.1'
compile 'org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.1.1'
}
2、聲明權限
在AndroidManifest.xml中添加:
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.INTERNET" />
3、開啓服務
在Androidmanifest.xml中添加:
<service android:name="org.eclipse.paho.android.service.MqttService" />
4、在Android Studio中採用創建Service的方式,實現阿里雲MQTT,實例採用的訂閱/發佈者方式,也可採用p2p方式即將topic的二級設爲“p2p”,三級設爲目標接收方的ClientID。Service代碼如下:
public class MQTTService extends Service {
public static final String TAG = MQTTService.class.getSimpleName();
private static MqttAndroidClient client;
private MqttConnectOptions conOpt;
private String host = "tcp://192.168.0.11:61613";
private String userName = "admin";
private String passWord = "password";
private static String myTopic = "ForTest"; //要訂閱的主題
private String clientId = "androidId";//客戶端標識
private IGetMessageCallBack IGetMessageCallBack;
@Override
public void onCreate() {
super.onCreate();
Log.e(getClass().getName(), "onCreate");
init();
}
public static void publish(String msg){
String topic = myTopic;
Integer qos = 0;
Boolean retained = false;
try {
if (client != null){
client.publish(topic, msg.getBytes(), qos.intValue(), retained.booleanValue());
}
} catch (MqttException e) {
e.printStackTrace();
}
}
private void init() {
// 服務器地址(協議+地址+端口號)
String uri = host;
client = new MqttAndroidClient(this, uri, clientId);
// 設置MQTT監聽並且接受消息
client.setCallback(mqttCallback);
conOpt = new MqttConnectOptions();
// 清除緩存
conOpt.setCleanSession(true);
// 設置超時時間,單位:秒
conOpt.setConnectionTimeout(10);
// 心跳包發送間隔,單位:秒
conOpt.setKeepAliveInterval(20);
// 用戶名
conOpt.setUserName(userName);
// 密碼
conOpt.setPassword(passWord.toCharArray()); //將字符串轉換爲字符串數組
// last will message
boolean doConnect = true;
String message = "{\"terminal_uid\":\"" + clientId + "\"}";
Log.e(getClass().getName(), "message是:" + message);
String topic = myTopic;
Integer qos = 0;
Boolean retained = false;
if ((!message.equals("")) || (!topic.equals(""))) {
// 最後的遺囑
// MQTT本身就是爲信號不穩定的網絡設計的,所以難免一些客戶端會無故的和Broker斷開連接。
//當客戶端連接到Broker時,可以指定LWT,Broker會定期檢測客戶端是否有異常。
//當客戶端異常掉線時,Broker就往連接時指定的topic裏推送當時指定的LWT消息。
try {
conOpt.setWill(topic, message.getBytes(), qos.intValue(), retained.booleanValue());
} catch (Exception e) {
Log.i(TAG, "Exception Occured", e);
doConnect = false;
iMqttActionListener.onFailure(null, e);
}
}
if (doConnect) {
doClientConnection();
}
}
@Override
public void onDestroy() {
stopSelf();
try {
client.disconnect();
} catch (MqttException e) {
e.printStackTrace();
}
super.onDestroy();
}
/** 連接MQTT服務器 */
private void doClientConnection() {
if (!client.isConnected() && isConnectIsNormal()) {
try {
client.connect(conOpt, null, iMqttActionListener);
} catch (MqttException e) {
e.printStackTrace();
}
}
}
// MQTT是否連接成功
private IMqttActionListener iMqttActionListener = new IMqttActionListener() {
@Override
public void onSuccess(IMqttToken arg0) {
Log.i(TAG, "連接成功 ");
try {
// 訂閱myTopic話題
client.subscribe(myTopic,1);
} catch (MqttException e) {
e.printStackTrace();
}
}
@Override
public void onFailure(IMqttToken arg0, Throwable arg1) {
arg1.printStackTrace();
// 連接失敗,重連
}
};
// MQTT監聽並且接受消息
private MqttCallback mqttCallback = new MqttCallback() {
@Override
public void messageArrived(String topic, MqttMessage message) throws Exception {
String str1 = new String(message.getPayload());
if (IGetMessageCallBack != null){
IGetMessageCallBack.setMessage(str1);
}
String str2 = topic + ";qos:" + message.getQos() + ";retained:" + message.isRetained();
Log.i(TAG, "messageArrived:" + str1);
Log.i(TAG, str2);
}
@Override
public void deliveryComplete(IMqttDeliveryToken arg0) {
}
@Override
public void connectionLost(Throwable arg0) {
// 失去連接,重連
}
};
/** 判斷網絡是否連接 */
private boolean isConnectIsNormal() {
ConnectivityManager connectivityManager = (ConnectivityManager) this.getApplicationContext()
.getSystemService(Context.CONNECTIVITY_SERVICE);
NetworkInfo info = connectivityManager.getActiveNetworkInfo();
if (info != null && info.isAvailable()) {
String name = info.getTypeName();
Log.i(TAG, "MQTT當前網絡名稱:" + name);
return true;
} else {
Log.i(TAG, "MQTT 沒有可用網絡");
return false;
}
}
@Override
public IBinder onBind(Intent intent) {
Log.e(getClass().getName(), "onBind");
return new CustomBinder();
}
public void setIGetMessageCallBack(IGetMessageCallBack IGetMessageCallBack){
this.IGetMessageCallBack = IGetMessageCallBack;
}
public class CustomBinder extends Binder {
public MQTTService getService(){
return MQTTService.this;
}
}
public void toCreateNotification(String message){
PendingIntent pendingIntent = PendingIntent.getActivity(this, 1, new Intent(this,MQTTService.class), PendingIntent.FLAG_UPDATE_CURRENT);
NotificationCompat.Builder builder = new NotificationCompat.Builder(this);//3、創建一個通知,屬性太多,使用構造器模式
Notification notification = builder
.setTicker("測試標題")
.setSmallIcon(R.mipmap.ic_launcher)
.setContentTitle("")
.setContentText(message)
.setContentInfo("")
.setContentIntent(pendingIntent)//點擊後才觸發的意圖,“掛起的”意圖
.setAutoCancel(true) //設置點擊之後notification消失
.build();
NotificationManager notificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
startForeground(0, notification);
notificationManager.notify(0, notification);
}
}
備註:
①通過BindService去啓動服務,因此沒有onStartCommand()方法
②當獲取從服務器推送過來的消息時,使用回調去更新UI,方便代碼的遷移
③MqttAndroidClient.publish()方法,相當於服務器發佈一個消息。
回調接口如下:
public interface IGetMessageCallBack {
void setMessage(String message);
}
爲了實現通過回調去傳遞從服務器端獲取的消息,需要實現一個ServiceConnection類,並通過onBind來從Service和Activity之間傳遞數據:
public class MyServiceConnection implements ServiceConnection {
private MQTTService mqttService;
private IGetMessageCallBack IGetMessageCallBack;
@Override
public void onServiceConnected(ComponentName componentName, IBinder iBinder) {
mqttService = ((MQTTService.CustomBinder)iBinder).getService();
mqttService.setIGetMessageCallBack(IGetMessageCallBack);
}
@Override
public void onServiceDisconnected(ComponentName componentName) {
}
public MQTTService getMqttService(){
return mqttService;
}
public void setIGetMessageCallBack(IGetMessageCallBack IGetMessageCallBack){
this.IGetMessageCallBack = IGetMessageCallBack;
}
}
測試代碼:
public class MainActivity extends AppCompatActivity implements IGetMessageCallBack {
private TextView textView;
private Button button;
private MyServiceConnection serviceConnection;
private MQTTService mqttService;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
textView = (TextView) findViewById(R.id.text);
button = (Button) findViewById(R.id.button);
serviceConnection = new MyServiceConnection();
serviceConnection.setIGetMessageCallBack(MainActivity.this);
Intent intent = new Intent(this, MQTTService.class);
bindService(intent, serviceConnection, Context.BIND_AUTO_CREATE);
button.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
MQTTService.publish("測試一下子");
}
});
}
@Override
public void setMessage(String message) {
textView.setText(message);
mqttService = serviceConnection.getMqttService();
mqttService.toCreateNotification(message);
}
@Override
protected void onDestroy() {
unbindService(serviceConnection);
super.onDestroy();
}
}