Spring Boot学习（三十）：SpringBoot集成WebSocket

前言

Spring Boot系列: 点击查看Spring Boot系列文章

WebSocket

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

WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在 WebSocket API 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

在 WebSocket API 中，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

现在，很多网站为了实现推送技术，所用的技术都是 Ajax 轮询。轮询是在特定的的时间间隔（如每1秒），由浏览器对服务器发出HTTP请求，然后由服务器返回最新的数据给客户端的浏览器。这种传统的模式带来很明显的缺点，即浏览器需要不断的向服务器发出请求，然而HTTP请求可能包含较长的头部，其中真正有效的数据可能只是很小的一部分，显然这样会浪费很多的带宽等资源。

HTML5 定义的 WebSocket 协议，能更好的节省服务器资源和带宽，并且能够更实时地进行通讯。

WebSocket最大特点就是，服务器可以主动向客户端推送信息，客户端也可以主动向服务器发送信息

SpringBoot集成WebSocket

1、导入依赖

SpringBoot2.0已经集成了WebSocket，依赖如下

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

2、启用WebSocket的支持也是很简单，只需要在配置类注册一个ServerEndpointExporter 的bean即可

import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * 开启WebSocket支持
 */
@Configuration  
public class WebSocketConfig {  
	
    @Bean  
    public ServerEndpointExporter serverEndpointExporter() {  
        return new ServerEndpointExporter();  
    }  
  
} 

ServerEndpointExporter 是由Spring官方提供的标准实现，用于扫描ServerEndpointConfig配置类和@ServerEndpoint注解实例。使用规则也很简单：

1、如果使用默认的嵌入式容器 比如Tomcat 则必须手工在上下文提供ServerEndpointExporter。

2、如果使用外部容器部署war包，则不需要提供提供ServerEndpointExporter，因为此时SpringBoot默认将扫描服务端的行为交给外部容器处理，所以线上部署的时候要把WebSocketConfig中这段注入bean的代码注掉。

3、创建连接、推送和处理消息的 WebSocket处理类

通过 @Controller + @ServerEndpoint("/访问地址名称") 注解 声明创建类为WebSocket 服务端点类。具体代码如下：

@Controller
@ServerEndpoint("/dispose")
public class WebSocketDispose {
}

@ServerEndpoint(value = “/xxx”)注释端点表示将 WebSocket 服务端运行在 ws://[Server 端 IP 或域名]:[Server 端口]/项目名/websocket 的访问端点

在WebSocket 服务端点类中，我们可以使用@OnOpen注解来定义建立连接后调用的方法，使用 @OnMessage注解定义监听客户端消息的方法（即收到客户端后调用的方法），使用@OnClose注解定义连接关闭调用的方法，使用@OnError注解定义发生错误时调用的方法。

当然，还有一个是服务端向客户端发送消息，使用的是Session.getBasicRemote().sendText(String message)

注：Session为websocket 客户端会话

4、下面是一个简单的例子

@Controller
@ServerEndpoint("/dispose")
public class WebSocketDispose {

    private Logger logger= LoggerFactory.getLogger(WebSocketDispose.class);

    //websocket客户端session
    private Session session;

    //使用一个线程安全的集合来存放WebSocket客户端的对象
    private static ConcurrentHashMap<String,WebSocketDispose> webSocketMap = new ConcurrentHashMap();


    /**
     * 连接建立后触发的方法
     */
    @OnOpen
    public void onOpen(Session session){
        logger.info("onOpen:"+session.getId());
        this.session = session;
        webSocketMap.put(session.getId(),this);
    }


    /**
     * 连接关闭触发方法
     */
    @OnClose
    public void onClose(){
        webSocketMap.remove(session.getId());
        logger.info("OnClose:"+session.getId());

    }


    /**
     * 接收到客户端消息时触发的方法
     */
    @OnMessage
    public void onMessage(String msg,Session session)throws Exception{
        //获取webSocket对象
        WebSocketDispose webSocketDispose = webSocketMap.get(session.getId());
        logger.info("收到"+session.getId()+"的消息："+msg);
    }


    /**
     * 发生异常时触发的方法
     */
    @OnError
    public void onError(Session session,Throwable throwable){
        logger.info(session.getId()+"发生异常："+throwable.getMessage());
        throwable.printStackTrace();
    }

    /**
     * 发送消息给客户端
     */
    public void sendMessage(String msg)throws Exception{
        this.session.getBasicRemote().sendText(msg);
    }

    /**
     * 发送消息到所有客户端
     */
    public void sendMessageAll(String msg)throws Exception{
        for (Map.Entry<String, WebSocketDispose> entry : webSocketMap.entrySet()) {
            entry.getValue().session.getBasicRemote().sendText(msg);
        }
    }
}

注：因 SpringBoot+WebSocket 对每个客户端连接都会创建一个 WebSocketServer（@ServerEndpoint 注解对应的） 对象，Bean 注入操作会被直接略过，所以在WebSocket 中，我们不能直接注入Bean（即@Autowired等操作）

所以当我们需要使用某个bean时，最简单的方法就是从ApplicationContext 中获取