iOS 基于Socket使用Protobuf进行数据传输

题记：

最近有需求场景涉及到数据传输，要求尝试一下Protobuf的方式，基于Socket进行传输。

那么这个Protobuf是个啥？我也是mb的，好吧，让我们看看这究竟是什么。

1.Protobuf简介：

简介：

优点：

示例分析：

message Person {
    required string name=1;
    required int32 id=2;
    optional string email=3;


    enum PhoneType {
        MOBILE=0;
        HOME=1;
        WORK=2;
    }


    message PhoneNumber {
        required string number=1;
        optional PhoneType type=2 [default=HOME];
    }


    repeated PhoneNumber phone=4;
    optional string surname = 5;
}

message AddressBook {
  repeated Person person = 1;
}

message Test {
  repeated string person = 2;
}

语法指南：

message SearchRequest {
  required string query = 1;
  optional int32 page_number = 2;
  optional int32 result_per_page = 3;
}

repeated int32 samples = 4 [packed=true];

message SearchRequest {
  required string query = 1;
  optional int32 page_number = 2;
  optional int32 result_per_page = 3 [default = 10];
  enum Corpus {
    UNIVERSAL = 0;
    WEB = 1;
    IMAGES = 2;
    LOCAL = 3;
    NEWS = 4;
    PRODUCTS = 5;
    VIDEO = 6;
  }
  optional Corpus corpus = 4 [default = UNIVERSAL];
}

message SearchResponse {
  repeated Result result = 1;
}
message Result {
  required string url = 1;
  optional string title = 2;
  repeated string snippets = 3;
}

message SearchResponse {
  message Result {
    required string url = 1;
    optional string title = 2;
    repeated string snippets = 3;
  }
  repeated Result result = 1;
}

message SomeOtherMessage {
  optional SearchResponse.Result result = 1;
}

extend Foo {
  optional int32 bar = 126;
}

Foo foo;
foo.SetExtension(bar, 15);

message Baz {
  extend Foo {
    optional int32 bar = 126;
  }
  ...
}

Foo foo;
foo.SetExtension(Baz::bar, 15);

message Foo {
  extensions 1000 to max;
}

message SampleMessage {
  oneof test_oneof {
     string name = 4;
     SubMessage sub_message = 9;
  }
}

SampleMessage message;
message.set_name(“name”);
CHECK(message.has_name());
message.mutable_sub_message();   // Will clear name field.
CHECK(!message.has_name());

SampleMessage message;
SubMessage* sub_message = message.mutable_sub_message();
message.set_name(“name”);      // Will delete sub_message
sub_message.set_…              // Crashes here

SampleMessage msg1;
msg1.set_name(“name”);
SampleMessage msg2;
msg2.mutable_sub_message();
msg1.swap(&msg2);
CHECK(msg1.has_sub_message());
CHECK(msg2.has_name());

2.Protobuf安装：

具体的安装步骤：

package cn.pio.protocol.protobuf;
option java_package = "cn.pio.protocol.protobuf";
//option java_multiple_files = true;
//类型
enum DeviceType {
	OTHER_DEVICE = 1;	//
	PC = 2;             //PC
	ANDROID = 3;        //安卓
	IOS = 4;            //IOS
	WEB = 5;            //WEB
	TERMINAL = 6 ;		//终端机
	SERVER = 9;			//server reply
}

enum PacketType {
	CHAT = 1;			//单聊消息，指定to为个人id
	GROUP_CHAT = 2 ;	//群聊消息，指定to为群id
	COMMAND = 3 ;		//命令，请求或者设置
	PRESENCE = 4;		//状态
	ERROR = 5 ;			//错误消息，更多指服务器返回的错误提示
}

message Packet {
	required Header header = 1;				//消息id
	optional string body = 2;				//消息内容
}

message Header	 {
	required string pid = 1;				//消息id
	optional string from = 2;				//发送者jie,如果是server则无from
	optional string to = 3;					//接受者用户id
	required DeviceType deviceType = 4;		//发送者设备类型
 	optional int64 time = 5;				//时间
 	required PacketType packetType = 6 ;	//消息类型
 	required int32 packetCode = 7 ;			//消息编码,指定消息类型下的唯一编码值
 	optional string domain = 8 ;			//服务域名号
}



 	

3.Protobuf在OC中的使用：

        Header * header = [[Header alloc]init];
        header.pid = @"1_pid";
        header.from = @"1_from";
        header.to = @"1_to";
        header.deviceType = DeviceType_Ios;
        header.time = [NSDate date].timeIntervalSince1970;
        header.packetType = PacketType_Chat;
        header.packetCode = 1;
        header.domain = @"com.senyint.flower";
        
        Packet * packet = [[Packet alloc]init];
        packet.header = header;
        packet.body = @"这是flower的第一条测试消息，用于测试protobuf的使用。";

4.Socket简介及在OC中的使用：

5.使用Socket发送protobuf格式定义的数据：

这里使用的是CocoaAsyncSocket这个第三方库，直接将操作的Code贴在下边了，代码已经很明了了：

//
//  ViewController.m
//  HDMOCSocketProject
//
//  Created by 花强 on 2017/7/4.
//  Copyright © 2017年 花强. All rights reserved.
//

#import "ViewController.h"
#import "CocoaAsyncSocket.h"
#import "GCDAsyncSocket.h"

#import "Person.pbobjc.h"
#import "Chat.pbobjc.h"

@interface ViewController ()<GCDAsyncSocketDelegate>

@property (nonatomic , strong) GCDAsyncSocket * socket;

@property (nonatomic , strong) UILabel * labelShow;

@property (nonatomic , strong) UIButton * buttonConnect;
@property (nonatomic , strong) UIButton * buttonSend;
@property (nonatomic , strong) UIButton * buttonDisconnect;

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    
    /*
     socket（套接字）是通信的基石，是支持TCP/IP协议的网络通信的基本操作单元，包含进行网络通信必须的五种信息：连接使用的协议，本地主机的IP地址，本地进程的协议端口，远地主机的IP地址，远地进程的协议端口。
     
     建立Socket连接至少需要一对套接字，其中一个运行于客户端，称为ClientSocket，另一个运行于服务器端，称为ServerSocket。套接字之间的连接过程分为三个步骤：服务器监听，客户端请求，连接确认。
     
     Socket可以支持不同的传输层协议（TCP或UDP），当使用TCP协议进行连接时，该Socket连接就是一个TCP连接,UDP连接同理。
     
     建立起一个TCP连接需要经过“三次握手”：
     
     第一次握手：客户端发送syn包(syn=j)到服务器，并进入SYN_SEND状态，等待服务器确认；
     
     第二次握手：服务器收到syn包，必须确认客户的SYN（ack=j+1），同时自己也发送一个SYN包（syn=k），即SYN+ACK包，此时服务器进入SYN_RECV状态；
     
     第三次握手：客户端收到服务器的SYN＋ACK包，向服务器发送确认包ACK(ack=k+1)，此包发送完毕，客户端和服务器进入ESTABLISHED状态，完成三次握手。
     
     三次握手(Three-way Handshake)即建立一个TCP连接时，需要客户端和服务器总共发送3个包。三次握手的目的是连接服务器指定端口，建立TCP连接,并同步连接双方的序列号和确认号并交换TCP 窗口大小信息。在socket编程中，客户端执行connect()时,将触发三次握手。
     */
    [self.labelShow setFrame:CGRectMake(10, 20, 200, 100)];
    [self.view addSubview:self.labelShow];
    
    [self.buttonConnect setFrame:CGRectMake(10, 140, 100, 30)];
    [self.view addSubview:self.buttonConnect];
    
    [self.buttonSend setFrame:CGRectMake(10, 180, 100, 30)];
    [self.view addSubview:self.buttonSend];
    
    [self.buttonDisconnect setFrame:CGRectMake(10, 220, 100, 30)];
    [self.view addSubview:self.buttonDisconnect];
    
    [self startClientSocket];
    
}

-(void)startClientSocket{
    
    //创建Socket
    self.socket = [[GCDAsyncSocket alloc] initWithDelegate:self delegateQueue:dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0)];
}
-(void)connectSocket{
    if (!self.socket.isConnected) {
        NSString * host = @"43.241.229.134";
        int port = 24678;
        //链接
        NSError * error = nil;
        [_socket connectToHost:host onPort:port withTimeout:15 error:&error];
        if (error) {
            NSLog(@"%@",error);
            return;
        }
    }
}
-(void)sendMessageSocketWithMessage:(NSString *)msg{
    if (self.socket.isConnected) {
        /*
        Person *person = [[Person alloc] init];
        person.id_p = 111;
        person.username = @"test";
        person.phone = @"111111";
        NSData * data = [person data];
        Person *p = [Person parseFromData:data error:nil];
        NSLog(@"person:%@",p);
        
        //    NSData * data1 = [msg dataUsingEncoding:NSUTF8StringEncoding];
        [self.socket writeData:data withTimeout:15 tag:0];
         */
        Header * header = [[Header alloc]init];
        header.pid = @"1_pid";
        header.from = @"1_from";
        header.to = @"1_to";
        header.deviceType = DeviceType_Ios;
        header.time = [NSDate date].timeIntervalSince1970;
        header.packetType = PacketType_Chat;
        header.packetCode = 1;
        header.domain = @"com.senyint.flower";
        
        Packet * packet = [[Packet alloc]init];
        packet.header = header;
        packet.body = @"这是flower的第一条测试消息，用于测试protobuf的使用。";
     
        [self.socket writeData:[packet data] withTimeout:15 tag:1];
        
        self.labelShow.text = packet.body;
    }
}
-(void)disconnectSocket{
    if (self.socket.isConnected) {
        [self.socket disconnect];
    }
}

#pragma mark -
//链接成功
-(void)socket:(GCDAsyncSocket *)sock didConnectToHost:(NSString *)host port:(uint16_t)port{
    NSLog(@"%s",__func__);
    NSLog(@"链接成功");
}
//链接失败
-(void)socketDidDisconnect:(GCDAsyncSocket *)sock withError:(NSError *)err{
    if (err) {
        NSLog(@"连接失败");
    }else{
        NSLog(@"正常断开");
    }
}
//发送数据成功
-(void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag{
    NSLog(@"%s",__func__);
    //发送完数据循环读取，-1不设置超时
    [sock readDataWithTimeout:-1 tag:tag];
}
//读取数据
-(void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag{
    NSString * receiveStr = [[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding];
    NSLog(@"%s %@",__func__,receiveStr);
    
    [self.labelShow setText:[NSString stringWithFormat:@"%@ %@",self.labelShow.text,receiveStr]];
}



- (void)didReceiveMemoryWarning {
    [super didReceiveMemoryWarning];
    // Dispose of any resources that can be recreated.
}

-(void)buttonAction:(UIButton *)button{
    switch (button.tag) {
        case 1:
            //链接
            [self connectSocket];
            break;
        case 2:
            //发送
            [self sendMessageSocketWithMessage:self.labelShow.text];
            break;
        case 3:
            //断开
            [self disconnectSocket];
            break;
        default:
            break;
    }
}

-(UILabel *)labelShow{
    if (_labelShow == nil) {
        _labelShow = [[UILabel alloc]init];
        [_labelShow setText:@"Message"];
        [_labelShow setTextColor:[UIColor blueColor]];
        [_labelShow setTextAlignment:NSTextAlignmentLeft];
        [_labelShow setFont:[UIFont systemFontOfSize:14]];
        _labelShow.numberOfLines = 0;
    }
    return _labelShow;
}

-(UIButton *)buttonConnect{
    if (_buttonConnect == nil) {
        _buttonConnect = [UIButton buttonWithType:UIButtonTypeCustom];
        [_buttonConnect setBackgroundColor:[UIColor redColor]];
        [_buttonConnect setTitle:@"链接" forState:UIControlStateNormal];
        [_buttonConnect addTarget:self action:@selector(buttonAction:) forControlEvents:UIControlEventTouchUpInside];
        _buttonConnect.tag = 1;
    }
    return _buttonConnect;
}
-(UIButton *)buttonSend{
    if (_buttonSend == nil) {
        _buttonSend = [UIButton buttonWithType:UIButtonTypeCustom];
        [_buttonSend setBackgroundColor:[UIColor redColor]];
        [_buttonSend setTitle:@"发送" forState:UIControlStateNormal];
        [_buttonSend addTarget:self action:@selector(buttonAction:) forControlEvents:UIControlEventTouchUpInside];
        _buttonSend.tag = 2;
    }
    return _buttonSend;
}
-(UIButton *)buttonDisconnect{
    if (_buttonDisconnect == nil) {
        _buttonDisconnect = [UIButton buttonWithType:UIButtonTypeCustom];
        [_buttonDisconnect setBackgroundColor:[UIColor redColor]];
        [_buttonDisconnect setTitle:@"断开" forState:UIControlStateNormal];
        [_buttonDisconnect addTarget:self action:@selector(buttonAction:) forControlEvents:UIControlEventTouchUpInside];
        _buttonDisconnect.tag = 3;
    }
    return _buttonDisconnect;
}

@end

这里socket另一端返回的数据还未测通，待调试之后，将内容补充完整。

总结

网络一直都是核心，有关网络通讯的内容需要我们深入的学习，二十七八岁的年纪，加油！