XMPP即時通信

XMPP:XMPP是基於XML的點對點通信協議,The Extensible Messaging and Presence Protocol(可擴展通信和表示協議)。node

XMPP可用於服務類實時通信,表示和需求響應服務中的XML數據元流失傳輸。XMPP以Jabber協議爲基礎,而Jabber是即時通信中經常使用的開放式協議。數據庫

基本結構。服務器

XMPP是一個典型的C/S架構,而不是像大多數即時通信軟件同樣,使用P2P客戶端到客戶端的架構,也就是說在大多數狀況下,當兩個客戶端進行通信時,他們的消息都是經過服務器傳遞的。採用這種架構,主要是爲了簡化客戶端,將大多數工做放在服務器端進行。網絡

XMPP中定義了三個角色,客戶端,服務器,網關。通訊可以在這三者的任意兩個之間雙向發生。架構

服務器同時承擔了客戶端信息記錄,鏈接管理和信息的路由功能。網關承擔着與異構即時通信系統的互聯互通,異構系統能夠包括SMS(短信),MSN,ICQ等。框架

基本的網絡形式是單客戶端經過TCP/IP鏈接到單服務器,而後在之上傳輸XML流。dom

 

 

1.1XMPP中的經常使用對象socket

XMPPStream:xmpp基礎服務類ide

XMPPRoster:好友列表類測試

XMPPRosterCoreDataStoreage:好友列表(用戶帳號)在core data中的操做類

XMPPvCardCoreDataStorage:好友名片(暱稱、簽名、性別、年齡等信息)在core data中的操做類

XMPPvCardTemp:好友名片實體類,從數據庫裏面取出來的都是它

xmppvCardAvatarModule:好友頭像

XMPPReconnect:若是失去鏈接,自動重連

XMPPRoom:提供多用戶聊天支持

XMPPPubSub:發佈訂閱

1.2登陸操做,也就是鏈接xmpp服務器

XMPP的地址叫作JabberID(簡寫爲JID),它用來標識XMPP網絡中的各個XMPP實體,JID由三個部分組成:domain、node identifier和resource。JID中domain是必不可少的部分。注意:domain和user部分是不分大小寫的,可是resource區別大小寫。

domain:一般指網絡中的網關或者服務器。

node identifier:一般表示一個向服務器或者網關請求和使用網絡服務的實體(好比一個客戶端),固然它也可以表示其餘的實體(好比在多用戶聊天系統中的一個房間)。

resource:一般表示一個特定的會話(與某個設備),鏈接(與某個地址),或者一個附屬於某個節點ID實體相關實體的對象(好比多用戶聊天室中的一個參加者)。

JID種類有:

bare JID:user@domain.tld

full JID:user@domain.tld/resource

如:

tom@jabber.org:表示服務器jabber.org上的用戶tom

room@service:一個用來提供多用戶聊天服務的特定的聊天室。這裏「room」是聊天室的名字,「service」是多用戶聊天服務的主機名。

room@service/nick:加入了聊天室的用戶nick的地址。這裏「room」是聊天室的名字,「service」是多用戶聊天服務的主機名,「nick」是用戶在聊天室的暱稱。

爲了表示JID,xmpp也有本身的URI,例如xmpp:stpeter.org,默認規則是在JID前加xmpp:。

代碼操做:

一、登陸操做,也就是鏈接XMPP服務器。

 1 - (void)connect {
 2     if (self.xmppStream == nil) {
 3         self.xmppStream = [[XMPPStream alloc] init];
 4         [self.xmppStream addDelegate:self delegateQueue:dispatch_get_main_queue()];
 5     }
 6     if (![self.xmppStream isConnected]) {
 7         NSString *username = [[NSUserDefaults standardUserDefaults] objectForKey:@"username"];
 8         XMPPJID *jid = [XMPPJID jidWithUser:username domain:@"lizhen" resource:@"Ework"];
 9         [self.xmppStream setMyJID:jid];
10         [self.xmppStream setHostName:@"10.4.125.113"];
11         NSError *error = nil;
12         if (![self.xmppStream connect:&error]) {
13             NSLog(@"Connect Error: %@", [[error userInfo] description]);
14         }
15     }
16 }

connect成功以後會依次調用XMPPStreamDelegate的方法,首先調用

- (void)xmppStream:(XMPPStream *)sender socketDidConnect:(GCDAsyncSocket *)socket
 
...

而後

- (void)xmppStreamDidConnect:(XMPPStream *)sender

在該方法下面須要使用xmppStream的authenticcateWithPassword方法進行密碼驗證,成功的話就會響應delegate的方法,就是下面這個:

1 - (void)xmppStreamDidAuthenticate:(XMPPStream *)sender

二、上線

實現- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender 委託方法

- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender {
    XMPPPresence *presence = [XMPPPresence presenceWithType:@"available"];
    [self.xmppStream sendElement:presence];
}

三、退出並斷開鏈接

1 - (void)disconnect {
2     XMPPPresence *presence = [XMPPPresence presenceWithType:@"unavailable"];
3     [self.xmppStream sendElement:presence];
4       
5     [self.xmppStream disconnect];
6 }

四、好友狀態

獲取好友狀態,經過實現

1 - (void)xmppStream:(XMPPStream *)sender didReceivePresence:(XMPPPresence *)presence
2  
3 ...

方法,當接收到presence標籤的內容時,XMPPFramework框架回調該方法

一個presence標籤的格式通常以下:

presence的狀態:

available上線

away離開

do not disturb忙碌

unavailable 下線

 1 - (void)xmppStream:(XMPPStream *)sender didReceivePresence:(XMPPPresence *)presence {
 2     NSString *presenceType = [presence type];
 3     NSString *presenceFromUser = [[presence from] user];
 4     if (![presenceFromUser isEqualToString:[[sender myJID] user]]) {
 5         if ([presenceType isEqualToString:@"available"]) {
 6             //
 7         } else if ([presenceType isEqualToString:@"unavailable"]) {
 8             //
 9         }
10     }
11 }

五、接收消息

經過實現

- (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message;

方法,當接收到message標籤的內容時,XMPPFramework框架回調該方法,根據XMPP協議,消息體的內容存儲在標籤body內

1 - (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message {
2     NSString *messageBody = [[message elementForName:@"body"] stringValue];
3 }

六、發送消息

發送消息,咱們須要根據XMPP協議,將數據放到標籤內,例如:

 1 - (void)sendMessage:(NSString *) message toUser:(NSString *) user {
 2     NSXMLElement *body = [NSXMLElement elementWithName:@"body"];
 3     [body setStringValue:message];
 4     NSXMLElement *message = [NSXMLElement elementWithName:@"message"];
 5     [message addAttributeWithName:@"type" stringValue:@"chat"];
 6     NSString *to = [NSString stringWithFormat:@"%@@example.com", user];
 7     [message addAttributeWithName:@"to" stringValue:to];
 8     [message addChild:body];
 9     [self.xmppStream sendElement:message];
10 }

七、獲取好友信息

 1 [_xmppRoster fetchRoster];//獲取好友列表
 2 //獲取到一個好友節點
 3 - (void)xmppRoster:(XMPPRoster *)sender didRecieveRosterItem:(NSXMLElement *)item
 4 //獲取無缺友列表
 5 - (void)xmppRosterDidEndPopulating:(XMPPRoster *)sender
 6 //到服務器上請求聯繫人名片信息
 7 - (void)fetchvCardTempForJID:(XMPPJID *)jid;
 8 //請求聯繫人的名片,若是數據庫有就不請求,沒有就發送名片請求
 9 - (void)fetchvCardTempForJID:(XMPPJID *)jid ignoreStorage:(BOOL)ignoreStorage;
10 //獲取聯繫人的名片,若是數據庫有就返回,沒有返回空,併到服務器上抓取
11 - (XMPPvCardTemp *)vCardTempForJID:(XMPPJID *)jid shouldFetch:(BOOL)shouldFetch;
12 //更新本身的名片信息
13 - (void)updateMyvCardTemp:(XMPPvCardTemp *)vCardTemp;
14 //獲取到一盒聯繫人的名片信息的回調
15 - (void)xmppvCardTempModule:(XMPPvCardTempModule *)vCardTempModule 
16         didReceivevCardTemp:(XMPPvCardTemp *)vCardTemp 
17                      forJID:(XMPPJID *)jid

八、添加好友

1 //name爲用戶帳號
2     - (void)XMPPAddFriendSubscribe:(NSString *)name
3     {
4         //XMPPHOST 就是服務器名,  主機名
5         XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@",name,XMPPHOST]];
6         //[presence addAttributeWithName:@"subscription" stringValue:@"好友"];
7         [xmppRoster subscribePresenceToUser:jid];
8           
9     }

九、收到添加好友的請求

 - (void)xmppRoster:(XMPPRoster *)sender didReceivePresenceSubscriptionRequest:(XMPPPresence *)presence
    {
        //取得好友狀態
        NSString *presenceType = [NSString stringWithFormat:@"%@", [presence type]]; //online/offline
        //請求的用戶
        NSString *presenceFromUser =[NSString stringWithFormat:@"%@", [[presence from] user]];
        NSLog(@"presenceType:%@",presenceType);
          
        NSLog(@"presence2:%@  sender2:%@",presence,sender);
          
        XMPPJID *jid = [XMPPJID jidWithString:presenceFromUser];
        //接收添加好友請求
        [xmppRoster acceptPresenceSubscriptionRequestFrom:jid andAddToRoster:YES];
          
    }

十、刪除好友

1 //刪除好友,name爲好友帳號
2 - (void)removeBuddy:(NSString *)name  
3 {  
4     XMPPJID *jid = [XMPPJID jidWithString:[NSString stringWithFormat:@"%@@%@",name,XMPPHOST]];  
5         
6     [self xmppRoster] removeUser:jid];  
7 }

十一、聊天室

1 XMPPJID *roomJID = [XMPPJID jidWithString:ROOM_JID];
2       
3     xmppRoom = [[XMPPRoom alloc] initWithRoomStorage:self jid:roomJID];
4       
5     [xmppRoom activate:xmppStream];
6     [xmppRoom addDelegate:self delegateQueue:dispatch_get_main_queue()];

十二、建立聊天室成功

1 - (void)xmppRoomDidCreate:(XMPPRoom *)sender
2     {
3         DDLogInfo(@"%@: %@", THIS_FILE, THIS_METHOD);
4     }

1三、加入聊天室,使用暱稱

1 [xmppRoom joinRoomUsingNickname:@"quack" history:nil];

1四、獲取聊天室信息

1 - (void)xmppRoomDidJoin:(XMPPRoom *)sender
2     {
3         [xmppRoom fetchConfigurationForm];
4         [xmppRoom fetchBanList];
5         [xmppRoom fetchMembersList];
6         [xmppRoom fetchModeratorsList];
7     }

1五、若是房間存在,會調用委託

1 // 收到禁止名單列表
2     - (void)xmppRoom:(XMPPRoom *)sender didFetchBanList:(NSArray *)items;
3     // 收到好友名單列表
4     - (void)xmppRoom:(XMPPRoom *)sender didFetchMembersList:(NSArray *)items;
5     // 收到主持人名單列表
6     - (void)xmppRoom:(XMPPRoom *)sender didFetchModeratorsList:(NSArray *)items;

若是房間不存在,調用委託

1 - (void)xmppRoom:(XMPPRoom *)sender didNotFetchBanList:(XMPPIQ *)iqError;
2     - (void)xmppRoom:(XMPPRoom *)sender didNotFetchMembersList:(XMPPIQ *)iqError;

1六、離開房間

1 [xmppRoom deactivate:xmppStream];

1七、離開聊天室

1 - (void)xmppRoomDidLeave:(XMPPRoom *)sender
2     {
3         DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
4     }

1八、新人加入羣聊

1 - (void)xmppRoom:(XMPPRoom *)sender occupantDidJoin:(XMPPJID *)occupantJID
2     {
3         DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
4     }

1九、有人退出羣聊

1 - (void)xmppRoom:(XMPPRoom *)sender occupantDidLeave:(XMPPJID *)occupantJID
2     {
3         DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
4     }

20、有人在羣裏發言

1 - (void)xmppRoom:(XMPPRoom *)sender didReceiveMessage:(XMPPMessage *)message fromOccupant:(XMPPJID *)occupantJID
2     {
3         DDLogVerbose(@"%@: %@", THIS_FILE, THIS_METHOD);
4     }

2一、消息回執

這個是XEP - 0184協議的內容

代碼實現

1 NSString *siID = [XMPPStream generateUUID];
2     //發送消息
3     XMPPMessage *message = [XMPPMessage messageWithType:@"chat" to:jid elementID:siID];
4     NSXMLElement *receipt = [NSXMLElement elementWithName:@"request" xmlns:@"urn:xmpp:receipts"];
5     [message addChild:receipt];
6     [message addBody:@"測試"];
7     [self.xmppStream sendElement:message];

收到回執請求的消息,發送回執

代碼實現

 1 - (void)xmppStream:(XMPPStream *)sender didReceiveMessage:(XMPPMessage *)message
 2     {
 3         //回執判斷
 4         NSXMLElement *request = [message elementForName:@"request"];
 5         if (request)
 6         {
 7             if ([request.xmlns isEqualToString:@"urn:xmpp:receipts"])//消息回執
 8             {
 9                 //組裝消息回執
10                 XMPPMessage *msg = [XMPPMessage messageWithType:[message attributeStringValueForName:@"type"] to:message.from elementID:[message attributeStringValueForName:@"id"]];
11                 NSXMLElement *recieved = [NSXMLElement elementWithName:@"received" xmlns:@"urn:xmpp:receipts"];
12                 [msg addChild:recieved];
13                   
14                 //發送回執
15                 [self.xmppStream sendElement:msg];
16             }
17         }else
18         {
19             NSXMLElement *received = [message elementForName:@"received"];
20             if (received)
21             {
22                 if ([received.xmlns isEqualToString:@"urn:xmpp:receipts"])//消息回執
23                 {
24                     //發送成功
25                     NSLog(@"message send success!");
26                 }  
27             }  
28         }  
29           
30         //消息處理  
31         //...  
32     }

2二、添加AutoPing

爲了監聽服務器是否有效,增長心跳監聽。用XEP-0199協議,在XMPPFraneWork框架下,封裝了XMPPAutoPing和XMPPPing兩個類均可以使用,由於XMPPAutoPing已經組合進了XMPPPing類,因此XMPPAutoPing使用起來更加方便。

//初始化並啓動ping
-(void)autoPingProxyServer:(NSString*)strProxyServer
{
    _xmppAutoPing = [[XMPPAutoPingalloc] init];
    [_xmppAutoPingactivate:_xmppStream];
    [_xmppAutoPingaddDelegate:selfdelegateQueue:  dispatch_get_main_queue()];
    _xmppAutoPing.respondsToQueries = YES;
    _xmppAutoPing.pingInterval=2;//ping 間隔時間
    if (nil != strProxyServer)
    {
       _xmppAutoPing.targetJID = [XMPPJID jidWithString: strProxyServer ];//設置ping目標服務器,若是爲nil,則監聽socketstream當前鏈接上的那個服務器
    }
}
//卸載監聽
 [_xmppAutoPing   deactivate];
  [_xmppAutoPing   removeDelegate:self];
   _xmppAutoPing = nil;
//ping XMPPAutoPingDelegate的委託方法:
- (void)xmppAutoPingDidSendPing:(XMPPAutoPing *)sender
{
    NSLog(@"- (void)xmppAutoPingDidSendPing:(XMPPAutoPing *)sender");
}
- (void)xmppAutoPingDidReceivePong:(XMPPAutoPing *)sender
{
    NSLog(@"- (void)xmppAutoPingDidReceivePong:(XMPPAutoPing *)sender");
}
   
- (void)xmppAutoPingDidTimeout:(XMPPAutoPing *)sender
{
    NSLog(@"- (void)xmppAutoPingDidTimeout:(XMPPAutoPing *)sender");
}

 

demo下載:http://download.csdn.net/detail/shaoting19910730/9178475

相關文章
相關標籤/搜索