iOS XMPP Framework 中文概述
本篇文章翻譯XMPP Framework中的Overview of the XMPP Framework部分
介紹
The framework is divided into 2 parts:
1. xmpp核心部分
2. xmpp擴展（roster，XEP‘s，可選的支持工具等）
xmpp核心部分實現了xmpp規範（RFC 3920）
請不要把聊天與xmpp混淆，xmpp全稱是”可擴展消息與存在協議”，它是一種能夠用於多種用途的通用協議，其實眼下有非常多公司使用這個框架比如家庭自己主動化，在醫院傳達警報給護士。
可擴展包含比如支持花名冊。自己主動重連與多種xmpp擴展實現(XEP‘s).。
XMPP核心
XMPP核心文件在本地命名為”Core”的目錄中。這些文件包含：
- XMPPStream
- XMPPParser
- XMPPJID
- XMPPElement
- XMPPIQ
- XMPPMessage
- XMPPPresence
- XMPPModule
- XMPPLogging
- XMPPInternal
這個框架的核心是XMPPStream類，這是你將要交互使用的基本的類。它是全部的擴展與定義代碼插入的類，它具有一些使框架靈活，可擴展，易於在上面開發有趣的功能。
這些將在稍後的文檔中更深入的討論。
XMPPParser 是XMPPStream使用的內部類。你或許已經猜出它是做什麽的了，你不須要以不論什麽方式形式與這個解析器交互。
XMPPJID 提供了一個不變的JID (Jabber Identifier)實現，它支持解析JID‘s，並以各種形式提取JID的各個部分。它遵守NSCopying協議。一邊JID‘s能夠當做NSDictionary的key。它也遵守NSCoding協議。
XMPPElement 是3個主要XMPP元素的基類:XMPPIQ, XMPPMessage & XMPPPresence. XMPPElement擴展NSXMLElement類，因此你有全部的NSXML的功能。檢查不論什麽xml元素。在這個章節有很多其它具體的描寫敘述Elements: IQ, Message, & Presence。
XMPPModule 提供可選植入擴展的基礎類，假設你正在寫你自己應用執行的代碼。
你非常可能只創建你自己的類。註冊接受代理調用。可是假設你正在實現一個標準的XEP。
或者你想你的應用指定擴展是可被植入，那麽你要在XMPPModule上創建，Module在後面更具體的被介紹。
XMPPLogging 提供一個非常快，強大靈活的日誌框架，它會在XMPP Logging 章節中討論。
XMPPInternal 不過關於核心和各種高級底層擴展內部的東西。
元素: IQ, Message, & Presence
XMPPElement擴展NSXMLElement類。因此你有全部的NSXML的功能，檢查不論什麽xml元素。
- XMPPIQ -> XMPPElement -> NSXMLElement -> NSXMLNode -> NSObject
- XMPPMessage -> XMPPElement -> NSXMLElement -> NSXMLNode -> NSObject
- XMPPPresence -> XMPPElement -> NSXMLElement -> NSXMLNode -> NSObject
除了NSXML基礎功能外，還提供了NSXMLElement+XMPP 類別。
這個類別提供各種方便的方法讓你的代碼更簡潔易讀。
比如：
[element attributeIntValueForName:@"age"];很多其它的信息請看Working With Elements頁面
XMPPStream配置
一個xmpp stream配置初始化被分為多個部分：
- 配置怎樣連接到xmppserver
- 加入代理
- 加入 modules
- 連接
- 認證
配置連接
對於大部分人來說。這僅涉及一個步驟 - 設置stream的myJID屬性。
比如：
xmppStream.myJID = [XMPPJID jidWithString:@"[email protected]"];該xmpp stream 將查找遵循XMPP RFC的剩余信息，這包含正在進行的SRV查找_xmpp-client._tcp.domain。在上面的樣例中，使用Gmail，谷歌server可能會返回相似"talk.google.com"。然後xmpp stream將會鏈接到該server，假設SRV查找查找失敗，那麽xmpp stream 將會簡單鏈接到JID‘s domain。
假設你知道你正在連接到不具有xmpp SRV記錄的xmppserver。你能夠告訴xmpp stream 通過指定的主機名跳過SRV查找，比如：
xmppStream.myJID = [XMPPJID jidWithString:@"[email protected]"];
xmppStream.hostName = @"myCompany.com";主機名也會派上用場，當你使用一個開發xmppserver。可能server是在背地網絡可用的，或者不具有DNS地址等，比如：
xmppStream.myJID = [XMPPJID jidWithString:@"[email protected]"];
xmppStream.hostName = @"192.168.2.27";還有一個可選的屬性是主機port，默認情況下，並依照xmpp規範。差點兒全部的server上的port都在5222執行。假設你的server在不同的port上執行。那能夠設置主機port的屬性。
加入代理
XMPPStream有一些旨在使框架靈活，可擴展，易於在上面開發有趣的功能。當中之中的一個使用MulticastDelegate。
什麽是MulticastDelegate？
xmpp framework須要支持擴展的數量不受限制，這包含對這個框架的官方擴展，以及不論什麽數量的擴展或你想要插入這個框架的自己定義代碼。因此傳統的代理模式是行不通的。xmpp 模塊和擴展須要分開到自己單獨的類。但每一個類都須要接受代理方法。而標準NSNotification架構將無法勝任，一些代理要求返回變量。（加上它真的非常煩人要從userInfo字典的通知中提取參數）。
因此一個MulticastDelegate同意你使用一個標準的代理模式插入框架中。但它同意多個類接受想用的代理通知。這樣做的優點是，你不必把全部的xmpp處理代碼在一個類中。你能夠覺得你合適的方法分開處理在不同的類中。
你能夠不論什麽時間加入/刪除XMPPStream的代理對象：
[xmppStream addDelegate:self delegateQueue:dispatch_get_main_queue()];
...
[xmppStream removeDelegate:self];很多其它關於MulticastDelegate的討論能夠在這裏找到。
線程和隊列更具體的討論能夠在這裏找到。
加入 Modules
這有一些關於這個框架的擴展，當然。你能夠如你所願寫盡可能多的擴展。
我們不會檢查全部可用的擴展，但我們會列出幾個在這裏演示樣例。
- XMPPReconnect - 自己主動又一次連接。假設你意外斷開。
- XMPPRoster - 提供標準的xmpp花名冊支持
- XMPPRoom - 提供多人聊天支持.
- XMPPPubSub - 公布訂閱
作為樣例，我們將會插入XMPPReconnect模塊在我們的stream：
xmppReconnect = [ [XMPPReconnect alloc] init];
// Optional configuration of xmppReconnect could go here.
// The defaults are fine for our purposes.
[xmppReconnect activate:xmppStream];
// You can also optionally add delegates to the module.
[xmppReconnect addDelegate:self delegateQueue:dispatch_get_main_queue()];
// And that‘s all that is needed.
// The module will receive any delegate methods it needs automatically
// from the xmpp stream, and will continue to do its thing unless you deactivate it.連接
當你準備好，你能夠開始連接進程：
NSError *error = nil;
if (![xmppStream connect:&error])
{
NSLog(@"Oops, I probably forgot something: %@", error);
}假設你忘記設置必需的屬性。比如myJID，那麽connect方法會返回NO，錯誤消息會通知你的問題。
在連接過程中。client和server經過一個xmpp握手。
在此期間，server通知各種它支持以及須要的各種協議給client。有些server可能須要連接通過SSL/TLS。假設是這種情況下，xmpp stream將自己主動保護連接，假設你正在連接server以不對X509證書。你可能須要實現xmppStream:willSecureWithSettings: 代理方法來改變默認的安全設置。
認證
全部的連接握手結束後xmppStreamDidConnect: 代理方法被調用。這一般是大多數client應啟動驗證過程：
- (void)xmppStreamDidConnect:(XMPPStream *)sender
{
[xmppStream authenticateWithPassword:password error:NULL];
}XMPP 日誌
這有幾個目標對於整個XMPP架構日誌：
它必須支持多種日誌級別.
不是全部的日誌消息具有相同的優先級。有些是有關錯誤的，而其它都不過信息。日誌分級幫助開發人員保證他們的日誌信息完整的。能夠打開和關閉他們沒有不論什麽困難。它必須在每一個文件基礎上可配置
一個全局日誌級別不會接受當這個框架包含了這麽多文件。加上調試的問題往往開發人員只希望看到幾個文件的日誌語句。
它必須可配置於終端用戶
xmpp framework 須要對日誌語句全然控制，用戶有非常多不同的需求。一些想要日誌聲明到一個文件裏，一些可能想要日誌聲明到數據庫裏。或者可能他們須要針對日誌聲明在不同的地方，取決於日誌聲明來源於app中還是xmpp framework。
我從事client多年來的工作。我看到第三方框架一遍又一遍發生相同的問題。
第三方庫自帶散落著的NSLog語句。終於須要用戶通過庫凝視掉NSLog語句，或者將它們轉換為一些原始的自己定義宏的版本號。
xmpp framework 採用了專業的日誌框架CocoaLumberjack。
這個日誌框架實際上比的NSLog更快。做相同的事情時也是如此。此外，它還支持大量不同的配置，並同意終端用戶甚至能夠加入自己的自己定義日誌記錄，篩選和格式化。
以下是你須要知道的XMPPFramework有關日誌的設置：
對於在框架內部大多數文件頂部你會發現例如以下：
// Log levels: off, error, warn, info, verbose
static const int xmppLogLevel = XMPP_LOG_LEVEL_WARN;如你所見有4個日誌級別(加上 XMPP_LOG_LEVEL_NONE):
- Error
- Warning
- Info
- Verbose
您能夠更改不論什麽文件的日誌級別。要它輸出很多其它的信息。
除了這一點。可啟用一個跟蹤標記。當啟用跟蹤，它輸出正在調用的方法。
請註意。跟蹤是從日誌等級分開的。比如，一個能夠設置日誌級別設置為警告。並啟用跟蹤像這樣：
// Log levels: off, error, warn, info, verbose
static const int xmppLogLevel = XMPP_LOG_LEVEL_WARN | XMPP_LOG_FLAG_TRACE;就代碼而言意味著：
XMPPLogTrace(); // Enabled - Will spit out "<FileName>: <MethodName>"
XMPPLogError(@"I will get logged");
XMPPLogWarn(@"I will get logged");
XMPPLogInfo(@"I will NOT get logged");
XMPPLogVerbose(@"I will NOT get logged");除此之外，XMPPStream有一個選項使你能夠看到正在發送的原始XML sent/received。你能夠把它放在XMPPStream.m像這樣：
// Log levels: off, error, warn, info, verbose
static const int xmppLogLevel = XMPP_LOG_LEVEL_INFO | XMPP_LOG_FLAG_SEND_RECV;當你啟動應用程序。您須要配置lumberjack框架。
對於剛開始學習的人來說，你能夠這樣簡單的設置在你的AppDelegate：
#import "DDLog.h"
#import "DDTTYLogger.h"
- (void)applicationDidFinishLaunching:(NSNotification *)aNotification
{
[DDLog addLogger:[DDTTYLogger sharedInstance] withLogLevel:XMPP_LOG_FLAG_SEND_RECV];
// All your other code...
}很多其它關於Lumberjack信息參考這裏。
For more information about Lumberjack take a look at its project page.
很多其它信息
想要立馬開始？
- Get started using XMPPFramework on iOS
- Get started using XMPPFramework on Mac OS X
擴展你的知識！
Learn about working with xml/xmpp elements
Learn about XMPPFramework‘s threading architecture
iOS XMPP Framework 中文概述