AndroidPN源碼分析

很久沒有寫筆記了,也沒有分享了,關鍵是上班太累、做的東西太多、太雜,涉及的東西也多了,自己也很難抽出時間寫寫。
最近自己在做類似QQ那樣的聊天程序,其中對消息的交互有兩種方式,push和pull。下面就講講自己比較鍾愛的android push技術——AndroidPN
Androidpn包含有server和client兩個包,server部分可以作爲服務器單獨運行,也可以嵌入到web項目的servlet中,在tomcat環境中與web項目的其他部分交互。現在的版本比較多,基於tomcat、ssh的都有,文章的後面我會附上代碼:

Server部分的主要包結構如下:

其中org.androidpn.server.dao,org.androidpn.server.model和org.androidpn.server.service爲使用hibernate鏈接數據庫並實現簡單的用戶登錄認證,開發中可以用我們自己的認證模塊替換。剩下的包就是推送的主體實現。

接下來逐個包來看:

1.util包中的類用來加載resources中的配置文件,在配置文件中可指定監聽端口和ssl證書目錄等屬性。

2.org.androidpn.server.xmpp包裏面定義了一些異常類型,主要是包含有入口類XmppServer,這個類用來啓動和停止server程序。

3.org.androidpn.server.xmpp.auth包裏面是認證的一些類,我們自己的認證模塊可以在這裏與androidpn進行結合。

4.org.androidpn.server.xmpp.codec是XMPP協議的XML文件解析包,server收到和發送的消息都要通過這個包來進行xmpp協議編碼和解碼。

5.org.androidpn.server.xmpp.handler包主要是對消息的處理,我們可以針對不同的消息類型定義自己的handler,

6.org.androidpn.server.xmpp.net包負責維護與client之間的持久連接,並實現了一些傳輸方式供發送xmpp消息時使用。

7.org.androidpn.server.xmpp.presence裏面只包含PresenceManager類,用來維護client的在線狀態。

8.org.androidpn.server.xmpp.push包裏面的NotificationManager類包含有向client發送消息的接口。

9.org.androidpn.server.xmpp.router包負責將收到的信息包發送到相應的handler進行處理,是一個路由包。

10.org.androidpn.server.xmpp.session包定義了用來表示持久鏈接的session,每個session包含一條連接的狀態信息。

11.org.androidpn.server.xmpp.ssl是對連接進行ssl認證的工具包。

server發送消息的整個流程主要是:

1. NotificationManager的push接口被調用。

2.使用SessionManager在當前session集合中查找相應的client鏈接。

3.定義自己的XMPP消息格式並組裝。

4.通過相應session,向client發送消息。

在這個流程中我們需要修改的是步驟3,也就是需要定義和組裝自己的xmpp消息,以便於將適當的信息傳到客戶端並便於客戶端解析。一個簡單的消息組裝例子如下:

要注意的是在創建element的時候,傳入的namespace要和client解析使用的namespace相匹配。
server端接收和處理消息的流程是:
1.connection收到packet,使用tsc.push.server.xmpp.codec解碼。
2.router根據packet的namespace等信息,將packet路由到相應的handler。
3.handler進行處理。
相應的router和handler類在androidpn中都有例子可以參考,這裏就不貼代碼了。開發中只要根據client發送消息的格式,定義自己的router和handler類,然後在PacketRouter中註冊router,在IQRouter中註冊handler即可。
Client部分的主要包結構如下:
Client這邊包含有消息的收發,解析以及持久連接的發起,重連等功能呢,十分強大,我們開發時完全不用管底層的連接,也不用擔心斷線,可以專注於業務部分的開發。
同時,代碼結構也很簡單。去除android的Service和BroadCast類以及一些工具類和常量類不談:
1.NotificationIQ,NotificationIQProvider,NotificationPacketListener三個類負責對收到的Notification格式的消息進行解析和處理,
2.XmppManager是主控制器,NotificationService通過這個類,在後臺維護androidpn連接。
3.PersistentConnectionListener,PhoneStateChangeListener,ReconnectionThread.java三個類則負責監聽手機的狀態並進行斷線重連。
我們自定義消息時需要定義3個類:在***IQ中定義消息的實體,在***IQProvider中將消息轉化爲***IQ實體,在***PacketListener中對實體進行處理,具體的實現可參考NotificationIQ,NotificationIQProvider,NotificationPacketListener三個類。在定義這些類之後,還需要在XmppManager中將這3個類中註冊到connection中,代碼如下:

需要注意的是,註冊***IQProvider時,傳入的namespace需要和服務端組裝消息時使用的namespace一致,才能正確的收到。




我的理解主要要點:

突破口 從public class XmppIoHandler implements IoHandler 方法裏開始 接收到數據包

public void messageReceived(IoSession session, Object message) throws Exception {
        log.debug("messageReceived()...,IoSession : " + session);
        log.debug("RCVD: " + message);

        // Get the stanza handler
        StanzaHandler handler = (StanzaHandler) session.getAttribute(STANZA_HANDLER);

        //        log.debug("StanzaHandler : " + handler);

        // Get the XMPP packet parser
        int hashCode = Thread.currentThread().hashCode();
        // 從緩存器中取出解析器,有直接取出,沒有進行緩存
        // 一線程對應一解析器
        XMPPPacketReader parser = parsers.get(hashCode);
        if (parser == null) {
            parser = new XMPPPacketReader();
            parser.setXPPFactory(factory);
            parsers.put(hashCode, parser);
        }

        // The stanza handler processes the message
        try {
            handler.process((String) message, parser);
        } catch (Exception e) {
            log.error("Closing connection due to error while processing message: " + message, e);
            Connection connection = (Connection) session.getAttribute(CONNECTION);
            connection.close();
        }
    }

這裏 通過 StanzaHandler 去處理  裏面的驗證也是 第一次的 驗證 成功 了  下次請求就通過

session.getStatus() != Session.STATUS_AUTHENTICATED 判斷

/**
     * The session status when closed
     *
     * 會話關閉狀態
     *
     */
    public static final int STATUS_CLOSED = 0;

    /**
     * The session status when connected
     *
     * 會話建立連接
     *
     */
    public static final int STATUS_CONNECTED = 1;

還有 

private Map<String, ClientSession> preAuthSessions = new ConcurrentHashMap<String, ClientSession>();

    private Map<String, ClientSession> clientSessions = new ConcurrentHashMap<String, ClientSession>();

public ClientSession createClientSession(Connection conn) {
        if (serverName == null) {
            throw new IllegalStateException("Server not initialized");
        }

        Random random = new Random();
        String streamId = Integer.toHexString(random.nextInt());

        ClientSession session = new ClientSession(serverName, conn, streamId);
        conn.init(session);
        conn.registerCloseListener(clientSessionListener);

        // Add to pre-authenticated sessions
        preAuthSessions.put(session.getAddress().getResource(), session);

        // Increment the counter of user sessions
        connectionsCounter.incrementAndGet();

        log.debug("ClientSession created.");
        return session;
    }

/**
     * Adds a new session that has been authenticated.
     *  
     * @param session the session
     */
    public void addSession(ClientSession session) {
        preAuthSessions.remove(session.getStreamID().toString());
        clientSessions.put(session.getAddress().toString(), session);
    }

preAuthSessions  相當於 過度的session  所以最後添加 會刪除



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章