XMPP框架微信项目开发之XMPP框架中第三方框架CocoaAsyncSocket的使用——此框架其实是对C语言输入输出流的封装

一时失言乱红尘 2022-08-10 00:53 139阅读 0赞

在上次是实现聊天室时用最基本的C语言输出输出流CFReadStreamRef和CFWriteStreamRef和OC输出/输出流，二者之间需要进行桥接转换，光连接就使用了很多行代码。另外传送数据到服务器需要使用输出流，读取数据库返回来的数据需要使用输入流。过程及其繁琐麻烦。为了解决这种情况，我们可以使用XMPP框架中使用的第三方框架CocoaAsyncSocket异步socket通信框架，此框架本质就是对C语言输入输出流的基本封装。使用了此框架我们可以以面向对象的方式直接使用GCDAsyncSocket对象进行接收或发送数据。

CocoaAsyncSocket框架的导入方法：

在XMPP框架的Vendor文件夹下直接把该框架拖进工程。需要注意的是异步Socket网络通讯需要添加CFNetwork&Security框架依赖(Xcode5.0之前)。不过在Xcode6之后就不用导入任何依赖包.

使用此框架实现聊天室的异步通讯，步骤如下：

第一步：声明一个GCDAsyncSocket类型的全局变量。GCDAsyncSocket \*\_socket;

第二步：连接到服务器。

2.0 声明服务器主机的IP地址和（服务器文件内设置连接的）端口号

NSString \*host =@"127.0.0.1";

int port =12345;

2.1 为全局变量创建一个Socket对象。使用GCDAsyncSocket的如下方法

\- (id)initWithDelegate:(id)aDelegate delegateQueue:(dispatch\_queue\_t)dq为全局变量\_socket创建一个对象。如下所示：

// 创建一个Socket对象

\_socket = \[\[GCDAsyncSocketalloc\] initWithDelegate:selfdelegateQueue:dispatch\_get\_global\_queue(0,0)\];

//连接

NSError \*error;

\[\_socketconnectToHost:host onPort:porterror:&error\];

if (error) \{

NSLog(@"%@", \[errorlocalizedDescription\]);

注意：使用全局队列为delegateQueue参数赋值，那么它的代理方法都会异步多线程执行。此对象创建完成就意味着已经成功连接到了指定的服务器，并使用当前控制器作代理对象，且代理方法都会在子线程异步并发执行。

第三步：让当前控制器遵守GCDAsyncSocketDelegate协议。

第四步：实现连接服务器成功和连接服务器失败的回调方法。

连接服务器成功会调用此回调方法。\-(void)socket:(GCDAsyncSocket \*)sock didConnectToHost:(NSString \*)host port:(uint16\_t)port

连接服务器失败或与服务器断开连接都会调用如下回调方法：

\-(void)socketDidDisconnect:(GCDAsyncSocket \*)sock withError:(NSError \*)err

第五步：实现登录。即发送登录数据到服务器，将登录字符串按指定的格式拼接并转为NSData类型数据后直接使用全局的\_socket调用writeData方法进行数据的发送。如下所示：// -1代表不超时

\[\_socketwriteData:data withTimeout:-1tag:101\];

注意：要设置Tag值便于区分数据类型（比如登录数据还是聊天数据）

第六步：实现成功发送数据到服务器的回调方法和读取服务器返回数据的回调方法，如下所示：

\-(void)socket:(GCDAsyncSocket \*)sock didWriteDataWithTag:(long)tag

\-(void)socket:(GCDAsyncSocket \*)sock didReadData:(NSData \*)data withTag:(long)tag

需要注意的是：数据发送成功后，必须在didWriteDataWithTag回调方法中自己调用一下读取数据的方法（

readDataWithTimeout）才会调用读取服务器返回数据的第二个回调方法。具体如下：

\#pragma mark 数据成功发送到服务器

\-(void)socket:(GCDAsyncSocket \*)sock didWriteDataWithTag:(long)tag

NSLog(@"数据成功发送到服务器");

// 数据发送成功后，自己调用一下读取数据的方法，接着\_socket才会调用 下面的代理方法

\[\_socketreadDataWithTimeout:-1tag:tag\];

第七步：将刷新表格的UI操作放在主线程中执行(异步获取主队列)，因为刷新表格的操作都是在读取到服务器返回数据的回调方法didReadData中执行，又因为先前创建\_socket 方法时指定了GCDAsyncSocketDelegate的回调方法都是异步开辟子线程执行。所以要异步主队列执行更新表格的操作。（更新UI的操作必须放在主线程，因为异步意味着不会立即执行，不会有立即刷新UI的效果）具体如下：

// UI 刷新要在主线程

dispatch\_async(dispatch\_get\_main\_queue(), ^\{

\[self.tableViewreloadData\];

// 数据多的时候表格应该向上滚动

// 获取表格的最后一行

NSIndexPath \*lastPath = \[NSIndexPathindexPathForRow:self.chatMsgs.count\-1inSection:0\];

//  让表格滚动到最后一行底部

\[self.tableViewscrollToRowAtIndexPath:lastPath atScrollPosition:UITableViewScrollPositionBottomanimated:YES\];

\});

第八步：发送聊天数据 。

导入框架后，使用此框架进行异步Socket聊天室通信，具体如下：

先打开本地服务器文件：

![Center][]

在原来聊天室的基础之上，进行修改，具体代码如下：

<span style="font-size:18px;"><span style="font-size:18px;">//
    //  ViewController.m
    //  聊天室
    //
    //  Created by apple on 15/11/4.
    //  Copyright (c) 2015年 LiuXun. All rights reserved.
    //
    
    #import "ViewController.h"
    #import "GCDAsyncSocket.h"
    
    @interface ViewController ()<UITextFieldDelegate,UITableViewDataSource,UITableViewDelegate, GCDAsyncSocketDelegate>
    {
        GCDAsyncSocket *_socket;
    }
    @property (weak, nonatomic) IBOutlet NSLayoutConstraint *inputViewConstraint;
    
    @property (weak, nonatomic) IBOutlet UITableView *tableView;
    
    @property(nonatomic, strong) NSMutableArray *chatMsgs; // 聊天消息数组
    
    @end
    
    @implementation ViewController
    
    -(NSMutableArray *)chatMsgs
    {
        if (_chatMsgs == nil) {
            
            _chatMsgs = [NSMutableArray array];
        }
        return _chatMsgs;
    }
    
    - (void)viewDidLoad {
        [super viewDidLoad];
        
        
        //  收发数据
        // 做一个聊天
        // 1. 用户登录
        // 2. 登录成功后即可收发数据
        
        // 监听键盘
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(kbFrmWillChange:) name:UIKeyboardWillChangeFrameNotification object:nil];
    }
    
    -(void)kbFrmWillChange:(NSNotification *)notification
    {
        NSLog(@"%@", notification.userInfo);
        
        // 获取窗口的高度
        CGFloat windowH = [UIScreen mainScreen] .bounds.size.height;
        
        // 键盘结束时的Frame
        CGRect kbEndFrm = [notification.userInfo[UIKeyboardFrameEndUserInfoKey] CGRectValue];
        
        // 获取键盘结束的y值
        CGFloat kbEndY = kbEndFrm.origin.y;
        
        
        self.inputViewConstraint.constant = windowH - kbEndY; // 键盘的高度
    }
    
    #pragma mark
    - (IBAction)connectToHost:(id)sender {
        
        // 建立连接
        NSString *host = @"127.0.0.1";
        int port = 12345;
        
        // 创建一个Socket对象
        _socket = [[GCDAsyncSocket alloc] initWithDelegate:self delegateQueue:dispatch_get_global_queue(0, 0)];
        
        // 连接
        NSError *error;
        [_socket connectToHost:host onPort:port error:&error];
        if (error) {
            NSLog(@"%@", [error localizedDescription]);
        }
        
    }
    
    #pragma mark AsyncSocket的代理
    #pragma mark 连接主机成功
    -(void)socket:(GCDAsyncSocket *)sock didConnectToHost:(NSString *)host port:(uint16_t)port
    {
        NSLog(@"连接主机成功");
    }
    
    #pragma mark 与主机断开连接
    -(void)socketDidDisconnect:(GCDAsyncSocket *)sock withError:(NSError *)err
    {
        if (err) {
            NSLog(@"%@", [err localizedDescription]);
        }
    }
    
    
    #pragma mark 用户登录
    - (IBAction)loginBtnClick:(id)sender {
        
        // 登录
        // 发送用户名和密码
        // 在这里做的时候，只发用户名，密码就不用发送
        
        // 如果要登录，发送的数据格式为 "iam:zhangsan"
        // 如果要发送聊天消息，数据格式为"msg:did you have dinner"
        
        // 登录的指令
        NSString *loginStr = @"iam:zhangsanXXXXXXX";
        
        // 把Str转化为NSData
        NSData  *data = [loginStr dataUsingEncoding:NSUTF8StringEncoding];
        
        //    [_outputStream write:data.bytes maxLength:data.length];
        // 发送登录指令到服务器
        // -1 代表不超时
        [_socket writeData:data withTimeout:-1 tag:101];
    }
    
    #pragma mark 数据成功发送到服务器
    -(void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag
    {
        NSLog(@"数据成功发送到服务器");
        // 数据发送成功后，自己调用一下读取数据的方法，接着_socket才会调用  下面的代理方法
        [_socket readDataWithTimeout:-1 tag:tag];
    }
    
    #pragma mark - 读取服服务器返回的数据  服务器有数据会调用这个方法
    -(void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag
    {
        // 从服务器接收到的数据
        NSString *reciveStr =  [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        
        NSLog(@"%@ %ld %@", reciveStr, tag, [NSThread currentThread]);
        
        if (tag == 101) {  // 登录返回的数据，不应该把数据添加到表格里
            
        }else if(tag == 102){  // 聊天返回的数据
            // 刷新表格
            [self reloadDataWithText:reciveStr];
        }
        
    }
    
    #pragma mark 实现TextField的Return键的方法
    -(BOOL)textFieldShouldReturn:(UITextField *)textField
    {
        NSString *text = textField.text;
        NSLog(@"%@", text);
        // 已知：如果要发送聊天消息，数据格式为"msg:did you have dinner"
        
        // 按服务器指定的发送内容的格式拼接字符串
        // 聊天信息
        NSString *msgStr = [NSString stringWithFormat:@"msg:%@", text];
        
        // 将msgStr转化为NSData
        NSData *data = [msgStr dataUsingEncoding:NSUTF8StringEncoding];
        
        // 刷新表格
        [self reloadDataWithText:msgStr];
        
        // 发送数据
        [_socket writeData:data withTimeout:-1 tag:102];
        
        // 发送完数据后，清空textField
        textField.text = nil;
        return YES;
    }
    
    #pragma mark 表格刷新数据
    -(void)reloadDataWithText:(NSString *)text
    {
        [self.chatMsgs addObject:text];
        
        // UI 刷新要在主线程
        dispatch_async(dispatch_get_main_queue(), ^{
            [self.tableView reloadData];
            
            // 数据多的时候表格应该向上滚动
            // 获取表格的最后一行
            NSIndexPath *lastPath = [NSIndexPath indexPathForRow:self.chatMsgs.count-1 inSection:0];
            
            //  让表格滚动到最后一行底部
            [self.tableView scrollToRowAtIndexPath:lastPath atScrollPosition:UITableViewScrollPositionBottom animated:YES];
        });
        
    }
    
    #pragma mark 表格的数据源
    -(NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section
    {
        return self.chatMsgs.count;
    }
    
    -(UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
    {
        static NSString *ID = @"Cell";
        UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:ID];
        if (!cell) {
            cell = [[UITableViewCell alloc] initWithStyle:UITableViewCellStyleSubtitle reuseIdentifier:ID];
        }
        
        cell.textLabel.text  = self.chatMsgs[indexPath.row];
        return cell;
    }
    
    #pragma mark - 表格滚动时让输入控件收回
    -(void)scrollViewWillBeginDragging:(UIScrollView *)scrollView
    {
        [self.view endEditing:YES];
    }
    - (void)didReceiveMemoryWarning {
        [super didReceiveMemoryWarning];
        // Dispose of any resources that can be recreated.
    }
    
    @end</span></span>

运行结果如下：

![Center 1][]

[Center]: /images/20220731/e73c455d1fc744b38516b2c2c3d957fa.png
[Center 1]: /images/20220731/8276bc9ee4de4f789bc4452af88251a0.png