天天看点

go的websocket实现握手阶段数据传输实例后话

websocket分为握手和数据传输阶段,即进行了http握手 + 双工的tcp连接

握手阶段就是普通的http

客户端发送消息:

1

2

3

4

5

6

7

<code>get /chat http/1.1</code>

<code>    </code><code>host: server.example.com</code>

<code>    </code><code>upgrade: websocket</code>

<code>    </code><code>connection: upgrade</code>

<code>    </code><code>sec-websocket-key: dghlihnhbxbszsbub25jzq==</code>

<code>    </code><code>origin: http:</code><code>//example.com</code>

<code>    </code><code>sec-websocket-version: 13</code>

服务端返回消息:

<code>http/1.1 101 switching protocols</code>

<code>upgrade: websocket</code>

<code>connection: upgrade</code>

<code>sec-websocket-accept: s3pplmbitxaq9kygzzhzrbk+xoo=</code>

这里的sec-websocket-accept的计算方法是:

base64(hsa1(sec-websocket-key + 258eafa5-e914-47da-95ca-c5ab0dc85b11))

如果这个sec-websocket-accept计算错误浏览器会提示:

sec-websocket-accept dismatch

如果返回成功,websocket就会回调onopen事件

websocket的数据传输使用的协议是:

go的websocket实现握手阶段数据传输实例后话

fin:1位,用来表明这是一个消息的最后的消息片断,当然第一个消息片断也可能是最后的一个消息片断;

rsv1, rsv2, rsv3: 分别都是1位,如果双方之间没有约定自定义协议,那么这几位的值都必须为0,否则必须断掉websocket连接;

opcode:4位操作码,定义有效负载数据,如果收到了一个未知的操作码,连接也必须断掉,以下是定义的操作码: 

      *  %x0 表示连续消息片断 

      *  %x1 表示文本消息片断 

      *  %x2 表未二进制消息片断 

      *  %x3-7 为将来的非控制消息片断保留的操作码 

      *  %x8 表示连接关闭 

      *  %x9 表示心跳检查的ping 

      *  %xa 表示心跳检查的pong 

      *  %xb-f 为将来的控制消息片断的保留操作码

mask:1位,定义传输的数据是否有加掩码,如果设置为1,掩码键必须放在masking-key区域,客户端发送给服务端的所有消息,此位的值都是1;

payload length: 传输数据的长度,以字节的形式表示:7位、7+16位、或者7+64位。如果这个值以字节表示是0-125这个范围,那这个值就表示传输数据的长度;如果这个值是126,则随后的两个字节表示的是一个16进制无符号数,用来表示传输数据的长度;如果这个值是127,则随后的是8个字节表示的一个64位无符合数,这个数用来表示传输数据的长度。多字节长度的数量是以网络字节的顺序表示。负载数据的长度为扩展数据及应用数据之和,扩展数据的长度可能为0,因而此时负载数据的长度就为应用数据的长度。

masking-key:0或4个字节,客户端发送给服务端的数据,都是通过内嵌的一个32位值作为掩码的;掩码键只有在掩码位设置为1的时候存在。 

payload data: (x+y)位,负载数据为扩展数据及应用数据长度之和。 

extension data:x位,如果客户端与服务端之间没有特殊约定,那么扩展数据的长度始终为0,任何的扩展都必须指定扩展数据的长度,或者长度的计算方式,以及在握手时如何确定正确的握手方式。如果存在扩展数据,则扩展数据就会包括在负载数据的长度之内。

application data:y位,任意的应用数据,放在扩展数据之后,应用数据的长度=负载数据的长度-扩展数据的长度。

具体使用go的实现例子:

html:

8

9

10

11

<code>&lt;html&gt;</code>

<code>    </code><code>&lt;head&gt;</code>

<code>        </code><code>&lt;script type=</code><code>"text/javascript"</code> <code>src=</code><code>"./jquery.min.js"</code><code>&gt;&lt;/script&gt;</code>

<code>    </code><code>&lt;/head&gt;</code>

<code>    </code><code>&lt;body&gt;</code>

<code>        </code><code>&lt;input type=</code><code>"button"</code> <code>id=</code><code>"connect"</code> <code>value=</code><code>"websocket connect"</code> <code>/&gt;</code>

<code>        </code><code>&lt;input type=</code><code>"button"</code> <code>id=</code><code>"send"</code> <code>value=</code><code>"websocket send"</code> <code>/&gt;</code>

<code>        </code><code>&lt;input type=</code><code>"button"</code> <code>id=</code><code>"close"</code> <code>value=</code><code>"websocket close"</code> <code>/&gt;</code>

<code>    </code><code>&lt;/body&gt;</code>

<code>    </code><code>&lt;script type=</code><code>"text/javascript"</code> <code>src=</code><code>"./websocket.js"</code><code>&gt;&lt;/script&gt;</code>

<code>&lt;/html&gt;</code>

js:

12

13

14

15

16

17

18

19

20

21

22

23

24

25

<code>var</code> <code>socket;</code>

<code>$(</code><code>"#connect"</code><code>).click(</code><code>function</code><code>(event){</code>

<code>    </code><code>socket.onopen =</code><code>function</code><code>(){</code>

<code>        </code><code>alert(</code><code>"socket has been opened"</code><code>);</code>

<code>    </code><code>}</code>

<code>    </code><code>socket.onmessage =</code><code>function</code><code>(msg){</code>

<code>        </code><code>alert(msg.data);</code>

<code>    </code><code>socket.onclose =</code><code>function</code><code>() {</code>

<code>        </code><code>alert(</code><code>"socket has been closed"</code><code>);</code>

<code>});</code>

<code>$(</code><code>"#send"</code><code>).click(</code><code>function</code><code>(event){</code>

<code>    </code><code>socket.send(</code><code>"send from client"</code><code>);</code>

<code>$(</code><code>"#close"</code><code>).click(</code><code>function</code><code>(event){</code>

<code>    </code><code>socket.close();</code>

<code>})</code>

服务端:

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

<code>package main</code>

<code>import(</code>

<code>    </code><code>"net"</code>

<code>    </code><code>"log"</code>

<code>    </code><code>"strings"</code>

<code>    </code><code>"crypto/sha1"</code>

<code>    </code><code>"io"</code>

<code>    </code><code>"encoding/base64"</code>

<code>    </code><code>"errors"</code>

<code>)</code>

<code>func main() {</code>

<code>    </code><code>ln, err := net.listen(</code><code>"tcp"</code><code>,</code><code>":8000"</code><code>)</code>

<code>    </code><code>if</code> <code>err != nil {</code>

<code>        </code><code>log.panic(err)</code>

<code>    </code><code>for</code> <code>{</code>

<code>        </code><code>conn, err := ln.accept()</code>

<code>        </code><code>if</code> <code>err != nil {</code>

<code>            </code><code>log.println(</code><code>"accept err:"</code><code>, err)</code>

<code>        </code><code>}</code>

<code>        </code><code>for</code> <code>{</code>

<code>            </code><code>handleconnection(conn)</code>

<code>}</code>

<code>func handleconnection(conn net.conn) {</code>

<code>    </code><code>content := make([]byte, 1024)</code>

<code>    </code><code>_, err := conn.read(content)</code>

<code>    </code><code>log.println(string(content))</code>

<code>        </code><code>log.println(err)</code>

<code>    </code><code>ishttp := false</code>

<code>    </code><code>// 先暂时这么判断</code>

<code>    </code><code>if</code> <code>string(content[0:3]) ==</code><code>"get"</code> <code>{</code>

<code>        </code><code>ishttp = true;</code>

<code>    </code><code>log.println(</code><code>"ishttp:"</code><code>, ishttp)</code>

<code>    </code><code>if</code> <code>ishttp {</code>

<code>        </code><code>headers := parsehandshake(string(content))</code>

<code>        </code><code>log.println(</code><code>"headers"</code><code>, headers)</code>

<code>        </code><code>secwebsocketkey := headers[</code><code>"sec-websocket-key"</code><code>]</code>

<code>        </code><code>// note:这里省略其他的验证</code>

<code>        </code><code>guid :=</code><code>"258eafa5-e914-47da-95ca-c5ab0dc85b11"</code>

<code>        </code><code>// 计算sec-websocket-accept</code>

<code>        </code><code>h := sha1.new()</code>

<code>        </code><code>log.println(</code><code>"accept raw:"</code><code>, secwebsocketkey + guid)</code>

<code>        </code><code>io.writestring(h, secwebsocketkey + guid)</code>

<code>        </code><code>accept := make([]byte, 28)</code>

<code>        </code><code>base64.stdencoding.encode(accept, h.sum(nil))</code>

<code>        </code><code>log.println(string(accept))</code>

<code>        </code><code>response :=</code><code>"http/1.1 101 switching protocols\r\n"</code>

<code>        </code><code>response = response +</code><code>"sec-websocket-accept: "</code> <code>+ string(accept) +</code><code>"\r\n"</code>

<code>        </code><code>response = response +</code><code>"connection: upgrade\r\n"</code>

<code>        </code><code>response = response +</code><code>"upgrade: websocket\r\n\r\n"</code>

<code>        </code> 

<code>            </code> 

<code>        </code><code>log.println(</code><code>"response:"</code><code>, response)</code>

<code>        </code><code>if</code> <code>lenth, err := conn.write([]byte(response)); err != nil {</code>

<code>            </code><code>log.println(err)</code>

<code>        </code><code>}</code><code>else</code> <code>{</code>

<code>            </code><code>log.println(</code><code>"send len:"</code><code>, lenth)</code>

<code>        </code><code>wssocket := newwssocket(conn)</code>

<code>            </code><code>data, err := wssocket.readiframe()</code>

<code>            </code><code>if</code> <code>err != nil {</code>

<code>                </code><code>log.println(</code><code>"readiframe err:"</code> <code>, err)</code>

<code>            </code><code>}</code>

<code>            </code><code>log.println(</code><code>"read data:"</code><code>, string(data))</code>

<code>            </code><code>err = wssocket.sendiframe([]byte(</code><code>"good"</code><code>))</code>

<code>                </code><code>log.println(</code><code>"sendiframe err:"</code> <code>, err)</code>

<code>            </code><code>log.println(</code><code>"send data"</code><code>)</code>

<code>    </code><code>}</code><code>else</code> <code>{</code>

<code>        </code><code>log.println(string(content))</code>

<code>        </code><code>// 直接读取</code>

<code>type wssocket struct {</code>

<code>    </code><code>maskingkey []byte</code>

<code>    </code><code>conn net.conn</code>

<code>func newwssocket(conn net.conn) *wssocket {</code>

<code>    </code><code>return</code> <code>&amp;wssocket{conn: conn}</code>

<code>func (this *wssocket)sendiframe(data []byte) error {</code>

<code>    </code><code>// 这里只处理data长度&lt;125的</code>

<code>    </code><code>if</code> <code>len(data) &gt;= 125 {</code>

<code>        </code><code>return</code> <code>errors.new(</code><code>"send iframe data error"</code><code>)</code>

<code>    </code><code>lenth := len(data)</code>

<code>    </code><code>maskeddata := make([]byte, lenth)</code>

<code>    </code><code>for</code> <code>i := 0; i &lt; lenth; i++ {</code>

<code>        </code><code>if</code> <code>this.maskingkey != nil {</code>

<code>            </code><code>maskeddata[i] = data[i] ^ this.maskingkey[i % 4]</code>

<code>            </code><code>maskeddata[i] = data[i]</code>

<code>    </code><code>this.conn.write([]byte{0x81})</code>

<code>    </code><code>var</code> <code>paylenbyte byte</code>

<code>    </code><code>if</code> <code>this.maskingkey != nil &amp;&amp; len(this.maskingkey) != 4 {</code>

<code>        </code><code>paylenbyte = byte(0x80) | byte(lenth)</code>

<code>        </code><code>this.conn.write([]byte{paylenbyte})</code>

<code>        </code><code>this.conn.write(this.maskingkey)</code>

<code>        </code><code>paylenbyte = byte(0x00) | byte(lenth)</code>

<code>    </code><code>this.conn.write(data)</code>

<code>    </code><code>return</code> <code>nil</code>

<code>func (this *wssocket)readiframe() (data []byte, err error){</code>

<code>    </code><code>err = nil</code>

<code>    </code><code>//第一个字节:fin + rsv1-3 + opcode</code>

<code>    </code><code>opcodebyte := make([]byte, 1)</code>

<code>    </code><code>this.conn.read(opcodebyte)</code>

<code>    </code><code>fin := opcodebyte[0] &gt;&gt; 7</code>

<code>    </code><code>rsv1 := opcodebyte[0] &gt;&gt; 6 &amp; 1</code>

<code>    </code><code>rsv2 := opcodebyte[0] &gt;&gt; 5 &amp; 1</code>

<code>    </code><code>rsv3 := opcodebyte[0] &gt;&gt; 4 &amp; 1</code>

<code>    </code><code>opcode := opcodebyte[0] &amp; 15</code>

<code>    </code><code>log.println(rsv1,rsv2,rsv3,opcode)</code>

<code>    </code><code>payloadlenbyte := make([]byte, 1)</code>

<code>    </code><code>this.conn.read(payloadlenbyte)</code>

<code>    </code><code>payloadlen := int(payloadlenbyte[0] &amp; 0x7f)</code>

<code>    </code><code>mask := payloadlenbyte[0] &gt;&gt; 7</code>

<code>    </code><code>if</code> <code>payloadlen == 127 {</code>

<code>        </code><code>extendedbyte := make([]byte, 8)</code>

<code>        </code><code>this.conn.read(extendedbyte)</code>

<code>    </code> 

<code>    </code><code>maskingbyte := make([]byte, 4)</code>

<code>    </code><code>if</code> <code>mask == 1 {</code>

<code>        </code><code>this.conn.read(maskingbyte)</code>

<code>        </code><code>this.maskingkey = maskingbyte</code>

<code>    </code><code>payloaddatabyte := make([]byte, payloadlen)</code>

<code>    </code><code>this.conn.read(payloaddatabyte)</code>

<code>    </code><code>log.println(</code><code>"data:"</code><code>, payloaddatabyte)</code>

<code>    </code><code>databyte := make([]byte, payloadlen)</code>

<code>    </code><code>for</code> <code>i := 0; i &lt; payloadlen; i++ {</code>

<code>        </code><code>if</code> <code>mask == 1 {</code>

<code>            </code><code>databyte[i] = payloaddatabyte[i] ^ maskingbyte[i % 4]</code>

<code>            </code><code>databyte[i] = payloaddatabyte[i]</code>

<code>    </code><code>if</code> <code>fin == 1 {</code>

<code>        </code><code>data = databyte</code>

<code>        </code><code>return</code>

<code>    </code><code>nextdata, err := this.readiframe()</code>

<code>    </code><code>data = append(data, nextdata…)</code>

<code>    </code><code>return</code>

<code>func parsehandshake(content string) map[string]string {</code>

<code>    </code><code>headers := make(map[string]string, 10)</code>

<code>    </code><code>lines := strings.split(content,</code><code>"\r\n"</code><code>)</code>

<code>    </code><code>for</code> <code>_,line := range lines {</code>

<code>        </code><code>if</code> <code>len(line) &gt;= 0 {</code>

<code>            </code><code>words := strings.split(line,</code><code>":"</code><code>)</code>

<code>            </code><code>if</code> <code>len(words) == 2 {</code>

<code>                </code><code>headers[strings.trim(words[0],</code><code>" "</code><code>)] = strings.trim(words[1],</code><code>" "</code><code>)</code>

<code>    </code><code>return</code> <code>headers</code>

ps:后来发现官方也有实现了websocket,只是它不是在pkg下,而是在net的branch下

强烈建议使用官方的websocket,不要自己写

https://code.google.com/p/go.net/

当然如果自己实现了一遍协议,看官方的包自然会更清晰了。

继续阅读