脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → spring配置websocket

spring配置websocket的完整流程

 更新时间：2025年05月23日 10:43:01   作者：LCY133  
websocket为浏览器为服务器提供了双工异步通信的功能,即浏览器可以向服务器发送消息,服务器也可以向浏览器发送消息,这篇文章主要给大家介绍了关于spring配置websocket的相关资料,需要的朋友可以参考下

在 Spring Boot 中使用 Kotlin 配置 WebSocket 的完整流程如下（包含基础配置、安全增强和性能优化）：

一、添加依赖 (build.gradle.kts 或 pom.xml)

// build.gradle.kts
dependencies {
    implementation("org.springframework.boot:spring-boot-starter-websocket")
    implementation("com.fasterxml.jackson.module:jackson-module-kotlin") // JSON 支持
}

二、基础 WebSocket 配置

1. 启用 WebSocket 支持

@Configuration
@EnableWebSocket
class WebSocketConfig : WebSocketConfigurer {

    @Autowired
    lateinit var myWebSocketHandler: MyWebSocketHandler

    @Autowired
    lateinit var handshakeInterceptor: AuthHandshakeInterceptor

    override fun registerWebSocketHandlers(registry: WebSocketHandlerRegistry) {
        registry.addHandler(myWebSocketHandler, "/ws")
            .addInterceptors(handshakeInterceptor)
            .setAllowedOrigins("*") // 生产环境应限制域名
    }
}

三、核心组件实现

1. WebSocket 消息处理器

@Component
class MyWebSocketHandler : TextWebSocketHandler() {

    private val sessions = ConcurrentHashMap<String, WebSocketSession>()
    private val logger = LoggerFactory.getLogger(this::class.java)

    // 连接建立
    override fun afterConnectionEstablished(session: WebSocketSession) {
        val userId = session.attributes["userId"] as? String
        userId?.let {
            sessions[it] = session
            logger.info("User $it connected, total: ${sessions.size}")
        } ?: run {
            session.close(CloseStatus.BAD_DATA)
        }
    }

    // 处理文本消息
    override fun handleTextMessage(session: WebSocketSession, message: TextMessage) {
        val payload = message.payload
        logger.debug("Received message: $payload")
        
        // 示例：广播消息
        sessions.values.forEach { 
            it.sendMessage(TextMessage("Broadcast: $payload"))
        }
    }

    // 连接关闭
    override fun afterConnectionClosed(session: WebSocketSession, status: CloseStatus) {
        sessions.values.remove(session)
        logger.info("Connection closed: ${status.reason}")
    }

    // 主动推送方法
    fun sendToUser(userId: String, message: String) {
        sessions[userId]?.sendMessage(TextMessage(message))
    }
}

2. 握手拦截器（安全校验）

@Component
class AuthHandshakeInterceptor : HandshakeInterceptor {

    override fun beforeHandshake(
        request: ServerHttpRequest,
        response: ServerHttpResponse,
        wsHandler: WebSocketHandler,
        attributes: MutableMap<String, Any>
    ): Boolean {
        // 1. 校验 Token
        val token = request.uri.query?.split("token=")?.get(1)
        if (!validateToken(token)) {
            response.statusCode = HttpStatus.UNAUTHORIZED
            return false
        }

        // 2. 获取用户信息
        val userId = parseUserIdFromToken(token)
        attributes["userId"] = userId
        
        // 3. 记录握手日志
        logHandshake(request.remoteAddress?.hostName)
        return true
    }

    private fun validateToken(token: String?): Boolean {
        // 实现 JWT 校验逻辑
        return token?.startsWith("valid_") == true
    }
}

四、客户端连接示例（JavaScript + Kotlin）

1. Web 前端连接

const socket = new WebSocket(`ws://${location.host}/ws?token=valid_123`);

socket.onmessage = (event) => {
  console.log('Received:', event.data);
};

// 发送心跳包保持连接
setInterval(() => {
  socket.send(JSON.stringify({ type: "heartbeat" }));
}, 30000);

2. Android 客户端（Kotlin）

class WebSocketClient(url: String) : WebSocketListener() {
    private val client = OkHttpClient()
    private var ws: WebSocket? = null

    init {
        val request = Request.Builder().url(url).build()
        ws = client.newWebSocket(request, this)
    }

    override fun onMessage(webSocket: WebSocket, text: String) {
        println("Received: $text")
    }

    fun sendMessage(msg: String) {
        ws?.send(msg)
    }
}

五、高级配置

1. 消息压缩配置

@Bean
fun webSocketContainer(): ServletServerContainerFactoryBean {
    return ServletServerContainerFactoryBean().apply {
        setMaxTextMessageBufferSize(8192)
        setMaxBinaryMessageBufferSize(8192)
        setAsyncSendTimeout(30000L) // 30秒异步发送超时
    }
}

2. 集群支持（Redis 广播）

@Configuration
@EnableRedisRepositories
class RedisPubSubConfig {

    @Bean
    fun redisTemplate(connectionFactory: RedisConnectionFactory): RedisTemplate<String, String> {
        return RedisTemplate<String, String>().apply {
            setConnectionFactory(connectionFactory)
        }
    }

    @Bean
    fun topicListenerAdapter(handler: MessageListener): ChannelTopic {
        return ChannelTopic("websocket-messages")
    }
}

六、监控与调试

1. 端点监控

@RestController
class WebSocketMetricsController(
    private val handler: MyWebSocketHandler
) {

    @GetMapping("/metrics/websocket")
    fun getMetrics(): Map<String, Any> {
        return mapOf(
            "activeConnections" to handler.getSessionCount(),
            "lastMessageTime" to handler.getLastActivity()
        )
    }
}

2. 日志配置 (logback-spring.xml)

<logger name="org.springframework.web.socket" level="DEBUG"/>
<logger name="com.example.websocket" level="TRACE"/>

七、常见问题解决方案

问题现象解决方案
连接频繁断开添加心跳机制，调整 setAsyncSendTimeout
跨域失败精确配置 .setAllowedOrigins("https://your-domain.com")
消息顺序错乱使用 @SendToUser(destination = "/queue", broadcast = false) 点对点发送
内存泄漏定期检查 sessions Map，添加连接超时清理逻辑
高并发时性能下降启用异步消息处理，使用 Redis Pub/Sub 分流消息

八、安全增强建议

  • 启用 WSS 协议：

    # Nginx 配置示例
location /ws {
    proxy_pass http://backend;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header X-Real-IP $remote_addr;
    proxy_ssl_protocols TLSv1.2 TLSv1.3;
}

  • 限流防护：

    @Bean
fun webSocketRateLimiter(): WebSocketHandlerDecoratorFactory {
    return object : WebSocketHandlerDecoratorFactory {
        override fun decorate(handler: WebSocketHandler): WebSocketHandler {
            val rateLimiter = RateLimiter.create(100) // 100次/秒
            return object : WebSocketHandlerDecorator(handler) {
                override fun handleMessage(session: WebSocketSession, message: WebSocketMessage<*>) {
                    if (!rateLimiter.tryAcquire()) {
                        session.close(CloseStatus.POLICY_VIOLATION)
                        return
                    }
                    super.handleMessage(session, message)
                }
            }
        }
    }
}

九、性能测试建议

  • 使用 JMeter 压测：

    <!-- WebSocket 压测计划示例 -->
<WebSocketSampler>
  <connectTime>5000</connectTime>
  <responseTimeout>10000</responseTimeout>
  <payload>{ "type": "stress", "data": "test" }</payload>
</WebSocketSampler>

  • 监控指标：
    • 单节点最大连接数
    • 消息往返延迟 (RTT)
    • 内存占用增长率

通过以上配置，可以实现一个高性能、安全可靠的企业级 WebSocket 服务，支持从开发到生产的全生命周期管理。

总结

到此这篇关于spring配置websocket的文章就介绍到这了,更多相关spring配置websocket内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 一文详解JavaWeb过滤器(Filter)

    一文详解JavaWeb过滤器(Filter)

    本文主要介绍了一文详解JavaWeb过滤器(Filter)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05
  • Java深入了解数据结构之栈与队列的详解

    Java深入了解数据结构之栈与队列的详解

    这篇文章主要介绍了Java数据结构中的栈与队列,在Java的时候，对于栈与队列的应用需要熟练的掌握，这样才能够确保Java学习时候能够有扎实的基础能力。本文小编就来详细说说Java中的栈与队列,需要的朋友可以参考一下
    2022-01-01
  • 浅谈Java8 判空新写法

    浅谈Java8 判空新写法

    在开发过程中很多时候会遇到判空校验，如果不做判空校验则会产生NullPointerException异常，本文就来介绍一下Java8 判空新写法，感兴趣的可以了解一下
    2021-09-09
  • Java单链表反转图文教程

    Java单链表反转图文教程

    这篇文章主要给大家介绍了关于Java单链表反转的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • java服务器的简单实现过程记录

    java服务器的简单实现过程记录

    在线浏览网页离不开服务器,用户发出请求request,服务器做出响应response,提供给用户需要的页面,这篇文章主要给大家介绍了关于java服务器简单实现的相关资料,需要的朋友可以参考下
    2021-11-11
  • idea如何快速查找一个类或类中方法名和变量

    idea如何快速查找一个类或类中方法名和变量

    这篇文章主要介绍了idea如何快速查找一个类或类中方法名和变量问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • Java Vector类详解及实例代码

    Java Vector类详解及实例代码

    这篇文章主要介绍了Java Vector类详解及实例代码的相关资料,需要的朋友可以参考下
    2017-01-01
  • Java Process详解及实例

    Java Process详解及实例

    这篇文章主要介绍了Java Process详解及实例的相关资料,需要的朋友可以参考下
    2017-07-07
  • Java @Deprecated注解的作用及传递性

    Java @Deprecated注解的作用及传递性

    用 @Deprecated注解的程序元素，不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择，本文给大家介绍java @deprecated注解的作用及传递性，对本文感兴趣的朋友一起学习吧
    2015-12-12
  • Java工程mybatis实现多表查询过程详解

    Java工程mybatis实现多表查询过程详解

    这篇文章主要介绍了Java工程mybatis实现多表查询过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06

最新评论