Web Socket，Spring Boot解决方案

2017-03-06 本文已影响5959人活这么大就没饱过

前言

聊天室、推送怎么实现？我们需要保证消息的实时性，才能达到我们想要实现的效果，总不能用一个循环的 http、https 请求去营造一种消息实时的假象吧，所以在设计时我们需要引入长连接的概念，也就是说在用户登录后建立一条与服务器长期有效的稳定连接，实时获取服务器的单播、广播信息，并可以向服务器发送信息并分发给其他用户。

什么是 Web Socket

网络上的两个程序通过一个双向的通信连接实现数据的交换，这个连接的一端称为一个Socket。
建立网络通信连接至少要一对端口号(Socket)。Socket 本质是编程接口(API)，对TCP/IP的封装，TCP/IP也要提供可供程序员做网络开发所用的接口，这就是Socket编程接口；HTTP是轿车，提供了封装或者显示数据的具体形式；Socket是发动机，提供了网络通信的能力。
而 Web Socket 即是通过 web 浏览器进行的 Socket 长连接，一般使用场景是聊天室、简易联网游戏、推送等。

怎么实现 Web Socket

实现 Web Socket 首先需要服务器、连接的联网客户端，而实现 Web Socket 的技术并非只有一种，但这篇博客主要讲解 Spring Boot 的Web Socket 实现解决方案。

通过 STOMP 和 SockJS 实现前端页面与服务器的长连接解决方案，技术成熟，兼容性好，但是实现麻烦，并长时间没有迭代维护，这篇文章鼓励大家尝试，但是并不会仔细说明。
原生 H5 支持的 Web Socket 解决方案，实现简单方便，但是兼容性不佳，可是使用 ie8 以前版本的用户使我们的目标用户吗？反正我略过了，这篇博客主要讲解这项解决方案。

Show Me Code

Maven 引入必要依赖
核心是 @ServerEndpoint 这个注解。这个注解是JavaEE标准里的注解，tomcat7以上已经对其进行了实现，如果是用传统方法使用tomcat发布项目，只要在pom文件中引入JavaEE标准即可使用。

<dependency>
      <groupId>javax</groupId>
      <artifactId>javaee-api</artifactId>
      <version>7.0</version>
      <scope>provided</scope>
</dependency>

但使用 Spring Boot 的内置tomcat时，就不需要引入javaee-api了，spring-boot已经包含了。使用 Spring Boot 的 Web Socket 功能首先引入 Spring Boot 组件。推荐只用 Spring Boot 的内置 tomcat，毕竟省去了中间件的环境配置呀。

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
            <version>1.3.5.RELEASE</version>
</dependency>

顺便说一句，springboot的高级组件会自动引用基础的组件，像spring-boot-starter-websocket就引入了spring-boot-starter-web和spring-boot-starter，所以不要重复引入。

使用@ServerEndpoint创立websocket endpoint
首先要注入 ServerEndpointExporter，这个bean会自动注册使用了 @ServerEndpoint 注解声明的 Web Socket endpoint。要注意，如果使用独立的 Servlet 容器，而不是直接使用 Spring Boot 的内置容器，就不要注入 ServerEndpointExporter，因为它将由容器自己提供和管理。

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

接下来就是写websocket的具体实现类，很简单，直接上代码：

@ServerEndpoint(value = "/websocket")
@Component
public class MyWebSocket {
    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;
    //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
    private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>();
    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;
    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        webSocketSet.add(this);     //加入set中
        addOnlineCount();           //在线数加1
        System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());
        try {    sendMessage(CommonConstant.CURRENT_WANGING_NUMBER.toString());
        } catch (IOException e) {
            System.out.println("IO异常");
        }
    }
    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);  //从set中删除
        subOnlineCount();           //在线数减1
        System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
    }
    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息*/
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("来自客户端的消息:" + message);
        //群发消息
        for (MyWebSocket item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    /**
     * 发生错误时调用
     */
    @OnError
    public void onError(Session session, Throwable error) {
        System.out.println("发生错误");
        error.printStackTrace();
    }
public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
        //this.session.getAsyncRemote().sendText(message);
    }
    /**
     * 群发自定义消息
     */
    public static void sendInfo(String message) throws IOException {
        for (MyWebSocket item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                continue;
            }
        }
    }
 public static synchronized int getOnlineCount() {
        return onlineCount;
    }
    public static synchronized void addOnlineCount() {
        MyWebSocket.onlineCount++;
    }
    public static synchronized void subOnlineCount() {
        MyWebSocket.onlineCount--;
    }
}

使用springboot的唯一区别是要@Component声明下，而使用独立容器是由容器自己管理websocket的，但在springboot中连容器都是spring管理的。

虽然@Component默认是单例模式的，但springboot还是会为每个websocket连接初始化一个bean，所以可以用一个静态set保存起来。

3、前端代码

<!DOCTYPE HTML>
<html>
<head>
    <title>My WebSocket</title>
</head>

<body>
Welcome<br/>
<input id="text" type="text" /><button onclick="send()">Send</button>    <button onclick="closeWebSocket()">Close</button>
<div id="message">
</div>
</body>

<script type="text/javascript">
    var websocket = null;

    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:8084/websocket");
    }
    else{
        alert('Not support websocket')
    }

    //连接发生错误的回调方法
    websocket.onerror = function(){
        setMessageInnerHTML("error");
    };

    //连接成功建立的回调方法
    websocket.onopen = function(event){
        setMessageInnerHTML("open");
    }

    //接收到消息的回调方法
    websocket.onmessage = function(event){
        setMessageInnerHTML(event.data);
    }

    //连接关闭的回调方法
    websocket.onclose = function(){
        setMessageInnerHTML("close");
    }

    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function(){
        websocket.close();
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML){
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭连接
    function closeWebSocket(){
        websocket.close();
    }

    //发送消息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

好了，大功告成，启动你的 Spring Boot 的 Application 程序，并在不同浏览器中打开你的 html 文件，查看 Web Socket 的简单应用吧。

总结

Spring Boot 已经做了深度的集成和优化，要注意是否添加了不需要的依赖、配置或声明。由于很多讲解组件使用的文章是和 Spring 集成的，会有一些配置，在使用 Spring Boot 时，由于 Spring Boot 已经有了自己的配置，再这些配置有可能导致各种各样的异常。

写在最后

大家到此只要自己照着博客进行过代码编写一定有了一定自己对于 Web Socket 的了解，但不要只局限于这个简单的 Demo，你们可以想象下指定用户的单播如何实现，以及考虑 STOMP 以及 SockJS 的 Web Socket 的解决方案的实现方式。希望大家热爱编程，享受解决问题那一刻的喜悦。

Web Socket，Spring Boot解决方案

前言

什么是 Web Socket

怎么实现 Web Socket

Show Me Code

总结

写在最后

猜你喜欢

热点阅读