基于XMPP协议的aSmack源码分析

这个UML有些不是很规范，只是为了作为思维路线的记录，怕跟迷路，也不知道有什么好的工具能看源码的，就笨笨的一点点的扣。

This repository doesn't contain much code, it's a build environment!

Tracking trunk can be hard. Doing massive changes on top of trunk can be near impossible. We are mixing 6 open source projects to provide a working xmpp library for Android. All trunk-based.

This repository contains a source fetching, patching and building script. As well as all the minor changes to make an Android version fly. See the patches/ folder for a detailed list of changes and scripts.

在研究如何实现Pushing功能期间，收集了很多关于Pushing的资料，其中有一个androidnp开源项目用的人比较多，但是由于长时间没有什么人去维护，听说bug的几率挺多的，为了以后自己的产品稳定些，所以就打算自己研究一下asmack的源码，自己做一个插件，androidnp移动端的源码中包含了一个叫做asmack的jar。

Reader和Writer

在asmack中有两个非常重要的对象PacketReader和PacketWriter，那么从类名上看Packet + (Reader/Wirter)，而TCP/IP传输的数据，叫做Packet(包)，asmack使用的是XMPP协议，XMPP简单讲就是使用TCP/IP协议 + XML流协议的组合。所以这个了对象的作用从字面上看应该是，写包与读包，作用为从服务端读写数据。

PacketWriter中一定含有一个Writer对象，这个Writer是一个输出流，同样的PacketReader对象中有一个Reader，而这个Reader是一个输入流，Writer和Reader对象就是一个简单的读写器，他们是从socket对象中获取出来后，经过装饰变成现在这个样子。

reader = new  BufferedReader( new  InputStreamReader(socket.getInputStream(), "UTF-8" ));
writer = new  BufferedWriter( new  OutputStreamWriter(socket.getOutputStream(), "UTF-8" ));

　　

没有什么神奇的地方，主要看PacketWriter/Reader，这两个对象分别把对应的Writer和Reader引用到自己的内部进行操作，下面就先看一个PacketWriter。

 1  /**
 2      * Creates a new packet writer with the specified connection.
 3      *
 4      * @param connection the connection.
 5      */
 6     protected PacketWriter(XMPPConnection connection) {
 7         this.queue = new ArrayBlockingQueue<Packet>(500, true);
 8         this.connection = connection;
 9         init();
10     }

还有就是PacketWriter初始化的时候将XMPPConnection对象传了进来，因为在init方法中使用到了XMPPConnection对象的writer成员，我想说的是，为什么不直接传递writer成员？而是将整个对象XMPPConnection传了过来？其实这就是设计模式的好处，我们如果每次都传递的是自己的成员，那么如果后期有改动，实现一个新的XMPPConnection与PacketWriter关联，那么老的代码维护起来是很巨大的，如果这里XMPPConnection和他的同事类PacketWriter都有相对应的接口，（XMPPConnection的接口是Connection）那就更完美了，而这里用到的模式应该是中介者，不是绝对意义的中介者，由于形成中介者的条件比较高，所以实际开发中多是变形使用。PacketWriter对象在XMPPConnection中的connect方法中被初始化，它的最大作用是在其自身的内部创建了两个消息循环，其中一个用30s的heartbeats向服务器发送空白字符，保持长连接。而第二个循环则时刻从队列中主动取消息并发往服务器，而向外部提供的sendPacket方法则是向queue中添加消息，前面提到的循环机制都是在线程中工作，而消息的队列用的是ArrayBlockingQueue，这个无边界阻塞队列可以存放任何对象，这里存放的是Packet对象。

 1     public void sendPacket(Packet packet) {
 2         if (!done) {
 3             try {
 4                 queue.put(packet);
 5             }
 6             catch (InterruptedException ie) {
 7                 ie.printStackTrace();
 8                 return;
 9             }
10             synchronized (queue) {
11                 queue.notifyAll();
12             }
13         }
14     }

 1  while (!done && (writerThread == thisThread)) {
 2                 Packet packet = nextPacket();
 3                 if (packet != null) {
 4                     synchronized (writer) {
 5                         writer.write(packet.toXML());
 6                         writer.flush();
 7                         // Keep track of the last time a stanza was sent to the server
 8                         lastActive = System.currentTimeMillis();
 9                     }
10                 }
11             }

消息循环则是一个通过各种成员变量控制的while loop，第一行的nextPacket方法是向queue中获取Packet消息，并且通过weiter将包发出去，这样生产/消费的模型就搭建好了，这里需要注意的是，我删减了很多影响阅读的代码，并没有全部贴上。关于heartbeats循环其实也是一个在线程中运行的while loop，也是通过一些成员控制。wirter向服务端写了写什么？看下面的这个方法

 1 void openStream() throws IOException {
 2         StringBuilder stream = new StringBuilder();
 3         stream.append("<stream:stream");
 4         stream.append(" to=\"").append(connection.getServiceName()).append("\"");
 5         stream.append(" xmlns=\"jabber:client\"");
 6         stream.append(" xmlns:stream=\"http://etherx.jabber.org/streams\"");
 7         stream.append(" version=\"1.0\">");
 8         writer.write(stream.toString());
 9         writer.flush();
10     }

XML，没错，这也是符合XMPP协议规范的一种表现吧，至于更多XMPP协议的好处，由于本人的经验有限，就不多做点评，希望后续会对其深入了解。

下面看一个PacketReader这个类都包含了什么职责。

PacketReader

PacketReader所有的核心逻辑都在一个线程中完成的，PacketReader的工作很专注，同样的在一个while loop中 不停的解析、刷新reader对象、同时作为事件源发送解析过后的各种Packet，解析这里用的是Android独特的Pull解析，Pull解析的特点事件驱动，在这里被完全的利用了起来，随着不同的标签，PacketReader都会做出不同的处理，处理完这些数据用不同Pocket对象封装，最后，分发出去，由监听者做最后的业务处理。

1 readerThread = new Thread() {
2             public void run() {
3                 parsePackets(this);
4             }
5         };

由于解析过程的代码量过于多，我写到什么地方就分解什么地方，大家有时间最好自己看源码。

一、初始化/重置解析器

 1 private void resetParser() {
 2         try {
 3             //用的是Pull解析
 4             parser = XmlPullParserFactory.newInstance().newPullParser();
 5             parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, true);
 6             parser.setInput(connection.reader);
 7         }
 8         catch (XmlPullParserException xppe) {
 9             xppe.printStackTrace();
10         }
11     }

上面这个resetParser方法还会在解析的过程中碰到不同的业务需求会不断的被调用，有用和业务逻辑比较紧密，没什么技术含量，关键是要看解析的方式和同时作为事件源发送解析过后的各种Packet，这两部分的设计，是非常的迷人的。

二、解析

 1 do {
 2                 if (eventType == XmlPullParser.START_TAG) {
 3                     if (parser.getName().equals("message")) {
 4                         processPacket(PacketParserUtils.parseMessage(parser));
 5                     }
 6                     else if (parser.getName().equals("iq")) {
 7                         processPacket(PacketParserUtils.parseIQ(parser, connection));
 8                     }
 9                     else if (parser.getName().equals("presence")) {
10                         processPacket(PacketParserUtils.parsePresence(parser));
11                     }

PacketParserUtils是一个工具类，各个静态方法传入的还是Parser对象，内部同样的使用Pull的方式进行解析，但是由于Pull是驱动解析，不会无故的浪费资源只会加载感兴趣的内容，试想一下，如果这里用Dom解析……PacketParserUtils的这些静态解析方法返回的实例对象也不一样，从方法名可以看出有IQ、message、presence等，他们的父类为Packet，这些对象又被执行processPacket方法的时候传入

private void processPacket(Packet packet) {
        if (packet == null) {
            return;
        }

        // Loop through all collectors and notify the appropriate ones.
        for (PacketCollector collector: connection.getPacketCollectors()) {
            collector.processPacket(packet);
        }

        // Deliver the incoming packet to listeners.
        listenerExecutor.submit(new ListenerNotification(packet));
    }

processPacket方法内部有一个循环来转调collector.processPacket(packet);方法，前提是connection.getPacketCollectors()内部有货，到目前位置都没有涉及到PacketCollector这个接口的内容，他的作用其实是一个观察者模式中的执行者的作用，也就是传说中的监听器，凡是注册了它的对象，都可以通过processPacket这个抽象方法，监听packet的变化。可是到现在任何对象都没有注册它，所以这个Loop还没有作用，因为目前我们还处在连接的步骤（还没绕出来）。

 1 listenerExecutor.submit(new ListenerNotification(packet));其中ListenerNotification是个Runnable
 2     /**
 3      * A runnable to notify all listeners of a packet.
 4      */
 5     private class ListenerNotification implements Runnable {
 6 
 7         private Packet packet;
 8 
 9         public ListenerNotification(Packet packet) {
10             this.packet = packet;
11         }
12 
13         public void run() {
14             for (ListenerWrapper listenerWrapper : connection.recvListeners.values()) {
15                 listenerWrapper.notifyListener(packet);
16             }
17         }
18     }

我们上面看到listenerExecutor是一个线程池，在线程池中执行了一个凡是注册了ListenerWrapper的对象，都将接收到packet，同样的，到目前为止没有对象注册，（在RegisterTask过程中ListenerWrapper被注册）

else if (eventType == XmlPullParser.END_TAG) {
                    if (parser.getName().equals("stream")) {
                        // Disconnect the connection
                        connection.disconnect();
                    }
                }

当文档读取结束是将断开连接

void cleanup() {
        connection.recvListeners.clear();
        connection.collectors.clear();
    }

看到了吗，只是将监听器接口集合清空而已，并没有断开连接，或者取消消息循环

PacketReader对象的startup方法比较复杂，大体上执行了读取流，并将解析好的Packet对象发送给观察者，由观察者继续后续操作，目前观察者还没有出现，还有就是使用了线程池和令牌来操作执行线程，而且维护了一个connectionID成员，这个成员的作用还需要再看，这就不多说了。
关于Packet对象，packet对象有很多子类，上面举例了3个，其实还有很多，都是在parser时封装的
AuthMechanism\Challenge\Failure\IQ\Message\Presence\Response\Success
还有就是Pull解析的优点体现了出来，可以一个parser对象包含了很多信息，但可能没到一个时刻我们需要的信息只是一小部分，这样用Pull解析的驱动式就大大减少了冗余的过程，PacketReader对象使用了2个监听器集合对象，PacketCollector、listenerWrapper，还是那句话，还没看到观察者，所以还不知道什么情况下需要注册这两个监听。
到目前位置packetReader.startup()方法终于告一个段落了。

register过程分析
RegisterTask这个task在运行中，添加了一个监听，上面说道的PacketReader中有一个消息机制，在不停的解析服务器返回的结果，然后将解析过后的包分发给各个监听器（观察者），而register中就注册了一个监听器，比较有意思的是，监听器被注册时还加了一个过滤器，这个过滤器的目的是监听器只接收自己感兴趣的内容，这个设计真的很赞。这样就不必在数据源头PacketReader中对数据进行过滤了，只要后期扩展自己Packet和自己的过滤器，就能达到排除自己不关心的信息的功能。

1 Registration registration = new Registration();
2 
3                 PacketFilter packetFilter = new AndFilter(new PacketIDFilter(
4                         registration.getPacketID()), new PacketTypeFilter(
5                         IQ.class));

其中Registration的类型其实一个IQ的子类，IQ是Packet的子类。
AndFilter是PacketFilter的子类，PacketFilter的种类型有很多，也可以自己扩展，AndFilter就是其中一个、PacketTypeFilter也是、PacketIDFilter也是，
其中PacketTypeFilter的构造方法传入一个IQ.class，其实就是通过这个类文件来过滤packet，这个PacketTypeFilter就是要设置关心的Packet，这里面它告诉监听器，只接收类型为IQ的Packet，这些Filter中都有一个关键方法，accept(Packet packet).这个accept方法每个Filter的实现方式都不一样，我们可可以扩展自己的Filter并且重写这个方法，最有意思的是AndFilter这个类，他的构造方法传入的是一个动态数组，类型为PacketFilter，你可以传入你需要的过滤器，将他们当成组合条件使用来过滤Packet，这个就是典型的装饰设计模式和职责链模式的组合使用。

注册监听器

PacketListener packetListener = new PacketListener() {
                    //这一部分就是监听器接收到Packet后执行的后续操作
                    public void processPacket(Packet packet) {
                        Log.d("RegisterTask.PacketListener",
                                "processPacket().....");
                        Log.d("RegisterTask.PacketListener", "packet="
                                + packet.toXML());

                        if (packet instanceof IQ) {
                            IQ response = (IQ) packet;
                            if (response.getType() == IQ.Type.ERROR) {
                                if (!response.getError().toString().contains(
                                        "409")) {
                                    Log.e(LOGTAG,
                                            "Unknown error while registering XMPP account! "
                                                    + response.getError()
                                                            .getCondition());
                                }
                            } else if (response.getType() == IQ.Type.RESULT) {
                                xmppManager.setUsername(newUsername);
                                xmppManager.setPassword(newPassword);
                                Log.d(LOGTAG, "username=" + newUsername);
                                Log.d(LOGTAG, "password=" + newPassword);

                                Editor editor = sharedPrefs.edit();
                                editor.putString(Constants.XMPP_USERNAME,
                                        newUsername);
                                editor.putString(Constants.XMPP_PASSWORD,
                                        newPassword);
                                editor.commit();
                                Log
                                        .i(LOGTAG,
                                                "Account registered successfully");
                                //执行task
                                xmppManager.runTask();
                            }
                        }
                    }
                };

                connection.addPacketListener(packetListener, packetFilter);

addPacketListener方法传入一个监听器和过滤器，看一下内部

/**
     * Registers a packet listener with this connection. A packet filter determines
     * which packets will be delivered to the listener. If the same packet listener
     * is added again with a different filter, only the new filter will be used.
     * 
     * @param packetListener the packet listener to notify of new received packets.
     * @param packetFilter   the packet filter to use.
     */
    public void addPacketListener(PacketListener packetListener, PacketFilter packetFilter) {
        if (packetListener == null) {
            throw new NullPointerException("Packet listener is null.");
        }
        ListenerWrapper wrapper = new ListenerWrapper(packetListener, packetFilter);
        recvListeners.put(packetListener, wrapper);
    }

可以看到，监听器和过滤器被 ListenerWrapper 再次封装，后续的recvListeners这个集合将ListenerWrapper收入囊中，好整个注册过程完毕，就等待接收信息了，那么发送信息的地方在什么地方呢？分析connect过程时，上面的PacketReader中已经开始循环发送了，代码如下
listenerExecutor.submit(new ListenerNotification(packet));其中ListenerNotification是个Runnable

/**
     * A runnable to notify all listeners of a packet.
     */
    private class ListenerNotification implements Runnable {

        private Packet packet;

        public ListenerNotification(Packet packet) {
            this.packet = packet;
        }

        public void run() {
            for (ListenerWrapper listenerWrapper : connection.recvListeners.values()) {
                listenerWrapper.notifyListener(packet);
            }
        }
    }

而listenerWrapper的notifyListener(packet)内部，使用了传入的过滤器对Packet进行了过滤

/**
         * Notify and process the packet listener if the filter matches the packet.
         * 
         * @param packet the packet which was sent or received.
         */
        public void notifyListener(Packet packet) {
            if (packetFilter == null || packetFilter.accept(packet)) {
                packetListener.processPacket(packet);
            }

而具体的过滤机制还是转调了传入的过滤器本身的过滤方式accept，非常的灵活。过滤完的Packet将被发送出去

这个方法connection.sendPacket(registration);将一个Registration对象发了出去，

public void sendPacket(Packet packet) {
        if (!isConnected()) {
            throw new IllegalStateException("Not connected to server.");
        }
        if (packet == null) {
            throw new NullPointerException("Packet is null.");
        }
        packetWriter.sendPacket(packet);
    }

内部转调的是 packetWriter.sendPacket(packet);以前提到过PacketWirter中有两个循环机制，其中一个就是在不停的访问队列来获取Packet，而这个sendPacket方法就是将消息写入队列中供消费者使用。

/**
     * Sends the specified packet to the server.
     *
     * @param packet the packet to send.
     */
    public void sendPacket(Packet packet) {
        if (!done) {
            // Invoke interceptors for the new packet that is about to be sent. Interceptors
            // may modify the content of the packet.
            //内部执行了一个发送数据源的动作，也是为某些监听器对象服务的interceptorWrapper.notifyListener(packet);
            connection.firePacketInterceptors(packet);

            try {
                //将一个Packet对象放入到阻塞队列中，在上面的witerPacket方法中的wile循环中发送出去
                queue.put(packet);
            }
            catch (InterruptedException ie) {
                ie.printStackTrace();
                return;
            }
            synchronized (queue) {
                queue.notifyAll();
            }

            // Process packet writer listeners. Note that we're using the sending
            // thread so it's expected that listeners are fast.
            connection.firePacketSendingListeners(packet);
        }
    }    

其实，注册的过程就是在注册监听，这样在有消息发出时，才可以根据业务需求对消息进行接收和处理。