Sping Boot之WebSocket使用

首先，说明为何要使用webSocket。毕竟通过前面几篇博客，我们就可以知道http调用就很方便，那么websocket的存在意义呢。因为http是单向通信，由客户端发起，服务端没法做到向客户端发送信息，如果需要长期通信就只能采取轮询或者长连接的方式，然而这样做，效率低下，浪费资源。基于此，webSocket诞生，webSocket是基于tcp，全双工通信，只在建立连接时发起一次三次握手请求，后续保持连接，很有效率，极为节省资源。
开始讲解如何建立一个websocket服务端和客户端。如下：
一.引入websocket依赖

  <!-- webSocket start-->
        <!-- service -->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-websocket</artifactId>
       </dependency>
       <!-- client -->
       <dependency>
            <groupId>org.java-websocket</groupId>
            <artifactId>Java-WebSocket</artifactId>
            <version>1.3.0</version>
       </dependency>
       <!-- webSocket end-->

二.编写配置类

@Configuration
public class WebSocketConfig {

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

三.编写webSocket服务端

大概如下编写，根据自己业务逻辑来相应增删改查咯。

/**
 * AstWebSocket 服务端
 *
 */
@ServerEndpoint(value = "/websocket")
@Component
public class AstWebSocketServer {
    /**
     * logger
     */
      private final Logger logger = LoggerFactory.getLogger(this.getClass());

    /**
     * concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
     */
    private static CopyOnWriteArraySet<AstWebSocketServer> webSocketSet = new CopyOnWriteArraySet<AstWebSocketServer>();

    /**
     * 静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
     */
    private static int onlineCount = 0;

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

    /**
     * websocket 参数转换map
     */
    Map<String, String> paramMaps;

    /**
     * 连接建立成功调用的方法
     * @param session session
     */
    @OnOpen
    public void onOpen(Session session) {
        logger.info("onWebSocketConnect,QueryString:{}", session.getQueryString());
        this.session = session;
        // 加入set中
        webSocketSet.add(this);
        // 在线数加1
        addOnlineCount();
        try {
            sendMessage("");
        } catch (IOException e) {
            System.out.println("IO异常");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);  //从set中删除
        subOnlineCount();           //在线数减1
        System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     * @param session session
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("来自客户端的消息:" + message);
        String map = session.getQueryString();
        logger.info(JSON.toJSONString(map)+"测试");
        //群发消息
        for (AstWebSocketServer item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 发生错误时调用
     */
    @OnError
    public void onError(Session session, Throwable error) {
        System.out.println("发生错误");
        error.printStackTrace();
    }

    /**
     * 发送消息
     * @param message 消息内容
     * @throws IOException IOException
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }


    /**
     * 群发自定义消息
     * @param message 消息内容
     * @throws IOException IOException
     */
    public static void sendInfo(String message) throws IOException {
        for (AstWebSocketServer item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                continue;
            }
        }
    }

    /**
     * 获取在线数
     * @return 在线数
     */
    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    /**
     * 添加在线数
     */
    public static synchronized void addOnlineCount() {
        AstWebSocketServer.onlineCount++;
    }

    /**
     * 删除在线数
     */
    public static synchronized void subOnlineCount() {
        AstWebSocketServer.onlineCount--;
    }
}

四.编写webSocket客户端

客户端代码如下：

/**
 * AstWebSocket 客户端
 *
 */
public class AstWebSocketClient extends WebSocketClient {

     private final Logger logger = LoggerFactory.getLogger(this.getClass());

    public AstWebSocketClient(URI serverUri) {
        super(serverUri, new Draft_17());
        // 阻塞建立链接
        try {
            if (this.connectBlocking()) {
                logger.info("AstWebSocketServer 连接成功！ serverUri:{}", serverUri);
            } else {
                logger.info("AstWebSocketServer 连接失败！");
                this.closeBlocking();
            }
        } catch (Exception e) {
            logger.info("AstWebSocketServer 连接失败！ serverUri:{}", serverUri);
        }
    }

    @Override
    public void onClose(int code, String reason, boolean remote) {
        logger.info("connection closed");
    }

    @Override
    public void onError(Exception exception) {
        logger.error(ExceptionUtils.getStackTrace(exception));
        exception.printStackTrace();
    }

    @Override
    public void onMessage(String message) {
        logger.info("来自服务端的消息"+ message);
    }

    @Override
    public void onOpen(ServerHandshake session) {

        logger.info("connected !");
    }

}

webSocket服务端和客户端编写完成，编写个测试类，测试下是否正常工作：

public class TestMain {

    /**
     * webSocket配置路径
     */
//  @Value("${websocket.url}")
//  private String webSocketUrl;

    public static void main(String[] args){
        URI uri;
//      String webSocketUrl ="ws://localhost:8081/demo/websocket?courtId=aaa&devId=dff";
        String webSocketUrl ="ws://localhost:8080/websocket";
        try {
            uri = new URI(webSocketUrl);
            AstWebSocketClient webSocketClient  = new AstWebSocketClient(uri);
            System.out.print("start send message!");
            webSocketClient.send("hello,world");
            webSocketClient.closeBlocking();         
        } catch (URISyntaxException e) {
            e.printStackTrace();
        }
        catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

测试结果与预期一致，表明webSocket服务端和客户端正常工作通信。

如下不当，欢迎指正交流。