基于XMPP协议的Android IM研究

基于XMPP协议的Android IM研究

之前在做基于XMPP协议的Android IM项目的过程中遇到了不少问题，由于国内这方面的资料相对比较少，而且不够全面，经过不断的学习和请教，项目有了一点进展，下面分享一下在项目的过程中遇到的问题和解决办法。
首先，声明XMPP连接：

Java代码

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

ConnectionConfiguration类的三个参数分别为ip地址，端口号，域名。
建立XMPP连接

Java代码

static {
connConfig.setSASLAuthenticationEnabled(true);//不使用SASL验证，设置为false
connection = new XMPPConnection(connConfig);
connection.connect();//连接
connection.login("06peng", "111111");//登陆
}

这样就能够和服务器连接了，运行代码，结果悲剧。报下面的错误：

Java代码

java.security.KeyStoreException: KeyStore jks implementation not found

还有：

Java代码

SASL authentication failed using mechanism PLAIN:

验证不通过，可是我已经设置了不使用SASL验证了，居然还出现这样的问题，于是看官方网站的例子，发现前面加了下面的配置：

Java代码

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

好吧，加上这样的验证代码应该是没问题了，哪知道一运行，还是悲剧,继续报错：

Java代码

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

鉴权失败，不过至少不报KeyStore jks implementation not found的错误了。于是，继续看官方例子，寻找相关资料，结果修改代码如下：

Java代码

connConfig.setReconnectionAllowed(true);
connConfig.setSecurityMode(ConnectionConfiguration.SecurityMode.enabled);
connConfig.setSASLAuthenticationEnabled(true);
connConfig .setTruststorePath("/system/etc/security/cacerts.bks");
connConfig.setTruststorePassword("changeit");
connConfig.setTruststoreType("bks");
connection = new XMPPConnection(connConfig);

一运行，通过了，心里那个激动啊。。。
感谢博客园一位叫“没有代码”的哥们，给了我一些建议，受到了帮助和启发。
由于代码写的比较复杂，主要就是引用了比较多的类和接口，所以不贴出来了，因为很麻烦，这里介绍一些比较简单的例子：

Java代码

connection.getAccountManager().createAccount(username, password); //创建一个用户

Java代码

roster.removeEntry(roster.getEntry(friendName)); //删除某个好友

Java代码

roster.setSubscriptionMode(Roster.SubscriptionMode.accept_all);
roster.createEntry(user, nickname, friends);//添加一个好友到朋友组上

Java代码

Collection<RosterEntry> entries = roster.getEntries();
for(Iterator<RosterEntry> entry = entries
.iterator();entry .hasNext();){
RosterEntry re = entry .next(); //获取所有好友
}

相关属性的介绍：

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代码

@Override
public void entriesAdded(Collection<String> address) {
for(String jid : address) {
RosterEntry entry = XMMPManager.connection.getRoster().getEntry(jid);
User user = new User();
user.setUser(jid);
user.setName(entry.getName());
user.setStatus(XMMPManager.connection.getRoster().getPresence(jid));
groups.get(0).getUsers().add(user);
AppContext.setGroups(groups);
}
handler.sendEmptyMessage(HandlerMessage.ENTRIESADDED);
}

@Override
public void entriesDeleted(Collection<String> address) {
for (String jid : address) {
RosterEntry entry = XMMPManager.connection.getRoster().getEntry(jid);
removeContact(entry);
removeContact(getContactByJid(jid), getGroupByUser(jid));
}
handler.sendEmptyMessage(HandlerMessage.ENTRIESDELETED);
}

@Override
public void entriesUpdated(Collection<String> address) {
// TODO Auto-generated method stub

}

@Override
public void presenceChanged(Presence presence) {
Bundle bundle = new Bundle();
Log.i(ContactManager.class.getCanonicalName(), presence.getStatus());
if (presence.isAway()) {
bundle.putString("status", PresenceManager.STATUSAWAY);
} else if (presence.isAvailable()) {
bundle.putString("status", PresenceManager.STATUSAVAILABLE);
}
bundle.putString("user", presence.getFrom());
Intent intent = new Intent();
intent.setAction(CustomAction.ROSTER_STATUS_CHANGED_ACTION);
intent.putExtras(bundle);
activity.sendBroadcast(intent);
}

具体就不解释了，看方法名就知道什么意思了。presenceChanged就是好友状态的改变。entriesAdded和entriesDeleted就是对应添加和删除好友。无非就是监听这些方法，然后界面发送事件给界面处理，比如下线了，用户头像变灰，用户列表总数对应减少等等。
好友监听的另一部分就是，当好友向你发起“添加您为好友”的通知时，你需要做出拒绝或者接受的选择，然后再通知给用户，用户那边做出选择后再返回给你，这样就完成了添加或拒绝好友的一个过程。这就是具体的思路，我的理解是这样的。下面请看我的代码：

Java代码

public void addSubscriptionListener() {
PacketFilter packetFilter = new PacketTypeFilter(Presence.class);
PacketListener subscribeListener = new PacketListener(){

@Override
public void processPacket(Packet packet) {
final Presence presence = (Presence)packet;
if (presence.getType().equals(Presence.Type.subscribe)) {
Message msg = new Message();
msg.what = HandlerMessage.SUBSCRIBE;
String from = presence.getFrom();
Bundle data = new Bundle();
data.putString("from", from);
Log.i(ContactManager.class.getCanonicalName(), "from:"+from);
msg.setData(data);
handler.sendMessage(msg);
} else if (presence.getType().equals(Presence.Type.unsubscribe)) {
Message msg = new Message();
msg.what = HandlerMessage.UNSUBSCRIBE;
String from = presence.getFrom();
Bundle data = new Bundle();
data.putString("from", from);
msg.setData(data);
handler.sendMessage(msg);
}
Log.i(ContactManager.class.getCanonicalName(), "type:" + presence.getType());
}

};
XMMPManager.connection.addPacketListener(subscribeListener, packetFilter);
}

这个方法在XMPP连接后便可调用，表示一开始就监听好友。
关于聊天信息的监听主要使用下面的方法：

Java代码

public class MessageListenerEx implements MessageListener {

@Override
public void processMessage(Chat chat, Message message) {
Log.i(ChatActivity.class.getCanonicalName(), message.getBody());
ChatInfo chatinfo = new ChatInfo();
chatinfo.setText(message.getBody());
chatinfo.setUserName(StringUtil.getLeftString(message.getFrom(), "@"));
chatinfo.setDate(DateUtil.getCreateAt(new Date()));
chatinfo.setLayoutId(R.layout.list_say_me_item);
chatinfos.add(chatinfo);
handler.sendEmptyMessage(RECEIVE);
}

}

这个方法就是不断地接收用户发过来的消息，当然还需要处理很多细节，这里不列出来了。
获取聊天对象和聊天管理类并添加监听接口：

Java代码

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

user是聊天的对象。下面是监听的实现方法。

Java代码

public class ChatManagerListenerEx implements ChatManagerListener {

@Override
public void chatCreated(Chat chat, boolean arg1) {
chat.addMessageListener(ml);
}

}

大概就是这样，发送一条信息：

Java代码

chat.sendMessage(content);