spring-websocket

spring集成websocket

1、maven依赖

  <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-websocket</artifactId>

</dependency>  

2、建立一个session池，WsSeesionManager

 

    private static ConcurrentHashMap<String, WebSocketSession> SESSION_POOL = new ConcurrentHashMap<>();

    /**

     * 添加 session

     *

     * @param key

     */

    public static void add(String key, WebSocketSession session) {

        // 添加 session

        SESSION_POOL.put(key, session);

    }

    /**

     * 删除 session,会返回删除的 session

     *

     * @param key

     * @return

     */

    public static WebSocketSession remove(String key) {

        // 删除 session

        return SESSION_POOL.remove(key);

    }

    /**

     * 删除并同步关闭连接

     *

     * @param key

     */

    public static void removeAndClose(String key) {

        WebSocketSession session = remove(key);

        if (session != null) {

            try {

                // 关闭连接

                session.close();

            } catch (IOException e) {

                // todo: 关闭出现异常处理

                e.printStackTrace();

            }

        }

    }

    /**

     * 获得 session

     *

     * @param key

     * @return

     */

    public static WebSocketSession get(String key) {

        // 获得 session

        return SESSION_POOL.get(key);

    }}

 说明：

这里简单通过CurrentHashMap来实现一个session池，用来保存已经登录的websocket的session，服务端发送消息给客户端必须要用到这个session

3、创建握手拦截器MyInterceptor

import cn.hutool.core.util.StrUtil;

import cn.hutool.http.HttpUtil;

import org.springframework.http.server.ServerHttpRequest;

import org.springframework.http.server.ServerHttpResponse;

import org.springframework.stereotype.Component;

import org.springframework.web.socket.WebSocketHandler;

import org.springframework.web.socket.server.HandshakeInterceptor;

import java.util.HashMap;import java.util.Map;

/**

 * @author buhao

 * @version MyInterceptor.java, v 0.1 2019-10-17 19:21 buhao

 */

@Componentpublic class MyInterceptor implements HandshakeInterceptor {

    /**

     * 握手前

     *

     * @param request

     * @param response

     * @param wsHandler

     * @param attributes

     * @return

     * @throws Exception

     */

    @Override

    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {

        System.out.println("握手开始");

        // 获得请求参数

        HashMap<String, String> paramMap = HttpUtil.decodeParamMap(request.getURI().getQuery(), "utf-8");

        String uid = paramMap.get("token");

        if (StrUtil.isNotBlank(uid)) {

            // 放入属性域

            attributes.put("token", uid);

            System.out.println("用户 token " + uid + " 握手成功！");

            return true;

        }

        System.out.println("用户登录已失效");

        return false;

    }

    /**

     * 握手后

     *

     * @param request

     * @param response

     * @param wsHandler

     * @param exception

     */

    @Override

    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) {

        System.out.println("握手完成");

    }

}

 说明：

通过实现HandShakeInterceptor接口来定义握手拦截器，这里是建立在握手时的事件，分为握手前和握手后，这里与后面的Handler事件是不同的，Handler事件是建立在握手成功的基础上建立socket连接的。所以如果把认证放在这个步骤相对来说比较节省服务器资源。它主要重写两个方法：beforeHandShake和afterHandShake，一个在握手前触发，一个在握手后触发。

4、创建handler

 

import cn.coder4j.study.example.websocket.config.WsSessionManager;

import org.springframework.stereotype.Component;

import org.springframework.web.socket.CloseStatus;

import org.springframework.web.socket.TextMessage;

import org.springframework.web.socket.WebSocketSession;

import org.springframework.web.socket.handler.TextWebSocketHandler;

import java.time.LocalDateTime;

/**

 * @author buhao

 * @version MyWSHandler.java, v 0.1 2019-10-17 17:10 buhao

 */

@Componentpublic class HttpAuthHandler extends TextWebSocketHandler {

    /**

     * socket 建立成功事件

     *

     * @param session

     * @throws Exception

     */

    @Override

    public void afterConnectionEstablished(WebSocketSession session) throws Exception {

        Object token = session.getAttributes().get("token");

        if (token != null) {

            // 用户连接成功，放入在线用户缓存

            WsSessionManager.add(token.toString(), session);

        } else {

            throw new RuntimeException("用户登录已经失效!");

        }

    }

    /**

     * 接收消息事件

     *

     * @param session

     * @param message

     * @throws Exception

     */

    @Override

    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {

        // 获得客户端传来的消息

        String payload = message.getPayload();

        Object token = session.getAttributes().get("token");

        System.out.println("server 接收到 " + token + " 发送的 " + payload);

        session.sendMessage(new TextMessage("server 发送给 " + token + " 消息 " + payload + " " + LocalDateTime.now().toString()));

    }

    /**

     * socket 断开连接时

     *

     * @param session

     * @param status

     * @throws Exception

     */

    @Override

    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {

        Object token = session.getAttributes().get("token");

        if (token != null) {

            // 用户退出，移除缓存

            WsSessionManager.remove(token.toString());

        }

    }

}

说明：

通过继承TextWebSocketHandler 类并重写相应的方法，可以对websocket的事件进行处理，这里有几个重写方法，可以同原生注解放在一块比较观看。

1、afterConnectionEstablished，在连接成功后触发，同@OnOpen

2、afterConnectionClosed，在连接关闭后触发，同@OnClose

3、handleTextMessage，在客户端发送消息时触发，同@OnMessage

5、配置websocket 

 

import cn.coder4j.study.example.websocket.handler.HttpAuthHandler;

import cn.coder4j.study.example.websocket.interceptor.MyInterceptor;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.socket.config.annotation.EnableWebSocket;

import org.springframework.web.socket.config.annotation.WebSocketConfigurer;

import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

/**

 * @author buhao

 * @version WebSocketConfig.java, v 0.1 2019-10-17 15:43 buhao

 */

@Configuration

@EnableWebSocket

public class WebSocketConfig implements WebSocketConfigurer {

    @Autowired

    private HttpAuthHandler httpAuthHandler;

    @Autowired

    private MyInterceptor myInterceptor;

    @Override

    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {

        registry

                .addHandler(httpAuthHandler, "myWS")

                .addInterceptors(myInterceptor)

                .setAllowedOrigins("*");

    }

}

说明：

通过实现WebScoketConfigurer接口重新对websocket进行配置。我们主要覆盖registerWebSocketHandlers这个方法。通过想WebSocketHandlerRegister对象中设置不同的参数来进行配置。

其中addHandler方法中，第一个参数是我们上面创建的ws的handler处理类，第二个参数是暴露出来的ws路径。 

addInterceptors添加我们上面创建的握手过滤器。

setAllowedOrigins（“*”）这个是关闭跨域校验，线上推荐打开。