WebSocket 详解教程

概述

WebSocket 是什么？

WebSocket 是一种网络通讯协议。RFC6455 定义了它的通讯标准。html

WebSocket 是 HTML5 开始提供的一种在单个 TCP 链接上进行全双工通信的协议。java

为何须要 WebSocket ？

了解计算机网络协议的人，应该都知道：HTTP 协议是一种无状态的、无链接的、单向的应用层协议。它采用了请求/响应模型。通讯请求只能由客户端发起，服务端对请求作出应答处理。node

这种通讯模型有一个弊端：HTTP 协议没法实现服务器主动向客户端发起消息。python

这种单向请求的特色，注定了若是服务器有连续的状态变化，客户端要获知就很是麻烦。大多数 Web 应用程序将经过频繁的异步JavaScript和XML（AJAX）请求实现长轮询。轮询的效率低，很是浪费资源（由于必须不停链接，或者 HTTP 链接始终打开）。nginx

所以，工程师们一直在思考，有没有更好的方法。WebSocket 就是这样发明的。WebSocket 链接容许客户端和服务器之间进行全双工通讯，以便任一方均可以经过创建的链接将数据推送到另外一端。WebSocket 只须要创建一次链接，就能够一直保持链接状态。这相比于轮询方式的不停创建链接显然效率要大大提升。git

WebSocket 如何工做？

Web浏览器和服务器都必须实现 WebSockets 协议来创建和维护链接。因为 WebSockets 链接长期存在，与典型的HTTP链接不一样，对服务器有重要的影响。github

基于多线程或多进程的服务器没法适用于 WebSockets，由于它旨在打开链接，尽量快地处理请求，而后关闭链接。任何实际的 WebSockets 服务器端实现都须要一个异步服务器。web

WebSocket 客户端

在客户端，没有必要为 WebSockets 使用 JavaScript 库。实现 WebSockets 的 Web 浏览器将经过 WebSockets 对象公开全部必需的客户端功能（主要指支持 Html5 的浏览器）。ajax

客户端 API

如下 API 用于建立 WebSocket 对象。spring

var Socket = new WebSocket(url, [protocol] );

以上代码中的第一个参数 url, 指定链接的 URL。第二个参数 protocol 是可选的，指定了可接受的子协议。

WebSocket 属性

如下是 WebSocket 对象的属性。假定咱们使用了以上代码建立了 Socket 对象：

属性	描述
Socket.readyState	只读属性 readyState 表示链接状态，能够是如下值：0 - 表示链接还没有创建。1 - 表示链接已创建，能够进行通讯。2 - 表示链接正在进行关闭。3 - 表示链接已经关闭或者链接不能打开。
Socket.bufferedAmount	只读属性 bufferedAmount 已被 send() 放入正在队列中等待传输，可是尚未发出的 UTF-8 文本字节数。

WebSocket 事件

如下是 WebSocket 对象的相关事件。假定咱们使用了以上代码建立了 Socket 对象：

事件	事件处理程序	描述
open	Socket.onopen	链接创建时触发
message	Socket.onmessage	客户端接收服务端数据时触发
error	Socket.onerror	通讯发生错误时触发
close	Socket.onclose	链接关闭时触发

WebSocket 方法

如下是 WebSocket 对象的相关方法。假定咱们使用了以上代码建立了 Socket 对象：

方法	描述
Socket.send()	使用链接发送数据
Socket.close()	关闭链接

示例

// 初始化一个 WebSocket 对象
var ws = new WebSocket("ws://localhost:9998/echo");

// 创建 web socket 链接成功触发事件
ws.onopen = function () {
  // 使用 send() 方法发送数据
  ws.send("发送数据");
  alert("数据发送中...");
};

// 接收服务端数据时触发事件
ws.onmessage = function (evt) {
  var received_msg = evt.data;
  alert("数据已接收...");
};

// 断开 web socket 链接成功触发事件
ws.onclose = function () {
  alert("链接已关闭...");
};

WebSocket 服务端

WebSocket 在服务端的实现很是丰富。Node.js、Java、C++、Python 等多种语言都有本身的解决方案。

如下，介绍我在学习 WebSocket 过程当中接触过的 WebSocket 服务端解决方案。

Node.js

经常使用的 Node 实现有如下三种。

Java

Java 的 web 通常都依托于 servlet 容器。

我使用过的 servlet 容器有：Tomcat、Jetty、Resin。其中Tomcat七、Jetty7及以上版本均开始支持 WebSocket（推荐较新的版本，由于随着版本的更迭，对 WebSocket 的支持可能有变动）。

此外，Spring 框架对 WebSocket 也提供了支持。

虽然，以上应用对于 WebSocket 都有各自的实现。可是，它们都遵循RFC6455 的通讯标准，而且 Java API 统一遵循 JSR 356 - JavaTM API for WebSocket 规范。因此，在实际编码中，API 差别不大。

Spring

Spring 对于 WebSocket 的支持基于下面的 jar 包：

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-websocket</artifactId>
  <version>${spring.version}</version>
</dependency>

在 Spring 实现 WebSocket 服务器大概分为如下几步：

建立 WebSocket 处理器

扩展 TextWebSocketHandler 或 BinaryWebSocketHandler ，你能够覆写指定的方法。Spring 在收到 WebSocket 事件时，会自动调用事件对应的方法。

import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.TextMessage;

public class MyHandler extends TextWebSocketHandler {

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) {
        // ...
    }

}

WebSocketHandler 源码以下，这意味着你的处理器大概能够处理哪些 WebSocket 事件：

public interface WebSocketHandler {

   /**
    * 创建链接后触发的回调
    */
   void afterConnectionEstablished(WebSocketSession session) throws Exception;

   /**
    * 收到消息时触发的回调
    */
   void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception;

   /**
    * 传输消息出错时触发的回调
    */
   void handleTransportError(WebSocketSession session, Throwable exception) throws Exception;

   /**
    * 断开链接后触发的回调
    */
   void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception;

   /**
    * 是否处理分片消息
    */
   boolean supportsPartialMessages();

}

配置 WebSocket

配置有两种方式：注解和 xml 。其做用就是将 WebSocket 处理器添加到注册中心。

实现 WebSocketConfigurer

import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(myHandler(), "/myHandler");
    }

    @Bean
    public WebSocketHandler myHandler() {
        return new MyHandler();
    }

}

xml 方式

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:websocket="http://www.springframework.org/schema/websocket"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/websocket
        http://www.springframework.org/schema/websocket/spring-websocket.xsd">

    <websocket:handlers>
        <websocket:mapping path="/myHandler" handler="myHandler"/>
    </websocket:handlers>

    <bean id="myHandler" class="org.springframework.samples.MyHandler"/>

</beans>

更多配置细节能够参考：Spring WebSocket 文档

javax.websocket

若是不想使用 Spring 框架的 WebSocket API，你也能够选择基本的 javax.websocket。

首先，须要引入 API jar 包。

<!-- To write basic javax.websocket against -->
<dependency>
  <groupId>javax.websocket</groupId>
  <artifactId>javax.websocket-api</artifactId>
  <version>1.0</version>
</dependency>

若是使用嵌入式 jetty，你还须要引入它的实现包：

<!-- To run javax.websocket in embedded server -->
<dependency>
  <groupId>org.eclipse.jetty.websocket</groupId>
  <artifactId>javax-websocket-server-impl</artifactId>
  <version>${jetty-version}</version>
</dependency>
<!-- To run javax.websocket client -->
<dependency>
  <groupId>org.eclipse.jetty.websocket</groupId>
  <artifactId>javax-websocket-client-impl</artifactId>
  <version>${jetty-version}</version>
</dependency>

@ServerEndpoint

这个注解用来标记一个类是 WebSocket 的处理器。

而后，你能够在这个类中使用下面的注解来代表所修饰的方法是触发事件的回调

// 收到消息触发事件
@OnMessage
public void onMessage(String message, Session session) throws IOException, InterruptedException {
    ...
}

// 打开链接触发事件
@OnOpen
public void onOpen(Session session, EndpointConfig config, @PathParam("id") String id) {
    ...
}

// 关闭链接触发事件
@OnClose
public void onClose(Session session, CloseReason closeReason) {
    ...
}

// 传输消息错误触发事件
@OnError
public void onError(Throwable error) {
    ...
}

ServerEndpointConfig.Configurator

编写完处理器，你须要扩展 ServerEndpointConfig.Configurator 类完成配置：

public class WebSocketServerConfigurator extends ServerEndpointConfig.Configurator {
    @Override
    public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
        HttpSession httpSession = (HttpSession) request.getHttpSession();
        sec.getUserProperties().put(HttpSession.class.getName(), httpSession);
    }
}

而后就没有而后了，就是这么简单。

WebSocket 代理

若是把 WebSocket 的通讯当作是电话链接，Nginx 的角色则像是电话接线员，负责将发起电话链接的电话转接到指定的客服。

Nginx 从 1.3 版开始正式支持 WebSocket 代理。若是你的 web 应用使用了代理服务器 Nginx，那么你还须要为 Nginx 作一些配置，使得它开启 WebSocket 代理功能。

如下为参考配置：

server {
  # this section is specific to the WebSockets proxying
  location /socket.io {
    proxy_pass http://app_server_wsgiapp/socket.io;
    proxy_redirect off;

    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_read_timeout 600;
  }
}

更多配置细节能够参考：Nginx 官方的 websocket 文档

FAQ

HTTP 和 WebSocket 有什么关系？

Websocket 实际上是一个新协议，跟 HTTP 协议基本没有关系，只是为了兼容现有浏览器的握手规范而已，也就是说它是 HTTP 协议上的一种补充。

Html 和 HTTP 有什么关系？

Html 是超文本标记语言，是一种用于建立网页的标准标记语言。它是一种技术标准。Html5 是它的最新版本。

Http 是一种网络通讯协议。其自己和 Html 没有直接关系。

完整示例

若是须要完整示例代码，能够参考个人 Github 代码：

Spring 对 WebSocket 支持的示例
嵌入式 Jetty 服务器的 WebSocket 示例

spring-websocket 和 jetty 9.3 版本彷佛存在兼容性问题，Tomcat则木有问题。

我尝试了好几回，没有找到解决方案，只好使用 Jetty 官方的嵌入式示例在 Jetty 中使用 WebSocket 。

资料

知乎高票答案——WebSocket是什么原理 by Ovear

对 WebSocket 原理的阐述简单易懂。
WebSocket 教程 by ruanyf

阮一峰大神的科普一如既往的浅显易懂。
WebSockets by fullstackpython
Nginx 官方的 websocket 文档
Spring WebSocket 文档
Tomcat7 WebSocket 文档
Jetty WebSocket 文档

websocket 详解