Android XMPP通訊自定義Packet&Provider
摘要
在xmpp通信過程中，asmack中提供的Packet組件是IQ,Message,Presence三種： IQ用于查詢 Message用于消息傳遞 Presence用于狀態(tài)交互 他們都是Packet的子類，實(shí)質(zhì)是用于將消息封裝成響應(yīng)的xml格式來進(jìn)行數(shù)據(jù)交換，都有著良好的可擴(kuò)展性。
簡介
我們以開源項(xiàng)目androidpn為例：
androidpn (Android Push Notification)是一個基于XMPP協(xié)議的java開源Android push notification實(shí)現(xiàn)。它包含了完整的客戶端和服務(wù)器端。
androidpn包括Server端和Client端，項(xiàng)目名稱是androidpn-server和androidpn-client。
事實(shí)上，androidpn-server可以支持app運(yùn)行于iOS，UWP，Windows，Linux等平臺，不僅限于android，因此，希望項(xiàng)目的名稱改為XPN(Xmpp Push Notification)似乎更加符合其實(shí)際場景，我們以后涉及到Android Push Notification統(tǒng)稱為XPN。
XNP目前狀態(tài)
項(xiàng)目自2014年1月就已經(jīng)停止更新了，此外，asmack項(xiàng)目也停止更新了，作者建議使用openfire官方的smack4.0，不過這樣的話引入的jar會特別多，特別大。當(dāng)然，我們下載到了asmack8.10.0比較新的穩(wěn)定版本，可以完全用于學(xué)習(xí)和擴(kuò)展。
項(xiàng)目相關(guān)下載站點(diǎn)
asmack-github.com - asmack項(xiàng)目地址
asmack-asmack.freakempire.de - asmack鏡像地址
androidpn(XPN)-github.com - androidpn下載地址
一.關(guān)于Packet數(shù)據(jù)包
Packet是IQ,Message,Presence的父類，用于實(shí)現(xiàn)消息組件類型。
消息語義學(xué)message
message是一種基本推送消息方法，它不要求響應(yīng)。主要用于IM、groupChat、alert和notification之類的應(yīng)用中。
主要 屬性如下：
type屬性，它主要有5種類型：
normal：類似于email，主要特點(diǎn)是不要求響應(yīng)；
chat：類似于qq里的好友即時聊天，主要特點(diǎn)是實(shí)時通訊；
groupchat：類似于聊天室里的群聊；
headline：用于發(fā)送alert和notification；
error：如果發(fā)送message出錯，發(fā)現(xiàn)錯誤的實(shí)體會用這個類別來通知發(fā)送者出錯了；
to屬性：標(biāo)識消息的接收方。
from屬性：指發(fā)送方的名字或標(biāo)示。為防止地址外泄，這個地址通常由發(fā)送者的server填寫，而不是發(fā)送者。
載荷（payload）：例如body，subject
<message to="lily@jabber.org/contact" type="chat" > <body> 你好，在忙嗎</body> </message>
出席信息語義學(xué)presence
presence用來表明用戶的狀態(tài)，如：online、away、dnd(請勿打擾)等。當(dāng)改變自己的狀態(tài)時，就會在stream的上下文中插入一個Presence元素，來表明自身的狀態(tài)。要想接受presence消息，必須經(jīng)過一個叫做presence subscription的授權(quán)過程。
屬性：
type屬性，非必須。有以下類別
subscribe：訂閱其他用戶的狀態(tài)
probe：請求獲取其他用戶的狀態(tài)
unavailable：不可用，離線（offline）狀態(tài)
to屬性：標(biāo)識消息的接收方。
from屬性：指發(fā)送方的名字或標(biāo)示。
載荷（payload）：
show：
chat：聊天中
away：暫時離開
xa：eXtend Away，長時間離開
dnd：勿打擾
status：格式自由，可閱讀的文本。也叫做rich presence或者extended presence，常用來表示用戶當(dāng)前心情，活動，聽的歌曲，看的視頻，所在的聊天室，訪問的網(wǎng)頁，玩的游戲等等。
priority：范圍-128~127。高優(yōu)先級的resource能接受發(fā)送到bare JID的消息，低優(yōu)先級的resource不能。優(yōu)先級為
<presence from="alice@wonderland.lit/pda">
<show>xa</show>
<status>down the rabbit hole!</status>
</presence>
IQ語義學(xué)
一種請求／響應(yīng)機(jī)制，從一個實(shí)體從發(fā)送請求，另外一個實(shí)體接受請求，并進(jìn)行響應(yīng)。例如，client在stream的上下文中插入一個元素，向Server請求得到自己的好友列表，Server返回一個，里面是請求的結(jié)果。
主要的屬性是type。包括:
Get :獲取當(dāng)前域值。類似于http get方法。
Set :設(shè)置或替換get查詢的值。類似于http put方法。
Result :說明成功的響應(yīng)了先前的查詢。類似于http狀態(tài)碼200。
Error: 查詢和響應(yīng)中出現(xiàn)的錯誤。
<iq from="alice@wonderland.lit/pda"
id="rr82a1z7"
to="alice@wonderland.lit"
type="get">
<query xmlns="jabber:iq:roster"/>
</iq>
二.自定義Packet
由于服務(wù)器和客戶端使用的Packet不同，但是他們交互的數(shù)據(jù)格式都是xml，因此，這個過程我們理解xml實(shí)現(xiàn)過程即可。
1.定義Packet封裝對象
由于asmack標(biāo)簽解析的限制，我們不能自定義解析，除非修改源碼，這里出于簡單，這里只能繼承現(xiàn)有標(biāo)簽之一。
我么按照項(xiàng)目代碼NotificationIQ為例，這里沒有繼承Packet，而是繼承了IQ
import org.jivesoftware.smack.packet.IQ;
/**
* This class represents a notifcatin IQ packet.
*
* @author Sehwan Noh (devnoh@gmail.com)
*/
public class NotificationIQ extends IQ {
private String id;
private String apiKey;
private String title;
private String message;
private String uri;
public NotificationIQ() {
}
@Override
public String getChildElementXML() {
StringBuilder buf = new StringBuilder();
buf.append("<").append("notification").append(" xmlns=\"").append(
"androidpn:iq:notification").append("\">");
if (id != null) {
buf.append("<id>").append(id).append("</id>");
}
buf.append("</").append("notification").append("> ");
return buf.toString();
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getApiKey() {
return apiKey;
}
public void setApiKey(String apiKey) {
this.apiKey = apiKey;
}
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public String getUri() {
return uri;
}
public void setUri(String url) {
this.uri = url;
}
}
其中，getChildElementXml()是IQ的子類，用來拼接成<iq>下的直接點(diǎn)。
public abstract class IQ extends Packet {
private Type type = Type.GET;
public IQ() {
super();
}
public IQ(IQ iq) {
super(iq);
type = iq.getType();
}
/**
* Returns the type of the IQ packet.
*
* @return the type of the IQ packet.
*/
public Type getType() {
return type;
}
/**
* Sets the type of the IQ packet.
*
* @param type the type of the IQ packet.
*/
public void setType(Type type) {
if (type == null) {
this.type = Type.GET;
}
else {
this.type = type;
}
}
public String toXML() {
StringBuilder buf = new StringBuilder();
buf.append("<iq ");
if (getPacketID() != null) {
buf.append("id=\"" + getPacketID() + "\" ");
}
if (getTo() != null) {
buf.append("to=\"").append(StringUtils.escapeForXML(getTo())).append("\" ");
}
if (getFrom() != null) {
buf.append("from=\"").append(StringUtils.escapeForXML(getFrom())).append("\" ");
}
if (type == null) {
buf.append("type=\"get\">");
}
else {
buf.append("type=\"").append(getType()).append("\">");
}
// Add the query section if there is one.
String queryXML = getChildElementXML();
if (queryXML != null) {
buf.append(queryXML);
}
// Add the error sub-packet, if there is one.
XMPPError error = getError();
if (error != null) {
buf.append(error.toXML());
}
buf.append("</iq>");
return buf.toString();
}
/**
* Returns the sub-element XML section of the IQ packet, or <tt>null</tt> if there
* isn't one. Packet extensions <b>must</b> be included, if any are defined.<p>
*
* Extensions of this class must override this method.
*
* @return the child element section of the IQ XML.
*/
public abstract String getChildElementXML();
/**
* Convenience method to create a new empty {@link Type#RESULT IQ.Type.RESULT}
* IQ based on a {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}
* IQ. The new packet will be initialized with:<ul>
* <li>The sender set to the recipient of the originating IQ.
* <li>The recipient set to the sender of the originating IQ.
* <li>The type set to {@link Type#RESULT IQ.Type.RESULT}.
* <li>The id set to the id of the originating IQ.
* <li>No child element of the IQ element.
* </ul>
*
* @param iq the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
* @throws IllegalArgumentException if the IQ packet does not have a type of
* {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}.
* @return a new {@link Type#RESULT IQ.Type.RESULT} IQ based on the originating IQ.
*/
public static IQ createResultIQ(final IQ request) {
if (!(request.getType() == Type.GET || request.getType() == Type.SET)) {
throw new IllegalArgumentException(
"IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML());
}
final IQ result = new IQ() {
public String getChildElementXML() {
return null;
}
};
result.setType(Type.RESULT);
result.setPacketID(request.getPacketID());
result.setFrom(request.getTo());
result.setTo(request.getFrom());
return result;
}
/**
* Convenience method to create a new {@link Type#ERROR IQ.Type.ERROR} IQ
* based on a {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}
* IQ. The new packet will be initialized with:<ul>
* <li>The sender set to the recipient of the originating IQ.
* <li>The recipient set to the sender of the originating IQ.
* <li>The type set to {@link Type#ERROR IQ.Type.ERROR}.
* <li>The id set to the id of the originating IQ.
* <li>The child element contained in the associated originating IQ.
* <li>The provided {@link XMPPError XMPPError}.
* </ul>
*
* @param iq the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
* @param error the error to associate with the created IQ packet.
* @throws IllegalArgumentException if the IQ packet does not have a type of
* {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}.
* @return a new {@link Type#ERROR IQ.Type.ERROR} IQ based on the originating IQ.
*/
public static IQ createErrorResponse(final IQ request, final XMPPError error) {
if (!(request.getType() == Type.GET || request.getType() == Type.SET)) {
throw new IllegalArgumentException(
"IQ must be of type 'set' or 'get'. Original IQ: " + request.toXML());
}
final IQ result = new IQ() {
public String getChildElementXML() {
return request.getChildElementXML();
}
};
result.setType(Type.ERROR);
result.setPacketID(request.getPacketID());
result.setFrom(request.getTo());
result.setTo(request.getFrom());
result.setError(error);
return result;
}
/**
* A class to represent the type of the IQ packet. The types are:
*
* <ul>
* <li>IQ.Type.GET
* <li>IQ.Type.SET
* <li>IQ.Type.RESULT
* <li>IQ.Type.ERROR
* </ul>
*/
public static class Type {
public static final Type GET = new Type("get");
public static final Type SET = new Type("set");
public static final Type RESULT = new Type("result");
public static final Type ERROR = new Type("error");
/**
* Converts a String into the corresponding types. Valid String values
* that can be converted to types are: "get", "set", "result", and "error".
*
* @param type the String value to covert.
* @return the corresponding Type.
*/
public static Type fromString(String type) {
if (type == null) {
return null;
}
type = type.toLowerCase();
if (GET.toString().equals(type)) {
return GET;
}
else if (SET.toString().equals(type)) {
return SET;
}
else if (ERROR.toString().equals(type)) {
return ERROR;
}
else if (RESULT.toString().equals(type)) {
return RESULT;
}
else {
return null;
}
}
private String value;
private Type(String value) {
this.value = value;
}
public String toString() {
return value;
}
}
}
最終可生成如下結(jié)構(gòu)的數(shù)據(jù)
<iq from=""> <nofitication xlns=""> <iq>
我們在項(xiàng)目中的使用很簡單
xmppManager.getConnection().sendPacket(<NotificationIQ>niq)
當(dāng)然，上面只是實(shí)現(xiàn)了object->xml，接下來我們實(shí)現(xiàn)xml->data
2.實(shí)現(xiàn)IQProvider
先來看看IQProvider源碼
public interface IQProvider {
/**
* Parse the IQ sub-document and create an IQ instance. Each IQ must have a
* single child element. At the beginning of the method call, the xml parser
* will be positioned at the opening tag of the IQ child element. At the end
* of the method call, the parser <b>must</b> be positioned on the closing tag
* of the child element.
*
* @param parser an XML parser.
* @return a new IQ instance.
* @throws Exception if an error occurs parsing the XML.
*/
public IQ parseIQ(XmlPullParser parser) throws Exception;
}
實(shí)現(xiàn)自定義的解析工具
public class NotificationIQProvider implements IQProvider {
public NotificationIQProvider() {
}
@Override
public IQ parseIQ(XmlPullParser parser) throws Exception {
NotificationIQ notification = new NotificationIQ();
for (boolean done = false; !done;) {
int eventType = parser.next();
if (eventType == 2) {
if ("id".equals(parser.getName())) {
notification.setId(parser.nextText());
}
if ("apiKey".equals(parser.getName())) {
notification.setApiKey(parser.nextText());
}
if ("title".equals(parser.getName())) {
notification.setTitle(parser.nextText());
}
if ("message".equals(parser.getName())) {
notification.setMessage(parser.nextText());
}
if ("uri".equals(parser.getName())) {
notification.setUri(parser.nextText());
}
} else if (eventType == 3
&& "notification".equals(parser.getName())) {
done = true;
}
}
return notification;
}
}
項(xiàng)目中使用方法
ProviderManager.getInstance().addIQProvider("notification",
"androidpn:iq:notification",
new NotificationIQProvider());
在asmack中PacketParserUtils類中會進(jìn)行如下調(diào)用
Object provider = ProviderManager.getInstance().getIQProvider(elementName, namespace);
if (provider != null) {
if (provider instanceof IQProvider) {
iqPacket = ((IQProvider)provider).parseIQ(parser);
}
else if (provider instanceof Class) {
iqPacket = (IQ)PacketParserUtils.parseWithIntrospection(elementName,
(Class<?>)provider, parser);
}
}
相關(guān)文章
Android實(shí)現(xiàn)簡單C/S聊天室應(yīng)用
這篇文章主要為大家詳細(xì)介紹了Android實(shí)現(xiàn)簡單C/S聊天室應(yīng)用，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-01-01
這篇文章主要介紹了Android放大鏡的實(shí)現(xiàn)代碼，有需要的朋友可以參考一下2014-01-01
Android開發(fā)實(shí)現(xiàn)布局幀布局霓虹燈效果示例
這篇文章主要介紹了Android開發(fā)實(shí)現(xiàn)布局幀布局霓虹燈效果,涉及Android界面布局、資源文件操作及屬性設(shè)置等相關(guān)技巧,需要的朋友可以參考下2019-04-04
這篇文章主要介紹了Retrofit源碼之請求對象的轉(zhuǎn)換筆記，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-05-05
android TextView設(shè)置中文字體加粗實(shí)現(xiàn)方法
android TextView設(shè)置中文字體加粗如何實(shí)現(xiàn)，接下來介紹實(shí)現(xiàn)方法，有需要的朋友可以參考下2013-01-01
Android大圖監(jiān)測系統(tǒng)的三種實(shí)現(xiàn)方式
在Android應(yīng)用中,大圖的加載和顯示可能導(dǎo)致內(nèi)存占用過高,進(jìn)而引發(fā)OOM（Out Of Memory）異常,影響應(yīng)用的穩(wěn)定性和用戶體驗(yàn),為了更好地管理大圖資源,我們需要建立起一套可靠的大圖監(jiān)測系統(tǒng),文中有詳細(xì)的代碼示例供大家參考,需要的朋友可以參考下2024-01-01
這篇文章主要給大家介紹了關(guān)于idea下Android各目錄所代表含義的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03
Android用注解與反射實(shí)現(xiàn)Butterknife功能
Butterknife是一個在android上實(shí)現(xiàn)ioc（控制反轉(zhuǎn)）的一個庫。ioc的核心是解耦。解耦的目的是修改耦合對象時不影響另外一個對象，降低模塊之間的關(guān)聯(lián)。在Spring中ioc更多的是依靠xml的配置。而android上的IOC框架可以不使用xml配置2022-11-11
最近使用kotlin重構(gòu)項(xiàng)目,遇到了一個小問題,在Java中,可能會遇到判斷某個對象是否為空,為空執(zhí)行一段邏輯,不為空執(zhí)行另外一段邏輯,下面這篇文章主要給大家介紹了關(guān)于Kotlin中空判斷處理操作的相關(guān)資料,需要的朋友可以參考下2022-07-07
android中ProgressDialog與ProgressBar的使用詳解
本篇文章是對android中ProgressDialog與ProgressBar的使用進(jìn)行了詳細(xì)的分析介紹，需要的朋友參考下2013-06-06