XMPP之Smack 介绍

XMPP简介

原理

• 概述
  XMPP（可扩展消息处理现场协议）是基于可扩展标记语言（XML）的协议，它用于即时消息（IM）以及在线现场探测。它在促进服务器之间的准即时操作。这个协议可能最终允许因特网用户向因特网上的其他任何人发送即时消息，即使其操作系统和浏览器不同。

工作原理图

XMPP协议网络架构

XMPP是一个典型的C/S架构，而不是像大多数即时通讯软件一样，使用P2P客户端到客户端的架构，也就是说在大多数情况下，当两个客户端进行通讯时，他们的消息都是通过服务器传递的(也有例外，例如在两个客户端传输文件时)．采用这种架构，主要是为了简化客户端，将大多数工作放在服务器端进行，这样，客户端的工作就比较简单，而且，当增加功能时，多数是在服务器端进行．XMPP服务的框架结构如下图所示．XMPP中定义了三个角色，XMPP客户端，XMPP服务器、网关．通信能够在这三者的任意两个之间双向发生．服务器同时承担了客户端信息记录、连接管理和信息的路由功能．网关承担着与异构即时通信系统的互联互通，异构系统可以包括SMS(短信)、MSN、ICQ等．基本的网络形式是单客户端通过TCP／IP连接到单服务器，然后在之上传输XML

主要特点

• XMPP 协议是公开的，由JSF开源社区组织开发的。XMPP 协议并不属于任何的机构和个人，而是属于整个社区，这一点从根本上保证了其开放性。
• XMPP 协议具有良好的扩展性。在XMPP 中，即时消息和到场信息都是基于XML 的结构化信息，这些信息以XML 节(XML Stanza)的形式在通信实体间交换。XMPP 发挥了XML 结构化数据的通用传输层的作用，它将出席和上下文敏感信息嵌入到XML 结构化数据中，从而使数据以极高的效率传送给最合适的资源。基于XML 建立起来的应用具有良好的语义完整性和扩展性。
• 分布式的网络架构。XMPP 协议都是基于Client/Server 架构，但是XMPP协议本身并没有这样的限制。网络的架构和电子邮件十分相似，但没有结合任何特定的网络架构，适用范围非常广泛。
• XMPP 具有很好的弹性。XMPP 除了可用在即时通信的应用程序，还能用在网络管理、内容供稿、协同工具、档案共享、游戏、远端系统监控等。
• 安全性。XMPP在Client-to-Server通信，和Server-to-Server通信中都使用TLS (Transport Layer Security)协议作为通信通道的加密方法，保证通信的安全。任何XMPP服务器可以独立于公众XMPP网络（例如在企业内部网络中），而使用SASL及TLS等技术更加增强了通信的安全性。如下图所示：

工作原理

XMPP服务器

XMPP 服务器遵循两个主要法则：
(1)监听客户端连接，并直接与客户端应用程序通信；
(2)与其他 XMPP 服务器通信；
XMPP开源服务器一般被设计成模块化，由各个不同的代码包构成，这些代码包分别处理Session管理、用户和服务器之间的通信、服务器之间的通信、DNS（Domain Name System）转换、存储用户的个人信息和朋友名单、保留用户在下线时收到的信息、用户注册、用户的身份和权限认证、根据用户的要求过滤信息和系统记录等。另外，服务器可以通过附加服务来进行扩展，如完整的安全策略，允许服务器组件的连接或客户端选择，通向其他消息系统的网关。
基本的XMPP 服务器必须实现以下标准协议：
RFC3920 核心协议Core
RFC3921 即时消息和出席协议Instant Messaging and Presence
XEP-0030 服务发现Service Discovery

XMPP客户端

XMPP 系统的一个设计标准是必须支持简单的客户端。事实上，XMPP 系统架构对客户端只有很少的几个限制。一个XMPP 客户端必须支持的功能有：
(1)通过 TCP 套接字与XMPP 服务器进行通信；
(2)解析组织好的 XML 信息包；
(3)理解消息数据类型。
XMPP 将复杂性从客户端转移到服务器端。这使得客户端编写变得非常容易，更新系统功能也同样变得容易。XMPP 客户端与服务端通过XML 在TCP 套接字的5222 端口进行通信，而不需要客户端之间直接进行通信。
基本的XMPP 客户端必须实现以下标准协议（XEP-0211）：
RFC3920 核心协议Core
RFC3921 即时消息和出席协议Instant Messaging and Presence
XEP-0030 服务发现Service Discovery
XEP-0115 实体能力Entity Capabilities

XMPP网关

XMPP 突出的特点是可以和其他即时通信系统交换信息和用户在线状况。由于协议不同，XMPP 和其他系统交换信息必须通过协议的转换来实现，目前几种主流即时通信协议都没有公开，所以XMPP 服务器本身并没有实现和其他协议的转换，但它的架构允许转换的实现。实现这个特殊功能的服务端在XMPP 架构里叫做网关(gateway)。目前，XMPP 实现了和AIM、ICQ、IRC、MSN Massager、RSS0.9 和Yahoo Massager 的协议转换。由于网关的存在，XMPP 架构事实上兼容所有其他即时通信网络，这无疑大大提高了XMPP 的灵活性和可扩展性。

XMPP地址格式

一个实体在XMPP网络结构中被称为一个接点，它有唯一的标示符jabber identifier(JID)，即实体地址，用来表示一个Jabber用户，但是也可以表示其他内容，例如一个聊天室．一个有效的JID包括一系列元素：(1)域名(domain identifier)；(2)节点(node identifier)；(3)源(resource identifier)．它的格式是node@domain/resource，node@domain，类似电子邮件的地址格式．domain用来表示接点不同的设备或位置，这个是可选的，例如a在Server1上注册了一个用户，用户名为doom，那么a的JID就是doom@serverl，在发送消息时，指明doom@serverl就可以了，resource可以不用指定，但a在登录到这个Server时，fl的JID可能是doom@serverl、exodus(如果a用Exodus软件登录)，也可能是doom@serverl/psi(如果a用psi软件登录)．资源只用来识别属于用户的位置或设备等，一个用户可以同时以多种资源与同一个XMPP服务器连接。

XML流

MPP本质上是一种XML流技术。客户端开始和XMPP服务器会话，会打开一个长时间的TCP连接，然后和服务器协商一个流。一旦你和你的服务器建立了一个XML流，你和你的服务器可以通过流交换三个特殊的XML片段：，，.这些片段称为XML节。是XML中最有意义的基本单元，而且一旦你已建立一个XML流，你可以通过流发送无数个节。

XMPP消息格式

XMPP中定义了3个顶层XML元素: Message、Presence、IQ，下面针对这三种元素进行介绍。

用于在两个jabber用户之间发送信息。Jsm(jabber会话管理器)负责满足所有的消息，不管目标用户的状态如何。如果用户在线jsm立即提交;否则jsm就存储。
To :标识消息的接收方。
from : 指发送方的名字或标示(id)o
Text: 此元素包含了要提交给目标用户的信息。
结构如下所示:

     
         你好，在忙吗 
         

• 
  用来表明用户的状态，如：online、away、dnd(请勿打扰)等。当用户离线或改变自己的状态时，就会在stream的上下文中插入一个Presence元素，来表明自身的状态．结构如下所示：

        From =‘lily @ jabber.com/contact’
        To = ‘yaoman @ jabber.com/contact'
    Online
    

presence元素可以取下面几种值:
Probe :用于向接受消息方法发送特殊的请求
subscribe:当接受方状态改变时，自动向发送方发送presence信息。

• 
  一种请求／响应机制，从一个实体从发送请求，另外一个实体接受请求，并进行响应．例如，client在stream的上下文中插入一个元素，向Server请求得到自己的好友列表，Server返回一个，里面是请求的结果．
  其主要属性是type，包括：
  主要的属性是type。包括:
  Get :获取当前域值。
  Set :设置或替换get查询的值。
  Result :说明成功的响应了先前的查询。
  Error: 查询和响应中出现的错误。
  结构如下所示：

绑定到TCP

客户端与服务器通信的过程中，服务器必须允许客户端共享一个TCP连接来传输XML节，包括从客户端传到服务器和从服务器传到客户端。
服务器到服务器的通信过程中，服务器必须用一个TCP连接向对方发送XML节，另一个TCP连接（由对方初始化）接受对方的XML节，一共两个TCP连接。

代码抽取

建立链接

XMPPTCPConnectionConfiguration connectionConfiguration = XMPPTCPConnectionConfiguration.builder()
                .setHost(AppContancts.host)//主机名
                .setPort(AppContancts.port)//端口
                .setServiceName(AppContancts.host)
                .setSendPresence(true)// support presence
                .setConnectTimeout(1000 * 10)
                .setSecurityMode(ConnectionConfiguration.SecurityMode.disabled)//越过证书
                .build();

mConnection = new XMPPTCPConnection(connectionConfiguration);
mConnection.connect();      

mConnection.connect(); 需要手动调用此方法

登录

登录有两种方式：

• 在构建链接的时候去做登录

XMPPTCPConnectionConfiguration connectionConfiguration = XMPPTCPConnectionConfiguration.builder()
                .setHost(AppContancts.host)
                .setPort(AppContancts.port)
                .setServiceName(AppContancts.host)
                .setSendPresence(true)// support presence
                .setConnectTimeout(1000 * 10)
                .setUsernameAndPassword("Leo","123")
                .setSecurityMode(ConnectionConfiguration.SecurityMode.disabled)//越过证书
                .build();

        mConnection = new XMPPTCPConnection(connectionConfiguration);

setUsernameAndPassword("Leo","123") 调用此方法就可以在链接的时候完成登录。

• 完成构建后手动调用login()方法

     if (mConnection.isConnected()){
                mConnection.login("Leo","123");
            }

注册

注册时，需要先连接成功才能完成注册

 // 注册关键代码
        AccountManager accountManager = AccountManager.getInstance(mConnection);
        try {
            accountManager.createAccount("lexiaowen", "123");
        } catch (XMPPException e) {
            e.printStackTrace();
        } catch (SmackException.NotConnectedException e) {
            e.printStackTrace();
        } catch (SmackException.NoResponseException e) {
            e.printStackTrace();
        }

好友管理

• 首先好友管理由 org.jivesoftware.smack.roster.Roster类进行模块管理，本质上是用单例模式进行实例化，我们可以通过以下代码进行实例化：

 mRoster = Roster.getInstanceFor(mConnection);
        try {
            //设置对方添加自己好友，需要询问
            mRoster.setSubscriptionMode(Roster.SubscriptionMode.manual);
            mRoster.reloadAndWait();
        } catch (SmackException.NotLoggedInException e) {
            e.printStackTrace();
        } catch (SmackException.NotConnectedException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
 //监听好友状态（是否在线）、好友添加、查询好友结果等作用        
        mRoster.getEntriesAndAddListener(this, this);

• RosterListener 顾名思义，这个监听主要针对好友状态监听，例如以下分析：

 /**
     * 添加好友的时候，状态变化回回调，返回添加好友的XMPP地址集合
     */
    public void entriesAdded(Collection addresses);

    /**
     * 添加好友的时候，状态变化回回调，返回添加好友的XMPP地址集合
     */
    public void entriesUpdated(Collection addresses);

    /**
     * 好友信息更新的时候回调，返回添加好友的XMPP地址集合。一般可以利用更新本地数据库
     */
    public void entriesDeleted(Collection addresses);

    /**
     * 删除好友的时候，状态变化回调，返回添加好友的XMPP地址集合
     */
    public void presenceChanged(Presence presence);

• 添加好友

private void addRosyer(String user, String name, String[] groupName) {
        if (mConnection.isAuthenticated()) {
            try {
                mRoster.createEntry(user, name, groupName);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

• 删除好友

  //删除好友
    public void deleteRoster(String user) {
        RosterEntry entry = mRoster.getEntry(user);
        if (entry != null) {
            try {
                mRoster.removeEntry(entry);
            } catch (SmackException.NotLoggedInException |
                    SmackException.NoResponseException |
                    XMPPException.XMPPErrorException |
                    SmackException.NotConnectedException e) {
                e.printStackTrace();
            }
        }
    }

• 添加分组

 //添加分组
    public void addGroup(String groupName) {
        mRoster.createGroup(groupName);
    }

消息管理

Smack中的基本消息由org.jivesoftware.smack.packet.Message组成，消息内 容存储在body标签里面。

在线消息

• 获取聊天管理器

ChatManager mChatManager = ChatManager.getInstanceFor(mConnection);

• 发送消息

 Message message = new Message();
                        message.setBody("hello f123");
                        sendMessage(createChat("[email protected]"), message);

  public Chat createChat(String userJid) {
        ChatManager mChatManager = ChatManager.getInstanceFor(mConnection);
        Chat curChat = null;
        curChat = mChatManager.createChat(userJid);
        curChat.addMessageListener(this);
        return curChat;
    }

• 消息接收

需要实现两个回调监听：ChatManagerListener和ChatMessageListener

ChatManagerListener:

void chatCreated(Chat chat, boolean createdLocally); // 聊天会话被创建回调

ChatMessageListener:

void processMessage(Chat chat, Message message); // 消息接收回调