Spring-boot 2.0 + WebSocket

Spring-boot 2.0 + WebSocket

• 为什么要用WebSocket?

  为了在做一些操作后，服务端能主动向客户端提示失败结果，而HTTP协议只能是客户端向服务端发送请求。
  而WebSocket就是一个基于TCP的新协议，类似于socket.io；
  在服务端和客户端之间建立socket链接以便服务端进行主动推送。

配置过程

pom.xml配置:

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

配置spring-boot支持

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

WebSocketServer服务配置

@ServerEndpoint("/websocket/{id}")
@Component
public class WebSocketServer {

    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;
    //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
    private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();

    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;

    //接收sid
    private String id="";
    /**
     * 连接建立成功调用的方法*/
    @OnOpen
    public void onOpen(Session session,@PathParam("id") String id) {
        this.session = session;
        webSocketSet.add(this);     //加入set中
        addOnlineCount();           //在线数加1
        System.out.println("有新窗口开始监听:"+id+",当前在线人数为" + getOnlineCount());
        this.id=id;
        try {
            sendMessage("连接成功");
        } catch (IOException e) {
            System.out.println("websocket 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,@PathParam("id")String id) {
        System.out.println("收到来自窗口"+id+"的信息:"+message);
    }

    /**
     *
     * @param session
     * @param error
     */
    @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);
    }


    /**
     * 群发自定义消息
     * */
    public static void sendInfo(String message,@PathParam("id") String id) throws IOException {
        System.out.println("推送消息到窗口"+id+"，推送内容:"+message);
        for (WebSocketServer item : webSocketSet) {
            try {
                //这里可以设定只推送给这个sid的，为null则全部推送
                if(item.id.equals(id)){
                    item.sendMessage(message);
                }
            } catch (IOException e) {
                continue;
            }
        }
    }

    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }

}

至此，服务端的配置就完成了

打包问题

加入websocket之后，项目启动没有问题，但在使用maven打war包时报错了。
原因是因为导入的WebSocket与SpringBoot内置tomcat中的WebSocket冲突了

解决办法
在pom.xml中配置以下内容：

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-surefire-plugin</artifactId>
	<configuration>
		<skip>true</skip>
	</configuration>
</plugin>

配置后可正常打包

然而发现打包后的war包放在tomcat中启动的时候会报错:
java.lang.IllegalStateException: javax.websocket.server.ServerContainer not available

经排查，发现把WebSocketConfig.java中的

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

注释掉后不会发生这种情况了