因为我们公司是做大宗商品贸易的,有很多的行情数据,主要就是K线和分时两块儿的业务。由于后端的技术选型是socket.io,所以我们iOS就是要接入socket.io-client-swift,这个是swift版本的,OC版本的由于很久没有维护,所以我们没有采用。socket.io-client-swift接入的时候用可以是swift项目,也可以是OC项目(通过桥接来完成)。
1.接入
pod 'Socket.IO-Client-Swift'
2.具体使用
//属性声明
@property (nonatomic, strong) SocketManager *manger;
@property (nonatomic, strong) SocketIOClient *socket;
- (SocketManager *)manger {
if (!_manger) {
NSString *url = @"";//后端约定的URL,connectParams是后端约定的自定义参数
NSDictionary *paramDict = @{@"log": @YES,
@"compress": @YES ,
@"connectParams":@{@"":@""}
};
_manger = [[SocketManager alloc] initWithSocketURL:[NSURL URLWithString:url] config:paramDict];
}
return _manger;
}
- (SocketIOClient *)socket {
if (!_socket) {
_socket = [self.manger socketForNamespace:@""];//传入约定好的命名空间
//_socket = self.manger.defaultSocket; //如果没有区分命名空间的话,可以去默认的socket
}
return _socket;
}
3.方法回调,声明完成之后,注册回调方法;都是一些on方法回调,有socket-io自己的,也可以有和服务端约定好的。
- (void)addHanders {
[self.socket on:@"connect" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"connect:%@",dataArray);
}];
[self.socket on:@"stream" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"joinInit" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"connecting" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"connect_failed" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"error" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"anything" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"reconnect_failed" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"reconnect" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"reconnecting" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
[self.socket on:@"disconnect" callback:^(NSArray * _Nonnull dataArray, SocketAckEmitter * _Nonnull emitter) {
NSLog(@"%@",dataArray);
}];
}
4.通知服务端,通知服务端就是emit方法来调用,整个交互思路,其实跟webview和app的交互一样
[self.socket emit:@"方法名" with:@[@"参数"]];
5.config主要配置参数
case ConnectParams([String: AnyObject]) // 通过字典内容连接
case Cookies([NSHTTPCookie]) // An array of NSHTTPCookies. Passed during the handshake. Default is nil.
case DoubleEncodeUTF8(Bool) // Whether or not to double encode utf8. If using the node based server this should be true. Default is true.
case ExtraHeaders([String: String]) // 添加自定义请求头初始化来请求, 默认为nil
case ForcePolling(Bool) // 是否使用 xhr-polling. Default is `false`
case ForceNew(Bool) // 将为每个连接创建一个新的connect, 如果你在重新连接时有bug时使用.
case ForceWebsockets(Bool) // 是否使用 WebSockets. Default is `false`
case HandleQueue(dispatch_queue_t) // 调度handle的运行队列. Default is the main queue.
case Log(Bool) // 是否打印调试信息. Default is false.
case Logger(SocketLogger) // 可自定义SocketLogger调试日志.默认是系统的.
case Nsp(String) // 如果使用命名空间连接. Must begin with /. Default is `/`
case Path(String) // 如果服务器使用一个自定义路径. 例如: `"/swift/"`. Default is `""`
case Reconnects(Bool) // 是否重新连接服务器失败. Default is `true`
case ReconnectAttempts(Int) // 重新连接多少次. Default is `-1` (无限次)
case ReconnectWait(Int) // 等待重连时间. Default is `10`
case SessionDelegate(NSURLSessionDelegate) // NSURLSessionDelegate 底层引擎设置. 如果你需要处理自签名证书. Default is nil.
6.关于socket连接不上的问题,最近公司的项目会出现socket连接不上的问题,然后android看起来是正常的,在排查过程中发现是因为服务端的配置问题,超时时间设的太长引起的。这个地方比较坑的是socket的枚举状态显示的是已连接,然而服务端数据并没有推送过来,等超时时间已过,会重新连接,大家调试时记得打开日志,方便定位问题。服务端的参数配置大家可以看下官方API
pingInterval: 10000, //看一下这两个参数的配置,socket的重连时长是由这两个参数来决定的。
pingTimeout: 5000,
7.socket断开之后出现闪退问题,socket网络断开之后再次重连时会出现闪退问题,崩溃在SocketStringReader的read方法里,看起来是一个包数据不完整引起的,实际上问题还是要检查一下服务端的参数配置,我们的transports只支持了websocket,没有支持http long polling,这个时候客户端要强制使用websocket协议,ForceWebsockets的参数设为true即可解决问题。
总结,有一个踩得坑是在socket建立之后,我们收到了connect回调,但是我们发起emit事件的时候,一直失败;这边的调试思路是把log打开,打开位置在创建manger的getter方法里,根据log查到可能是命名空间的问题,然后重新用另一种方法来初始化了socket。socket链接的简单过程就是这样,欢迎大家补充讨论!