iOS—XMPP登录、聊天

通常的做法是我们会新建一个专门针对 xmpp 库的管理类，来处理所有的关于 xmpp 类的调用，这也是对封装的一点运用，不会对其他业务代码有侵入性，并且也方便处理整个关于 xmpp 的逻辑处理，这样的管理类一般会采用单例模式。

说到 xmpp ，最重要的一个类非 XMPPStream 莫属，所有的「连接」、「登录」、「注册」、「授权」、「失去连接」等操作的回调都通过它，所以必须需要有这么一个实例。另外，还添加了一个心跳处理的类来定时发送 ping 包。

@interface XMPPManager ()

@property (nonatomic, strong) XMPPStream *xmppStream;
/** 定时发送心跳包 */
@property (nonatomic, strong) XMPPAutoPing *xmppAutoPing;

@end

// 单例方法，略...
// 重新init方法，在里面调用setupStream方法，略...

 /** Setup the XMPP stream */
- (void)setupStream {
    _xmppStream = [[XMPPStream alloc] init];
    // 在多线程中运行，为了不阻塞UI线程，
    [_xmppStream addDelegate:self delegateQueue:dispatch_get_global_queue(0, 0)];
        
    _xmppAutoPing = [[XMPPAutoPing alloc] init];
    _xmppAutoPing.pingInterval = 20.f; // 心跳包间隔
    [_xmppAutoPing activate:_xmppStream];
    [_xmppAutoPing addDelegate:self delegateQueue:dispatch_get_global_queue(0, 0)];
}

这里需要提前申明一下，在我现在所开发的 App 里，当用户注册了账号之后，我们的后台会自动在 openfire 服务器中为这个用户做一遍注册操作，这样在 App 端就不需要使用 xmpp 注册了。

以下是连接方法：

/** 开始连接，这里还只是socket连接 */
- (void)startConnect {
    NSString *uid = @"1024"; // 我们的就是用户的uid
    // jid的固定格式：「uid」@「IP或域名」/ 「Resource」
    // 比如：1024@192.168.1.1/iOS_V1.0
    NSString *jidStr = [NSString stringWithFormat:@"%@@%@/%@", uid, @"192.168.1.1", @"iOS_V1.0"];
    XMPPJID *xmppJID  = [XMPPJID jidWithString:jidStr];
    [self.xmppStream setMyJID:xmppJID];
    
    NSError *error;
    [self.xmppStream connectWithTimeout:XMPPStreamTimeoutNone error:&error];
}

接下来，监听回调方法：（并加了一些注释，解释当前的步骤 xmpp 都做了些什么操作）

#pragma mark - XMPPStreamDelegate

- (void)xmppStreamWillConnect:(XMPPStream *)sender {
    NSLog(@"socket正在连接...");
}

- (void)xmppStream:(XMPPStream *)sender socketDidConnect:(GCDAsyncSocket *)socket {
    NSLog(@"socket连接成功...");
    // 连接成功之后，由客户端xmpp发送一个stream包给服务器，服务器监听来自客户端的stream包，并返回stream feature包
}

- (void)xmppStreamDidConnect:(XMPPStream *)sender {
    NSLog(@"xmpp连接成功，正在授权......");
    NSError *error;
    [self.xmppStream authenticateWithPassword:@"apple520" error:&error];
    // 客户端xmpp发送auth包，请求授权；服务器返回success；发送xmpp-bind包、xmpp-session包等。
}

- (void)xmppStream:(XMPPStream *)sender didNotAuthenticate:(NSXMLElement *)error {
    NSLog(@"️xmpp授权失败:%@", error.description);
}

- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender {
    NSLog(@"xmpp授权成功。");
    // 只有进入到这里，才算是真正的可以聊天了
}

- (void)xmppStreamDidDisconnect:(XMPPStream *)sender withError:(NSError *)error {
    NSLog(@"️xmpp失去连接。");
}

整个 xmpp 连接过程相对来说比较简单，完成上面的步骤算是最初级的。然而在实际的应用中，会遇到各种各样的连接问题，以至于用户无法正常聊天。当 xmpp 连接上了之后，并不会一直处于连接状态，可能因为网络问题断开连接，因为在另一个设备登录被迫下线，或者服务器出错导致失去连接。这些问题都需要客户端和服务器端来联调解决，客户端要考虑各种情况，来保证用户可以顺利的收发消息。

以下是 xmpp 连接中收发的数据包事例：

17:22:41.357  -[XMPPManager xmppStreamWillConnect:] socket正在连接...

17:22:42.100  -[XMPPManager xmppStream:socketDidConnect:] socket连接成功...

17:22:42.102  SEND: <?xml version='1.0'?>

17:22:42.103  SEND: <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' version='1.0' to='192.168.1.1'>

17:22:43.085  RECV: <stream:features xmlns:stream="http://etherx.jabber.org/streams"><mechanisms xmlns="urn:ietf:params:xml:ns:xmpp-sasl"><mechanism>PLAIN</mechanism></mechanisms><auth xmlns="http://jabber.org/features/iq-auth"/></stream:features>

17:22:43.086  -[XMPPManager xmppStreamDidConnect:] [Line 198] xmpp连接成功, 正在授权......

17:22:43.087  SEND: <auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" mechanism="PLAIN">DJhJ5hsADHd824</auth>
<auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" mechanism="PLAIN">DJhJ5hsADHd824</auth><resource>iOS_V1.0</resource>

17:22:43.534  RECV: <success xmlns="urn:ietf:params:xml:ns:xmpp-sasl"/>

17:22:43.534  SEND: <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' version='1.0' to='192.168.1.1'>

17:22:43.870  RECV: <stream:features xmlns:stream="http://etherx.jabber.org/streams"><bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"/><session xmlns="urn:ietf:params:xml:ns:xmpp-session"/></stream:features>

17:22:43.871  SEND: <iq type="set" id="123BF55A-C6FC-4AA8-A922-E1B869D6D731"><bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"><resource>iOS_V1.0</resource></bind></iq>

17:22:44.261  RECV: <iq xmlns="jabber:client" type="result" id="123BF55A-C6FC-4AA8-A922-E1B869D6D731" to="192.168.1.1/isaw95526287f"><bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"><jid>1024@192.168.1.1/iOS_V1.0</jid></bind></iq>

17:22:44.262  SEND: <iq type="set" id="80BA9B44-1247-4219-9F54-0C1E63F424A0"><session xmlns="urn:ietf:params:xml:ns:xmpp-session"/></iq>

17:22:44.669  RECV: <iq xmlns="jabber:client" type="result" id="80BA9B44-1247-4219-9F54-0C1E63F424A0" to="1024@192.168.1.1/iOS_V1.0"/>

17:22:44.670  -[XMPPManager xmppStreamDidAuthenticate:] [Line 208] xmpp授权成功。

最后来说说聊天，也就是发消息。消息有很多类型，比如文本、图片、音频、图文等等，所以在消息体中需要有字段来判别此消息的类型。我所开发的 App 中，消息类型有将近 20 种，扩展了很多字段，甚至还插入了 JSON 字符串在里面。

以下是一个简单的单聊发消息事例：（在我的 App 中，我写了一个专门用来处理消息的类，解析消息，存消息，并转发给相应的类）

//生成XML消息文档
NSXMLElement *messageElement = [NSXMLElement elementWithName:@"message"];

// 聊天类型，区别群聊(groupchat)和单聊(chat)
[messageElement addAttributeWithName:@"type" stringValue:@"chat"];

// 发送给谁
[messageElement addAttributeWithName:@"to" stringValue:@"2048@192.168.1.1/iOS_V1.0"];

// 由谁发送
[messageElement addAttributeWithName:@"from" stringValue:@"1024@192.168.1.1/iOS_V1.0"];

// 添加消息ID
[messageElement addAttributeWithName:@"id" stringValue:[self.xmppStream generateUUID]];

// 消息内容
NSXMLElement *body = [NSXMLElement elementWithName:@"body"];
[body setStringValue:@"今天的天气真好。"];
[messageElement addChild:body];

// 消息类型，1代表普通文本，2代表图片，3代表音频
NSXMLElement *itemType =[NSXMLElement elementWithName:@"itemType"];
[itemType setStringValue:@"1"];
[messageElement addChild:itemType];

// 发送消息
[self.xmppStream sendElement:messageElement];

下一篇章将会讲述 xmpp 连接的一些问题，修改源码来优化连接。

欢迎来一起交流。