如果在一般的Java Project上開發xmpp的相關應用需要加入smack.jar 和klmx2.jar。
如果是Android Project,基本代碼只需加入asmack.jar包。
1.ConnectionConfiguration
作爲用於與XMPP服務建立連接的配置。它能配置;連接是否使用TLS,SASL加密。
包含內嵌類:ConnectionConfiguration.SecurityMode
2.XMPPConnection.
XMPPConnection這個類用來連接XMPP服務.
可以使用connect()方法建立與服務器的連接。disconnect()方法斷開與服務器的連接.
在創建連接前可以使用XMPPConnection.DEBUG_ENABLED = true; 使開發過程中可以彈出一個GUI窗口,用於顯示我們的連接與發送Packet的信息。
3.ChatManager
用於監控當前所有chat。可以使用createChat(String userJID, MessageListener listener)創建一個聊天。
4.Chat
Chat用於監控兩個用戶間的一系列message。使用addMessageListener(MessageListener listener)當有任何消息到達時將會觸發listener的processMessage(Chat chat, Message message)方法。
我們可以使用sendMessage()發送消息,這個方法有兩個重載方法,一種類類型的參數時String類型,另一種則是傳入Message對象。
那麼有這樣一種情況,當別人主動跟我們建立連接發送消息,或者系統發送消息時我們怎麼才能接收消息呢?
下面是這樣操作的:
@Override
public void chatCreated(Chat chat, boolean createdLocally) {
chat.addMessageListener(new MessageListener() {
@Override
public void processMessage(Chat chat, Message message) {
System.out.println("Received message: " + message.getBody());
}
});
}
});
5.Message
Message用於表示一個消息包(可以用調試工具看到發送包和接收包的具體內容)。它有以下多種類型。
Message.Type.NORMAL -- (默認)文本消息(比如郵件)。區別於chat,是在兩個用戶實體進行聊天外的消息內容,可以回覆。可以做需要“回執”動作之類的消息。
Message.Type.CHAT -- 典型的短消息,消息類型用於兩個實體用戶之間聊天。如QQ聊天的一行一行顯示的消息。
Message.Type.GROUP_CHAT -- 羣聊消息類型
Message.Type.HEADLINE -- 滾動顯示的消息,即不可回覆的消息類型(新聞, 體育, 市場信息, RSS feeds, 等等)
Message.TYPE.ERROR -- 錯誤的消息
消息的子元素
1. <subject/>
2. <body/>:消息的傳送內容
3. <thread/>:這個用於用戶建立兩實體間的聊天會話。發送者發送message的時候,在服務器中建立以thread.hashcode爲鍵值的thread池,接收者reply時再從thread池中查找會話線程
下面給出headline的消息類型的使用樣例:
connection.login(user, password);
Message message = new Message();
message.setTo("[email protected]");
message.setSubject("Server down");
message.setBody("server has just gone down");
message.setType(Message.Type.HEADLINE);
connection.sendPacket(message);
connection.close();
6.Roster
表示存儲了很多RosterEntry的一個花名冊。爲了易於管理,花名冊的項被分貝到了各個group中。
當建立與XMPP服務的連接後可以使用connection.getRoster()獲取Roster對象。
別的用戶可以使用一個訂閱請求(相當於QQ加好友)嘗試訂閱目的用戶。
可以使用枚舉類型Roster.SubscriptionMode的值處理這些請求:
accept_all: 接收所有訂閱請求
reject_all:拒絕所有訂閱請求
manual:手工處理訂閱請求
創建組:RosterGroup group = roster.createGroup("大學");
向組中添加RosterEntry對象: group.addEntry(entry);
7.RosterEntry
表示Roster(花名冊)中的每條記錄.它包含了用戶的JID,用戶名,或用戶分配的暱稱.
8.RosterGroup
表示RosterEntry的組。可以使用addEntry(RosterEntry entry)添加。
contains(String user) 判斷某用戶是否在組中。
當然removeEntry(RosterEntry entry)就是從組中移除了。
getEntries()獲取所有RosterEntry。
9.Presence
表示XMPP狀態的packet。每個presence packet都有一個狀態。用枚舉類型Presence.Type的值表示:
available -- (默認)用戶空閒狀態
unavailable -- 用戶沒空看消息
subscribe -- 請求訂閱別人,即請求加對方爲好友
subscribed -- 統一被別人訂閱,也就是確認被對方加爲好友
unsubscribe -- 他取消訂閱別人,請求刪除某好友
unsubscribed -- 拒絕被別人訂閱,即拒絕對放的添加請求
error -- 當前狀態packet有錯誤
內嵌兩個枚舉類型:Presence.Mode和Presence.Type.
可以使用setStatus自定義用戶當前的狀態(像QQ一樣的)。
可以用if(presence.isAvailable() == true) 來判斷好友是否在線。