用Smack编写jabber客户端

万事都不能从零开始,XMPP规范就象webServece规范一样.我们最后选用一个库来加速开发.所以我们选择使用Smack因为它容易使用,设计合理,还记得们的经典jive吗,它也是他们开发的,应该还是比较不错的. 注意是apache的licence,也就是可以应用到你的商业程序中.下载地址: http://www.jivesoftware.org/使用简单,你不需要精通xmpp协议(这加快我们入门,从例子开始我们跟容易理解),创建一个xmpp连接,并向一个用户发送信息,只需要三行代码:

XMPPConnection connection =  new XMPPConnection( "jabber.org");
connection.login( "mtucker",  "password");
connection.createChat( "jsmith@jivesoftware.com").sendMessage( "Howdy!");

因为是tcp协议,首先必须创建一个网络连接:

XMPPConnection 就是用来创建和xmpp服务器的连接的类,如果需要ssl就使用SSLXMPPConnection.

/ 创建连接.
XMPPConnection conn1 = new XMPPConnection("jabber.org");

// 指定端口
XMPPConnection conn2 = new XMPPConnection("jabber.org", 5222);

// 创建ssl连接.
XMPPConnection connection = new SSLXMPPConnection("jabber.org"); 

一旦你创建了连接，你需要使用用户名和密码来登陆,你可以使用XMPPConnection.login(String username, String password) 方法.一旦你完成登了,你可以通过创建新的Chat或者是GroupChat对象来和其它人聊天.

操作 名册

名册让你能够跟踪其它在线的用户,用户可以被组织成为组,例如好友,同事并且你可以发现谁在线,谁不在线.

你可以使用 XMPPConnection.getRoster() 方法来取得好友名单,得到roster类.roster类允许你查找名册实体,比如他们属于那个组,和当前的状态.

读写数据包

没一个从客户端发送到xmpp服务器的包都是xml格式的文本.org.jivesoftware.smack.packet 保护了封装三种xmpp级别包:message,presence,IQ.Chat类和GroupChat类提供了高级别的类管理包自动的生成和发送,但是你也可以手动创建它们.下面例子演示了改变你的在线情况,告诉其它人你不在线"外出捕鱼"去了。

/用presence.Type.UNAVILABLE作为参数创建一个presence描述你不在线.
Presence presence = new Presence(Presence.Type.UNAVAILABLE);
presence.setStatus("Gone fishing");
// 发送该包.
con.sendPacket(presence);

Smack 提供了两种方式来读取包: PacketListener,和 PacketCollector. 

它们都使用PacketFilter实例来决定那些包需要处理.一个PacketListener使用事件风格的编程,packet collector 提供轮循和阻塞的操作.因此,packet listener用来处理随即发送来的包,packet collector用来等待指定的包.Packet collectors and listeners使用XMPPConnection 对象来创建实例.

使用 Chat 和 GroupChat 传递消息

发送接受消息是即使通讯软件的核心功能.有两个类帮助完成这个任务.

• org.jivesoftware.smack.Chat -- 用来在两者之间传递信息.
• org.jivesoftware.smack.GroupChat -- 用来加入一个组给很多人之间传递消息.

他们都是使用org.jivesoftware.smack.packet.Message 类来实现消息传递. 在某些环境下你可以绕开Chat,GroupChat这两个高级的类手动传递消息或者是加入listener.

 

Chat

一个Chat对象在两个用户之间使用一个thread ID创建一个新的消息线程.下面的代码演示了如何使用一个user创建一个新的Chat,然后向它发送文本消息.

// 假设我们创建了一个 XMPPConnection 对象 名称为 "connection".
Chat newChat = connection.createChat("jsmith@jivesoftware.com");
newChat.sendMessage("Howdy!");


实际上Chat.sendMessage(String) 方法是一个我们提供的创建一个Message对象的方便的方法,它使用String 参数作为body,然后发送这个message.如果你想要加入其它熟悉,请使用:

// 假设我们创建了一个 XMPPConnection 对象 名称为 "connection".
Chat newChat = connection.createChat("jsmith@jivesoftware.com");
Message newMessage = newChat.createMessage();
newMessage.setBody("Howdy!");
message.setProperty("favoriteColor", "red");
newChat.sendMessage(newMessage);

Chat对象容许你侦听其它chat的回应.下面的代码实现了鹦鹉学舌--它会对任何人的话做出同样的回答.

// 假设我们创建了一个 XMPPConnection 对象 名称为 "connection".
Chat newChat = connection.createChat("jsmith@jivesoftware.com");
newMessage.setBody("Hi, I'm an annoying parrot-bot! Type something back to me.");
while (true) {
    //等待对方给我们发送消息 .
    Message message = newChat.nextMessage();
    // 把对方发给我们的消息原封不动的再发回去 .
    newChat.sendMessage(message.getBody());
}

上面的代码使用了Chat.nextMessage()方法来得到下一个message,它是阻塞式的.当然你可以加入一个listener来获取消息.

GroupChat

一个group chat运行你同时和一群用户聊天.你必须使用一个昵称来加入一个聊天组.下面代码演示了如何加入聊天组,并且发送消息.

// 假设我们创建了一个 XMPPConnection 对象 名称为 "connection".
GroupChat newGroupChat = connection.createGroupChat("test@jivesoftware.com");
// 使用昵称 "jsmith"加入聊天组.
newGroupChat.join("jsmith");
// 发送消息给聊天组.
newGroupChat.sendMessage("Howdy!");

发送和接受消息和Chat很类似就不详细讲述了.

聊天名单和在线状态

名单允许你跟踪其它用户的状态并且把用户分为好友,同事等等.你可以通过XMPPConnection.getRoster()方法获取Roster对象,但是必须在你成功登陆后.

Roster 实体

每一个用户都被描述为一个Roster实体,它包包括:

• 一个 XMPP 地址 (e.g. jsmith@example.com).
• 名称,昵称 (e.g. "Joe").
• 它属于哪个列表,如好友,同事?

下面的代码打印出所有Roster实体的信息:

Roster roster = con.getRoster();
for (Iterator i=roster.getEntries(); i.hasNext(); ) {
    System.out.println(i.next());
}

我们也提供了取得特定实体的方法,或者式组的方法.

在线状态

 

每一个用户列表中的对象都有在线状态.Roster.getPresence(String user)返回一个Presence对象描述用户的在线状态.一个用户的presence要么是在线要么是离线.当一个用户在线时候,它他们的presence还可以包含一些额外的信息,例如当前他们在做什么,他们是否乐于别打扰.监听好友名单和Presence的改变一般的来说都是用一个tree来显好友,

presence信息通常都是随时变化的,当然也有可能名单的增加和删除.要监听名单和presence的改变,必须使用RosterListener .下面的代码演示了如何监听并把任何presence改变打印出来.通常客户端软件有显示的代码来完成更新用户名单UI的代码来反映变化.

final Roster roster = con.getRoster();
roster.addRosterListener(new RosterListener() {
    public void rosterModified() {
        // Ignore event for this example.
    }

    public void presenceChanged(String user) {
        // If the presence is unavailable then "null" will be printed,
        // which is fine for this example.
        System.out.println("Presence changed: " + roster.getPresence(user));
    }
});

增加用户到用户列表

用户列表使用的允许模型,也就是只有对方容许你才能把他加入到你的用户名单中.这个保护了用户的隐私.因此,你加入一个用户将会进入一个未决状态直到对方接受请求.同时如果有一个用户请求把你加入,你必须对这个请求作出接受或反对的回应.Smack提供了三种策略:

• 自动接受所有请求.
• 自动反对所有请求.
• 交给用户手动处理.

你可以通过Roster.setSubscriptionMode(int subscriptionMode)来设置使用哪种策略.一个简单的客户端可以使用自动同意模式,但是一个功能比较健全的客户端应该提供用户手动出来.在手动模式中,你必须提供一个PacketListener 注册来诊听含有类型Presence.Type.SUBSCRIBE的Presence 包.

Smack提供了一个灵活的框架来处理接受到的数据包:

• org.jivesoftware.smack.PacketCollector -- 让你同步等待新的包.
• org.jivesoftware.smack.PacketListener -- 异步通知你包的到来.

一个packet listener在事件风格的程序中使用,packet collector可以做轮循和阻塞操作.它们都可以使用 XMPPConnection 实例来创建.

org.jivesoftware.smack.filter.PacketFilter 接口定义了那些包会分发到PacketCollector 或者是PacketListener.你可以在 org.jivesoftware.smack.filter 包中找到预定义的filters.

// 创建一个包 filter监听特定用户的消息.我们使用AndFilter来联合两个filters.

PacketFilter filter = new AndFilter(new PacketTypeFilter(Message.class), 
        new FromContainsFilter("mary@jivesoftware.com"));
// 假设我们创建了名称为 "connection" XMPPConnection 对象.

// 首先使用上面的filter创建PacketCollector对象.
PacketCollector myCollector = connection.createPacketCollector(filter);

// 接着, 我们创建一个 packet listener. 方便起见我们使用匿名内部类.
PacketListener myListener = new PacketListener() {
        public void processPacket(Packet packet) {
            // 当包到的时候你做什么.
        }
    };
// 注册.
connection.addPacketListener(myListener, filter);

标准Packet Filters

我们提供了一系列的filters,你可以实现  PacketFilter 接口来自定义实现.

• PacketTypeFilter -- filters for packets that are a particular Class type.
• PacketIDFilter -- filters for packets with a particular packet ID.
• ThreadFilter -- filters for message packets with a particular thread ID.
• ToContainsFilter -- filters for packets that are sent to a particular address.
• FromContainsFilter -- filters for packets that are sent to a particular address.
• PacketExtensionFilter -- filters for packets that have a particular packet extension.
• AndFilter -- implements the logical AND operation over two filters.
• OrFilter -- implements the logical OR operation over two filters.
• NotFilter -- implements the logical NOT operation on a filter.

用Smack编写jabber客户端的基本知识都够了,更多内容请查阅官方资料和mail list请求帮助.