SpringBoot-Websocket-实战

什么是 Websocket

Websocket 是一种在单个 TCP 连贯上进行全双工通信的协定。WebSocket 连贯胜利后，服务端与客户端能够双向通信。在须要音讯推送的场景，Websocket 绝对于轮询能更好的节俭服务器资源和带宽，并且可能更实时地进行通信。

• 与 HTTP 协定有着良好的兼容性。默认端口也是 80 和 443，并且握手阶段采纳 HTTP 协定，因而握手时不容易屏蔽，能通过各种 HTTP 代理服务器。
• 依赖于 TCP 协定
• 数据格式比拟轻量，性能开销小，通信高效。
• 能够发送文本，也能够发送二进制数据。
• 没有同源限度，客户端能够与任意服务器通信。
• 协定标识符是 ws（如果加密，则为 wss），服务器网址就是 URL。

SpringBoot 中应用 Websocket

在简略理解 Websocket 之后，咱们来入手实际一下。SpringBoot 中有多种形式能够实现 Websocket Server，这里我抉择应用 Tomcat 中 javax.websocket.server 的 api 来实现，结尾会给出 demo 地址

1. 引入 Maven 依赖

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

1. 创立一个 Bean 用于解决 Websocket 申请，通过 ServerEndpoint 申明以后 Bean 承受的 Websocket URL

这里为什么申明的是 @Controller，后文会解释

import org.springframework.stereotype.Controller;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;

@ServerEndpoint(value = "/message_websocket")
@Controller
public class MsgWebsocketController {

    @OnOpen
    public void onOpen(Session session) {
        // 先鉴权，如果鉴权通过则存储 WebsocketSession，否则敞开连贯，这里省略了鉴权的代码 
        WebSocketSupport.storageSession(session);
        System.out.println("session open. ID:" + session.getId());
    }

    /**
     * 连贯敞开调用的办法
     */
    @OnClose
    public void onClose(Session session) {System.out.println("session close. ID:" + session.getId());
    }

    /**
     * 收到客户端音讯后调用的办法
     */
    @OnMessage
    public void onMessage(String message, Session session) {System.out.println("get client msg. ID:" + session.getId() + ". msg:" + message);
    }

    /**
     * 产生谬误时调用
     */
    @OnError
    public void onError(Session session, Throwable error) {error.printStackTrace();
    }

}

1. 申明 ServerEndpointExporter

@Configuration
public class WebsocketConfig {

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

}

至此，Websocket Server 曾经搭建实现，客户端曾经能够和服务端通信了

服务端 向客户端推送音讯 通过 session.getBasicRemote().sendText(message); 即可

源码浅析

咱们来看下上述的短短几行代码是如何为咱们构建 Websocket Server

ServerEndpointExporter

重点关注下红框中的内容

1. ServerEndpointExporter 实现了 SmartInitializingSingleton，会在 bean 实例化完结后调用 afterSingletonsInstantiated
2. 从 Spring 上下文中获取所有标记 @ServerEndpoint 的 Bean 的 name

其实 咱们申明的 MsgWebsocketController 中并不是只能标记 @Controller，只是为了将其注册到 Spring 容器中，不便 ServerEndpoint 的注册而已，标记 @Controller 更合乎 Spring 的开发标准

3~4. 通过 ServerContainer 将所有标记 @ServerEndpoint 的 Bean 注册

ServerContainer 默认的实现类为 WsServerContainer，会对咱们的 ServerEndpoint 做一个映射，URL => 对应的 class，而后针对不同的事件调用指定的办法（例如建设连贯时调用标记 @Onopen 的办法），这有点 Spring DispatcherServlet 那味，感兴趣的同学能够本人看下

在理解了 Spring 为咱们做了什么后，咱们来欠缺一下咱们的 Demo

建设一个 SessionManager

当咱们想向客户端推送音讯的时候，首先咱们须要找到客户端与服务端建设的连贯，也就是 WebscoketSession

WsServerContainer 中尽管曾经存储了 WebscoketSession，然而并没有方法间接通过 SessionId，或者咱们的业务 Id 间接定位到指定的 Session，所以咱们须要实现一个本人的 SessionManager

final ConcurrentHashMap<Object, Session> sessionPool = new ConcurrentHashMap<>();

应用 ConcurrentHashMap 治理即可

分布式推送解决

如图，用户 1 与服务器 A 建设 Webscoket，用户 2 与服务器 B 建设 Webscoket，那么用户 1 如果想向用户 2 推送一条音讯，该如何实现？

WebscoketSession 实际上是网络连接，并不像咱们传统利用的 Session 能够序列化到 Redis，只能每个服务器治理本人的 WebscoketSession，所以此时服务器 A 告诉服务器 B，你要给用户 2 推送一条音讯。

一个比较简单无效的实现办法，利用音讯队列，如下图

这个计划长处是实现简略，毛病是每台服务器都须要判断一遍以后是否存在指定的 WebscoketSession，计划细化的话则须要保护用户 Session 与每台服务器的关系，这样间接将音讯推送给指定服务器即可

残缺 demo 地址

对于 demo 的细节参考我的项目地址中 Readme

Github ???? https://github.com/TavenYin/taven-springboot-learning/tree/master/sp-websocket

Gitee ???? https://gitee.com/yintianwen7/taven-springboot-learning/tree/master/sp-websocket

参考

http://www.ruanyifeng.com/blog/2017/05/websocket.html

局部代码参考了一位兄弟的博客，然而因为工夫有点长，找不到了，在此说一声道歉

如果感觉有播种，能够关注我的公众号【殷地理】，第一工夫接管到我的更新

<!–
nginx 如何解决 websocket
http://nginx.org/en/docs/http/websocket.html
https://www.nginx.com/blog/websocket-nginx/
–>