基於XMPP協議的Android IM研究

之前在做基於XMPP協議的Android IM項目的過程中遇到了不少問題，由於國內這方面的資料相對比較少，而且不夠全面，經過不斷的學習和請教，項目有了一點進展，下面分享一下在項目的過程中遇到的問題和解決辦法。

首先，聲明XMPP連接：

Java代碼

1.     
2. public static final ConnectionConfiguration connConfig = newConnectionConfiguration("169.254.50.19", 5222, "http://06peng.com");      
3. public static XMPPConnection connection;  

ConnectionConfiguration類的三個參數分別爲ip地址，端口號，域名。

建立XMPP連接

Java代碼

1.     
2. static {                
3.     connConfig.setSASLAuthenticationEnabled(true);//不使用SASL驗證，設置爲false        
4.     connection = new XMPPConnection(connConfig);        
5.     connection.connect();//連接          
6.     connection.login("06peng", "111111");//登陸          
7. }    

這樣就能夠和服務器連接了，運行代碼，結果悲劇。報下面的錯誤：

Java代碼

1.     
2. java.security.KeyStoreException: KeyStore jks implementation not found  

還有：

Java代碼

1.     
2. SASL authentication failed using mechanism PLAIN:  

驗證不通過，可是我已經設置了不使用SASL驗證了，居然還出現這樣的問題，於是看官方網站的例子，發現前面加了下面的配置：

Java代碼

1.     
2. ConnectionConfiguration connectionConfig = new ConnectionConfiguration(host, 5222, "");         
3. connectionConfig .setTruststorePath("/system/etc/security/cacerts.bks");         
4. connectionConfig.setTruststorePassword("changeit");         
5. connectionConfig.setTruststoreType("bks");  

好吧，加上這樣的驗證代碼應該是沒問題了，哪知道一運行，還是悲劇,繼續報錯：

Java代碼

1.     
2. not-authorized(401)       
3. at org.jivesoftware.smack.NonSASLAuthentication.authenticate(NonSASLAuthentication.java:109)      
4. at org.jivesoftware.smack.XMPPConnection.login(XMPPConnection.java:239)       
5. at org.jivesoftware.smack.Connection.login(Connection.java:353)  

鑑權失敗，不過至少不報KeyStore jks implementation not found的錯誤了。於是，繼續看官方例子，尋找相關資料，結果修改代碼如下：

Java代碼

1.     
2. connConfig.setReconnectionAllowed(true);      
3. connConfig.setSecurityMode(ConnectionConfiguration.SecurityMode.enabled);       
4. connConfig.setSASLAuthenticationEnabled(true);      
5. connConfig .setTruststorePath("/system/etc/security/cacerts.bks");       
6. connConfig.setTruststorePassword("changeit");       
7. connConfig.setTruststoreType("bks");       
8. connection = new XMPPConnection(connConfig);  

一運行，通過了，心裏那個激動啊。。。

感謝博客園一位叫“沒有代碼”的哥們，給了我一些建議，受到了幫助和啓發。

由於代碼寫的比較複雜，主要就是引用了比較多的類和接口，所以不貼出來了，因爲很麻煩，這裏介紹一些比較簡單的例子：

Java代碼

1.     
2. connection.getAccountManager().createAccount(username, password);  //創建一個用戶  

Java代碼

1.     
2. roster.removeEntry(roster.getEntry(friendName)); //刪除某個好友  

Java代碼

1.     
2. roster.setSubscriptionMode(Roster.SubscriptionMode.accept_all);        
3. roster.createEntry(user, nickname, friends);//添加一個好友到朋友組上  

Java代碼

1.     
2. Collection<RosterEntry> entries = roster.getEntries();        
3. for(Iterator<RosterEntry> entry  = entries .iterator();entry .hasNext();){        
4.     RosterEntry re = entry .next();  //獲取所有好友               
5. }    

相關屬性的介紹：

 

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)

 

5、Message
Message用於表示一個消息包(可以用調試工具看到發送包和接收包的具體內容)。它有以下多種類型。
Message.Type.NORMAL -- （默認）文本消息（比如郵件）
Message.Type.CHAT -- 典型的短消息，如QQ聊天的一行一行顯示的消息
Message.Type.GROUP_CHAT -- 羣聊消息
Message.Type.HEADLINE -- 滾動顯示的消息
Message.TYPE.ERROR -- 錯誤的消息
Message有兩個內部類：
Message.Body -- 表示消息體
Message.Type -- 表示消息類型

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.

具體使用方法可參考下一篇文章中的Smack中文文檔。

那麼由於有了基於XMPP協議的Android IM研究一，這篇文章就繼續介紹XMPP和ASmack的相關用法。在這裏主要介紹好友的監聽和聊天信息的監聽。對了好友的監聽我費了比較多的功夫，主要參考了Spack客戶端的源代碼，高手寫的代碼就是不一樣，很多代碼的實現方式都需要我不斷學習。Spack客戶端源代碼的地址：http://svn.ig.../repos/spark/

好友的監聽我把它分成兩部分，一部分是監聽好友的上線、下線等通知，另一部分是監聽好友發起“添加您爲好友”的通知。第一部分比較簡單，直接上代碼：

Java代碼

1.     
2. @Override      
3.     public void entriesAdded(Collection<String> address) {      
4.         for(String jid : address) {      
5.             RosterEntry entry = XMMPManager.connection.getRoster().getEntry(jid);      
6.             User user = new User();      
7.             user.setUser(jid);      
8.             user.setName(entry.getName());      
9.             user.setStatus(XMMPManager.connection.getRoster().getPresence(jid));      
10.             groups.get(0).getUsers().add(user);      
11.             AppContext.setGroups(groups);      
12.         }      
13.         handler.sendEmptyMessage(HandlerMessage.ENTRIESADDED);      
14.     }      
15.       
16.     @Override      
17.     public void entriesDeleted(Collection<String> address) {      
18.         for (String jid : address) {      
19.             RosterEntry entry = XMMPManager.connection.getRoster().getEntry(jid);      
20.             removeContact(entry);      
21.             removeContact(getContactByJid(jid), getGroupByUser(jid));      
22.         }      
23.         handler.sendEmptyMessage(HandlerMessage.ENTRIESDELETED);      
24.     }      
25.       
26.     @Override      
27.     public void entriesUpdated(Collection<String> address) {      
28.         // TODO Auto-generated method stub      
29.               
30.     }      
31.       
32.     @Override      
33.     public void presenceChanged(Presence presence) {      
34.         Bundle bundle = new Bundle();      
35.         Log.i(ContactManager.class.getCanonicalName(), presence.getStatus());      
36.         if (presence.isAway()) {      
37.             bundle.putString("status", PresenceManager.STATUSAWAY);      
38.         } else if (presence.isAvailable()) {      
39.             bundle.putString("status", PresenceManager.STATUSAVAILABLE);      
40.         }      
41.         bundle.putString("user", presence.getFrom());      
42.         Intent intent = new Intent();      
43.         intent.setAction(CustomAction.ROSTER_STATUS_CHANGED_ACTION);      
44.         intent.putExtras(bundle);      
45.         activity.sendBroadcast(intent);      
46.     }  

具體就不解釋了，看方法名就知道什麼意思了。presenceChanged就是好友狀態的改變。entriesAdded和entriesDeleted就是對應添加和刪除好友。無非就是監聽這些方法，然後界面發送事件給界面處理，比如下線了，用戶頭像變灰，用戶列表總數對應減少等等。

好友監聽的另一部分就是，當好友向你發起“添加您爲好友”的通知時，你需要做出拒絕或者接受的選擇，然後再通知給用戶，用戶那邊做出選擇後再返回給你，這樣就完成了添加或拒絕好友的一個過程。這就是具體的思路，我的理解是這樣的。下面請看我的代碼：

Java代碼

1.     
2. public void addSubscriptionListener() {      
3.          PacketFilter packetFilter = new PacketTypeFilter(Presence.class);      
4.          PacketListener subscribeListener = new PacketListener(){      
5.       
6.             @Override      
7.             public void processPacket(Packet packet) {      
8.                 final Presence presence = (Presence)packet;      
9.                 if (presence.getType().equals(Presence.Type.subscribe)) {      
10.                     Message msg = new Message();      
11.                     msg.what = HandlerMessage.SUBSCRIBE;      
12.                     String from = presence.getFrom();      
13.                     Bundle data = new Bundle();      
14.                     data.putString("from", from);      
15.                     Log.i(ContactManager.class.getCanonicalName(), "from:"+from);      
16.                     msg.setData(data);      
17.                     handler.sendMessage(msg);      
18.                 } else if (presence.getType().equals(Presence.Type.unsubscribe)) {      
19.                     Message msg = new Message();      
20.                     msg.what = HandlerMessage.UNSUBSCRIBE;      
21.                     String from = presence.getFrom();      
22.                     Bundle data = new Bundle();      
23.                     data.putString("from", from);      
24.                     msg.setData(data);      
25.                     handler.sendMessage(msg);      
26.                 }      
27.                 Log.i(ContactManager.class.getCanonicalName(), "type:" + presence.getType());      
28.             }      
29.                    
30.          };      
31.          XMMPManager.connection.addPacketListener(subscribeListener, packetFilter);      
32.     }  

這個方法在XMPP連接後便可調用，表示一開始就監聽好友。

關於聊天信息的監聽主要使用下面的方法：

Java代碼

1.     
2. public class MessageListenerEx implements MessageListener {      
3.       
4.         @Override      
5.         public void processMessage(Chat chat, Message message) {      
6.             Log.i(ChatActivity.class.getCanonicalName(), message.getBody());      
7.             ChatInfo chatinfo = new ChatInfo();      
8.             chatinfo.setText(message.getBody());      
9.             chatinfo.setUserName(StringUtil.getLeftString(message.getFrom(), "@"));      
10.             chatinfo.setDate(DateUtil.getCreateAt(new Date()));      
11.             chatinfo.setLayoutId(R.layout.list_say_me_item);      
12.             chatinfos.add(chatinfo);      
13.             handler.sendEmptyMessage(RECEIVE);      
14.         }      
15.               
16.     }  

這個方法就是不斷地接收用戶發過來的消息，當然還需要處理很多細節，這裏不列出來了。

獲取聊天對象和聊天管理類並添加監聽接口：

Java代碼

1.     
2. ChatManager chatManager = XMMPManager.connection.getChatManager();      
3. Chat chat = chatManager.createChat(user, null);      
4. chatManager.addChatListener(new ChatManagerListenerEx());  

user是聊天的對象。下面是監聽的實現方法。

Java代碼

1.     
2. public class ChatManagerListenerEx implements ChatManagerListener {      
3.       
4.         @Override      
5.         public void chatCreated(Chat chat, boolean arg1) {      
6.             chat.addMessageListener(ml);      
7.         }      
8.               
9.     }  

大概就是這樣，發送一條信息：

Java代碼

1.     
2. chat.sendMessage(content);