Websocket协议之SocketRocket的使用

简介

WebSocket 规范定义了一种 API,可在网络浏览器和服务器之间建立“套接字”连接。

SocketRocketfacebook的开源框架,使在iOS,MAC,TV端使用WebSocket技术成为可能。

前期准备

编译工具:xcode8.2.1
语言:swift3.1
系统环境:Mac OS

客户端

创建一个iOS工程

image.png

引入SocketRocket库

使用pod集成SocketRocket库。

不详细介绍,不了解的请参考文章在swift调用OC的第三方库

集成完毕项目结合如下图:

image.png

API分析

SocketRocket暴露的接口并不多

首先看属性:

//设置代理
@property (nonatomic, weak) id <SRWebSocketDelegate> delegate;

//只读,当前处于的状态
typedef NS_ENUM(NSInteger, SRReadyState) {
    SR_CONNECTING   = 0,   连接状态
    SR_OPEN         = 1,   打开状态
    SR_CLOSING      = 2,  正在关闭状态
    SR_CLOSED       = 3,  已经关闭状态
};
@property (nonatomic, readonly) SRReadyState readyState;

//只读,连接的URL
@property (nonatomic, readonly, retain) NSURL *url;

//只读,接收到的http头
@property (nonatomic, readonly) CFHTTPMessageRef receivedHTTPHeaders;

// 设置requestCookies,Web 服务器就可以使用这些信息来识别不同的用户
@property (nonatomic, readwrite) NSArray * requestCookies;

初始化方法:

通过NSURLRequest进行初始化:

-(id)initWithURLRequest:(NSURLRequest *)request protocols:(NSArray *)protocols allowsUntrustedSSLCertificates:(BOOL)allowsUntrustedSSLCertificates;
-(id)initWithURLRequest:(NSURLRequest *)request protocols:(NSArray *)protocols;
-(id)initWithURLRequest:(NSURLRequest *)request;

通过NSURL进行初始化

-(id)initWithURL:(NSURL *)url protocols:(NSArray *)protocols allowsUntrustedSSLCertificates:(BOOL)allowsUntrustedSSLCertificates;
-(id)initWithURL:(NSURL *)url protocols:(NSArray *)protocols;
-(id)initWithURL:(NSURL *)url;

设置线程

//默认为主队列,两个方法不能同时使用
- (void)setDelegateOperationQueue:(NSOperationQueue*) queue;
- (void)setDelegateDispatchQueue:(dispatch_queue_t) queue;

开启关闭:

//打开连接,只能执行一次
- (void)open;
//关闭连接
- (void)close;
 //关闭原因和code
- (void)closeWithCode:(NSInteger)code reason:(NSString *)reason;
// 发送消息给服务器(允许UTF8字符串或者Data)
- (void)send:(id)data;
//发送一个心跳消息ping,可以为参数可以为nil(用来确定客户端未丢失。)
- (void)sendPing:(NSData *)data;

协议:

//当使用open的时候,如果连接成功回调
- (void)webSocketDidOpen:(SRWebSocket *)webSocket;
//当服务器拒绝,或者发生错误的时候回调
- (void)webSocket:(SRWebSocket *)webSocket didFailWithError:(NSError *)error;
//服务器关闭的时候回调
- (void)webSocket:(SRWebSocket *)webSocket didCloseWithCode:(NSInteger)code reason:(NSString *)reason wasClean:(BOOL)wasClean;
//服务器心跳回调
- (void)webSocket:(SRWebSocket *)webSocket didReceivePong:(NSData *)pongPayload;
// 当为yes,则将data转为string,no的时候不进行转换。
- (BOOL)webSocketShouldConvertTextFrameToString:(SRWebSocket *)webSocket;

写一个简单小Demows://echo.websocket.org地址可以免费查看你的Demo是否已经正常,返回值为发送的值

class ViewController: UIViewController, SRWebSocketDelegate {
    @IBOutlet weak var msgTextField: UITextField!
    @IBOutlet weak var receiveLable: UILabel!
    private var websocket: SRWebSocket?
    override func viewDidLoad() {
        super.viewDidLoad()
    }
    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)
        self.reConnect()
    }
    @IBAction func sendMsgBtn(_ sender: Any) {
        self.view.endEditing(true)
        if let websoc = websocket {
            websoc.send(self.msgTextField.text!)
        }
    }
    private func reConnect() {
        websocket?.delegate = nil
        websocket?.close()
        websocket = nil
        websocket = SRWebSocket.init(urlRequest: URLRequest.init(url: URL.init(string: "ws://echo.websocket.org")!))
        websocket?.delegate = self as SRWebSocketDelegate
        websocket?.open()
    }
    override func viewDidDisappear(_ animated: Bool) {
        super.viewDidDisappear(animated)
        websocket?.delegate = nil
        websocket?.close()
        websocket = nil
    }
    // Implement agent
    public func webSocket(_ webSocket: SRWebSocket!, didReceiveMessage message: Any!) {
        if webSocket.readyState == .OPEN {
            self.receiveLable.text = message as? String
        }
    }
    func webSocket(_ webSocket: SRWebSocket!, didFailWithError error: Error!) {
        print("\(error!.localizedDescription)")
    }
    func webSocketDidOpen(_ webSocket: SRWebSocket!) {
        print("连接成功!")
    }
    func webSocket(_ webSocket: SRWebSocket!, didCloseWithCode code: Int, reason: String!, wasClean: Bool) {
        print("连接关闭")
        websocket = nil
    }
    func webSocket(_ webSocket: SRWebSocket!, didReceivePong pongPayload: Data!) {
    }
    @IBAction func closeSocketBtn(_ sender: Any) {
        websocket?.delegate = nil
        websocket?.close()
        websocket = nil
    }
}

服务器

上面使用的是一个简单的测试服务器,接下来我们自己搭建一个服务器用于有趣的测试。

使用node搭建一个自己的Websocket服务器

系统环境:Mac OS

①使用brew install node安装node

②创建一个自定义的文件夹,并且cd进入本文件夹,使用命令行npm install ws,npm install node-uuid创建两个模块作为依赖。

image.png

这边出现的WARN不需要处理,也可以先npm init来初始化,生成一个package.json,不过本示例不需要。

创建一个文件,命名为server_test.js

写一段简单的服务器Demo,实现将前端传来的数据传回。

//导入ws模块
var webSocketServer = require('ws').Server
//用端口初始化一个对象
wss = new webSocketServer({port: 8181})
//连接中进行的操作
wss.on('connection', function (ws) {
    console.log("client connected!")
    ws.on("message", function (message) {
        console.log(message)
        ws.send(message)
    })
})

启动node服务器

//  /Users/nttdata/Desktop/Server/server_test.js是js路劲,开启后不要关闭命令行工具
node /Users/nttdata/Desktop/Server/server_test.js

测试一下前后端是否畅通,请看图:

image.png

OK!

附上iOS端项目和服务器端简单的项目,以供参考!有误请留言,谢谢!

项目地址

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,406评论 5 475
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,976评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,302评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,366评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,372评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,457评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,872评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,521评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,717评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,523评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,590评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,299评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,859评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,883评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,127评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,760评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,290评论 2 342

推荐阅读更多精彩内容