springboot集成websocket

一只小菜鸟_K

已于 2023-03-07 11:35:46 修改

阅读量6k

点赞数 10

文章标签： java

于 2021-02-21 15:22:46 首次发布

本文链接：https://blog.csdn.net/qq_42922707/article/details/113918644

版权

springboot集成websocket

记录下自己使用wensocket的踩坑过程，如有不对，请见谅

引入依赖

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

配置websocket拦截器

此处需要注意，在拦截器中注入服务会失败。
产生原因：spring管理的都是单例（singleton），和 websocket （多对象）相冲突。
详细解释：项目启动时初始化，会初始化 websocket （非用户连接的），spring 同时会为其注入 service，该对象的 service 不是 null，被成功注入。但是，由于 spring 默认管理的是单例，所以只会注入一次 service。当客户端与服务器端进行连接时，服务器端又会创建一个新的 websocket 对象，这时问题出现了：spring 管理的都是单例，不会给第二个 websocket 对象注入 service，所以导致只要是用户连接创建的 websocket 对象，都不能再注入了。
像 controller 里面有 service， service 里面有 dao。因为 controller，service ，dao 都有是单例，所以注入时不会报 null。但是 websocket 不是单例，所以使用spring注入一次后，后面的对象就不会再注入了，会报NullException。
解决办法：在websocketConfig中把websocket拦截器当作bean加载进来，（应该还有其他更好办法，此处是我自己的解决方法）

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
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 javax.annotation.Resource;
import java.util.Map;
@Component
public class WebSocketInterceptor implements HandshakeInterceptor {
    private final static Logger logger = LoggerFactory.getLogger(WebSocketInterceptor.class);


    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
        logger.info("websocket握手前");
        return true;
    }
    @Override
    public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {
        logger.info("websocket握手后");
    }

开启websocket配置

将websocket拦截器作为bean

    @Bean
    public WebSocketInterceptor getWebSocketInterceptor() {
        return new WebSocketInterceptor();
    }

import org.springframework.context.annotation.Bean;
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;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;


@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Bean
    public WebSocketInterceptor getWebSocketInterceptor() {
        return new WebSocketInterceptor();
    }

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 此处定义webSocket的连接地址以及允许跨域
        registry.addHandler(myHandler(), "/websocket").addInterceptors(getWebSocketInterceptor()).setAllowedOrigins("*");
        // 同上，同时开启了Sock JS的支持，目的为了支持IE8及以下浏览器
        registry.addHandler(myHandler(), "/sockjs/websocket").addInterceptors(getWebSocketInterceptor()).setAllowedOrigins("*").withSockJS();
    }
    @Bean
    public WebSocketServer myHandler() {
        return new WebSocketServer();
    }
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

WebSocket实现

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;


@Component
public class WebSocketServer implements WebSocketHandler {
    private static final Logger logger = LoggerFactory.getLogger(WebSocketServer.class);
    private static Set<WebSocketSession> webSocketSet = new HashSet<>();
   
    /**
     * 建立连接后触发的回调
     * @param session
     * @throws Exception
     */
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        webSocketSet.add(session);
        logger.info("有新连接加入！当前在线人数为:{}" , webSocketSet.size());
    }

    

    /**
     * 收到消息时触发的回调
     * @param session
     * @param message
     * @throws Exception
     */
    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
        logger.info("收到新的消息！内容:{}" ,message.getPayload().toString());
    }
    /**
     * 发生异常，关闭连接
     * @param session
     * @param exception
     * @throws Exception
     */
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        webSocketSet.remove(session);
        logger.info("websocket发生异常！" ,exception);
    }
    /**
     * 关闭连接
     * @param session
     * @param closeStatus
     * @throws Exception
     */
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        webSocketSet.remove(session);
        logger.debug("webSocket关闭连接，状态：{}，当前连接数：{}", closeStatus, webSocketSet.size());
    }
    /**
     * 是否支持消息分片
     * @return
     */
    @Override
    public boolean supportsPartialMessages() {
        return false;
    }

    /**
     * 发送消息
     * @param message
     * @throws IOException
     */
    public static void sendString(String message) throws IOException {
        for (WebSocketSession webSocket : webSocketSet) {
            if (webSocket.isOpen()) {
                webSocket.sendMessage(new TextMessage(message));

            }
        }
        logger.debug("webSocket发送消息，内容：{}，当前连接数：{}", message, webSocketSet.size());
    }
    /**
     * 发送消息
     * @param map
     * @throws IOException
     */
    public static void sendMap(Map<String,Object> map) throws IOException {
        logger.debug("webSocket发送消息，内容：{}，当前连接数：{}", JsonUtils.toJSONString(map), webSocketSet.size());
        for (WebSocketSession webSocket : webSocketSet) {
            if (webSocket.isOpen()) {
                webSocket.sendMessage(new TextMessage(JsonUtils.toJSONString(map)));
            }
        }
    }

    /**
     * 发送消息
     * @param map
     * @throws IOException
     */
    public static void sendList(List<Object> map ,String type) throws IOException {
        if(webSocketSet.size() > 0){
            for (WebSocketSession webSocket : webSocketSet) {
                if (webSocket.isOpen()) {
                    String urlType = getWebsocketUrlType(Objects.requireNonNull(webSocket.getUri()).toString());
                    if(type.equals(urlType)){
                        webSocket.sendMessage(new TextMessage(JsonUtils.toJSONString(map)));
                    }
                }
            }
            logger.debug("webSocket发送消息，内容：{}，当前连接数：{}", JsonUtils.toJSONString(map), webSocketSet.size());
        }
    }

消息推送

@ApiOperation(value = "发送webSocket消息")
@PostMapping("/sendWebSocketMessage")
public ResultMessage sendWebSocketMessage() String message) throws Exception {
    // 发送webSocket消息
    WebSocketServer.sendString("你好");
    return new ResultMessage().success();
}

前端代码示例


var socket;
    if (typeof (WebSocket) == "undefined") {
        console.log("遗憾：您的浏览器不支持WebSocket");
    } else {
        console.log("恭喜：您的浏览器支持WebSocket");
        //实现化WebSocket对象
        //指定要连接的服务器地址与端口建立连接
        //注意ws、wss使用不同的端口。我使用自签名的证书测试，
        //无法使用wss，浏览器打开WebSocket时报错
        //ws对应http、wss对应https。
        socket = new WebSocket("ws://localhost/api/webSocket");
        //连接打开事件
        socket.onopen = function() {
            console.log("Socket 已打开");
        };
        //收到消息事件
        socket.onmessage = function(msg) {
            console.log(msg.data);
        };
        //连接关闭事件
        socket.onclose = function() {
            console.log("Socket已关闭");
        };
        //发生了错误事件
        socket.onerror = function() {
            alert("Socket发生了错误");
        }
        //窗口关闭时，关闭连接
        window.unload=function() {
            socket.close();
        };
    }

至此，websocket已经可以正常使用。下面是生产中会遇到的问题

分布式部署，websocket共享问题

为什么要使用这种模式呢？

我们不妨设想一下，如果我们后端部署了多台服务器，其中某一个用户发布了消息，需要实时通知到其他在线的用户，以上示例是无法实现的。
因为WebSocket Session是不支持序列化的，无法存储也就没有办法将所有后端服务器中连接的用户会话放到一起。
既然无法把会话存放到一起统一管理，那么就定义一个公共的频道，每个服务器都向该频道发布消息，所有订阅该频道的服务器都接收消息，用来判断当前所连接的用户是否需要接收到该消息，需要则推送不需要则不推送，则刚好符合发布订阅模式。

每个应用节点都订阅该topic的频道，这样新消息一注册，每个节点服务器都能接收到Object，然后从各自的节点中寻找正在连接的webSocket会话，进行消息推送。

就这样通过Redis的发布/订阅功能实现session共享。
Redis相关介绍及配置在这里就不介绍了，直接开始配置，具体配置如下：

消息处理器

import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import com.alibaba.fastjson.JSONObject;
 
@Component
public class RedisReceiver {
    private static final Logger logger = LoggerFactory.getLogger(RedisReceiver.class);
 
    public void testString(String message) {
        logger.info("消费字符串数据:[{}]", message);
        // 发送webSocket消息
        WebSocketConnect.broadCastInfo(message);
    }
}

消息监听

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.listener.PatternTopic;
import org.springframework.data.redis.listener.RedisMessageListenerContainer;
import org.springframework.data.redis.listener.adapter.MessageListenerAdapter;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
 
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator;
 
@Configuration
public class RedisMessageListener {
    @Bean
    RedisMessageListenerContainer container(RedisConnectionFactory redisConnectionFactory, MessageListenerAdapter testStringAdapter) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(redisConnectionFactory);
        // 修改默认的序列化方式，支持更多类型的数据传输
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(Object.class);
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        // 针对每一个消息处理设置不同的序列化方式
        // 测试字符串主题并绑定消息订阅处理器
        testStringAdapter.setSerializer(jackson2JsonRedisSerializer);
        container.addMessageListener(testStringAdapter, new PatternTopic("REDIS_TOPIC_TEST_STRING"));
        return container;
    }
    // 消息监听器适配器，绑定消息处理器，利用反射技术调用消息处理器的业务方法
    /**
     * 测试字符串消息订阅处理器，并指定处理方法
     * @param redisReceiver
     * @return
     */
    @Bean
    MessageListenerAdapter testStringAdapter(RedisReceiver redisReceiver) {
        return new MessageListenerAdapter(redisReceiver, "testString");
    }
}

redis序列化配置

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
@Configuration
@EnableCaching
public class RedisConfig {
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        // 使用Jackson2JsonRedisSerialize 替换默认的jdkSerializeable序列化
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        //com.fasterxml.jackson.databind**版本**2.9.9
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        //com.fasterxml.jackson.databind**版本**2.10.1
//       om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        // key采用String的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        // hash的key也采用String的序列化方式
        template.setHashKeySerializer(stringRedisSerializer);
        // value序列化方式采用jackson
        template.setValueSerializer(jackson2JsonRedisSerializer);
        // hash的value序列化方式采用jackson
        template.setHashValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }
}

发布消息

// 此处需注意，发送的频道需要与订阅的频道一致
redisTemplate.convertAndSend("REDIS_TOPIC_TEST_STRING", content);

websocket的wss访问

生产外网一般会用https，websocket也是一样，一般使用wss方式进行访问
当然，生产中如果是https的话，那么https会天然的支持wss的访问
但是在开发中，我们需要自己测试，配置springboot的https访问来支持websocket的wss访问

首先我们要自己生成一个证书

keytool -genkeypair -alias "tomcat" -keyalg "RSA" -keysize 2048 -keystore "tomcat.keystore"

生成https证书
在这里插入图片描述

我们会得到一个证书，将证书放入resource下
在这里插入图片描述
然后在配置中加上下面这些配置

server.ssl.key-store=classpath:tomcat.keystore
server.ssl.key-store-password=123456
server.ssl.keyStoreType=JKS
server.ssl.keyAlias:tomcat

这里会有一个坑，maven编译时会改变我们的证书，哪怕是一个空格，证书的大小变了。
我们要指定maven编译时，不会改变它

<build>
		<resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>*.keystore</include>
                </includes>
                <filtering>false</filtering>
            </resource>
		</resources>
	</build>

至此https访问就配置好了，网上看了好多，都是还要配置http协议跳转https，我使用时至此就可以正常https访问了，如果不起作用，可是试一下配置http协议跳转https。

在启动类中加上下面的配置

// SpringBoot2.x配置HTTPS,并实现HTTP访问自动转向HTTPS
    @Bean
    public ServletWebServerFactory servletContainer() {
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory(){
            @Override
            protected void postProcessContext(Context context) {
                SecurityConstraint securityConstraint = new SecurityConstraint();
                securityConstraint.setUserConstraint("CONFIDENTIAL");
                SecurityCollection collection = new SecurityCollection();
                collection.addPattern("/*");
                securityConstraint.addCollection(collection);
                context.addConstraint(securityConstraint);
            }
        };
        tomcat.addAdditionalTomcatConnectors(httpConnector());
        return tomcat;
    }

    @Bean
    public Connector httpConnector() {
        Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
        connector.setScheme("http");
        connector.setPort(8080); // 监听Http的端口
        connector.setSecure(false);
        connector.setRedirectPort(8443); // 监听Http端口后转向Https端口
        return connector;
    }

最后一步就是服务器配置开启websocket协议访问

不开启的话，无法正常使用
会报handshake: Unexpected response code: 400
查了一下官网才发现原来在配置反向代理的时候，如果需要使用wss，还需要加上如下配置：

location /wsapp/ {
    proxy_pass http://wsbackend;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
}

但是加上之后，还是无法访问
最后的结果是：

proxy set header X-Real IP Sremote addr;
proxy_set_header Host Shost；
proxy_set header X _Forward For Sproxy_add_x forwarded for. 
proxy http version 1.1;
proxy _set header Upgrade Shttp_upgrade；
proxy_set_header Connection "upgrade";
proxy pass http://uat-k8s；
access_loglogs/uat-api.health.log main;