WebSocket与SpringMVC集成案例

最新推荐文章于 2025-07-18 10:59:28 发布

原创最新推荐文章于 2025-07-18 10:59:28 发布 · 7.5k 阅读

4 ·

CC 4.0 BY-SA版权

websocket 专栏收录该内容

5 篇文章

订阅专栏

本文档详细介绍了如何将WebSocket与SpringMVC进行集成，包括web.xml的配置，以及后台关键代码WebSocketConfig.java的实现，重点讲解了控制跳转路径的设置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、相关配置文件：

1）web.xml的配置内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">
 
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:conf/spring.xml;
        </param-value>
  </context-param>
  <context-param>
    <param-name>webAppRootKey</param-name>
    <param-value>springmvc.root</param-value>
  </context-param>
 
  <servlet>
    <servlet-name>springMVC-web</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:conf/spring-mvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  
  <servlet-mapping>
    <servlet-name>springMVC-web</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</web-app>

2）spring-mvc.xml的配置内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:p="http://www.springframework.org/schema/p" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:websocket="http://www.springframework.org/schema/websocket"
	xsi:schemaLocation="
    http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
    http://www.springframework.org/schema/context
    http://www.springframework.org/schema/context/spring-context-3.2.xsd
    http://www.springframework.org/schema/mvc
    http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
    http://www.springframework.org/schema/websocket
    http://www.springframework.org/schema/websocket/spring-websocket.xsd">

    <context:annotation-config />
	<mvc:annotation-driven />
	<!-- 扫描controller（controller层注入） -->
	<!-- <context:component-scan base-package="com.bms.controller" /> -->
	
	<context:component-scan base-package="websocket"/>
	  
	<!-- 对模型视图添加前后缀 -->
	<bean id="viewResolver"
		class="org.springframework.web.servlet.view.InternalResourceViewResolver"
		p:prefix="/WEB-INF/page/" p:suffix=".jsp" />
</beans>

3）spring.xml的配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans 
      http://www.springframework.org/schema/beans/spring-beans-3.0.xsd 
      http://www.springframework.org/schema/context 
      http://www.springframework.org/schema/context/spring-context.xsd">
	<!-- 引入jdbc配置文件 -->
	<context:property-placeholder location="classpath:conf/jdbc.properties" />
	
		<bean id="messageCodeResolver"
		class="org.springframework.validation.DefaultMessageCodesResolver">
		<property name="prefix" value="validation."></property>
	</bean>

	<!-- 避免转换失败异常抛到jsp中 -->
	<bean id="messageSource"
		class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
		<property name="basename" value="/WEB-INF/messages.properties" />
		<property name="fileEncodings" value="UTF-8" />
	</bean>
	
	<!-- 扫描文件（自动将servicec层注入） -->
	<context:component-scan base-package="com.bms.service.*" />
</beans>

2、前台代码如下：

<%@ page language="java" contentType="text/html; charset=UTF-8"
	pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WebSocket/SockJS Echo Sample (Adapted from Tomcat's echo
	sample)</title>

<script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>

<script type="text/javascript">
    var websocket = null;
    
    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        websocket = new WebSocket("ws://localhost:8080/DataMigration/webSocketServer");
    }
    else{
        alert('Not support websocket')
    }
     
    //连接发生错误的回调方法
    websocket.onerror = function(){
        setMessageInnerHTML("error");
    };
     
    //连接成功建立的回调方法
    websocket.onopen = function(event){
        setMessageInnerHTML("open");
    }
     
    //接收到消息的回调方法
    websocket.onmessage = function(){
        setMessageInnerHTML(event.data);
    }
     
    //连接关闭的回调方法
    websocket.onclose = function(){
        setMessageInnerHTML("close");
    }
     
    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function(){
        websocket.close();
    }
     
    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML){
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }
     
    //关闭连接
    function closeWebSocket(){
        websocket.close();
    }
     
    //发送消息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
    
</script>
</head>
<body>
	Welcome<br/>
	<input id="text" type="text" />
	   <button onclick="send()">Send</button>
	   <button onclick="closeWebSocket()">Close</button>
	<div id="message"></div>
</body>
</html>

3、后台代码结构如如下：

4、后台代码如下

1）WebSocketConfig.java

package websocket.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.socket.WebSocketHandler;
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 websocket.handler.SystemWebSocketHandler;


@Configuration
@EnableWebMvc
@EnableWebSocket
public class WebSocketConfig implements  WebSocketConfigurer{

	@Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(myHandler(), "/webSocketServer");
    }

    @Bean
    public WebSocketHandler myHandler() {
      
    	return new SystemWebSocketHandler();
    }
}

2)SystemWebSocketHandler.java

package websocket.handler;

import java.io.IOException;
import java.util.ArrayList;

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;

public class SystemWebSocketHandler implements WebSocketHandler {

	    private static final ArrayList<WebSocketSession> users = new ArrayList<WebSocketSession>();;
	 	 
	    @Override
	    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
	    	    	
	        users.add(session);
	        System.out.println("ConnectionEstablished"+"=>当前在线用户的数量是:"+users.size());
	    }
	 
	    @Override
	    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
	    	
	    	System.out.println(message.getPayload());
	    	TextMessage returnMessage = new TextMessage("received at server");
	    		    		
	        sendMessageToUsers(returnMessage);	    		      
	    }
	 
	    @Override
	    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
	        if(session.isOpen()){
	          
	        	session.close();
	        }
	        users.remove(session);
	    }
	 
	    
	    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
	    	
	    	users.remove(session);
	    	System.out.println("ConnectionClosed"+"=>当前在线用户的数量是:"+users.size());

	    }
	 
	    @Override
	    public boolean supportsPartialMessages() {
	        return false;
	    }
	 
	    /**
	     * 给所有在线用户发送消息
	     * @param message
	     */
	    public void sendMessageToUsers(TextMessage message) {
	        for (WebSocketSession user : users) {
	            if (user.isOpen()) {
				   
	            	try {
	            		for(int i = 0;i < 5;i++ ){
	            			
							user.sendMessage(message);

	            		}
					} catch (IOException e) {
						// TODO Auto-generated catch block
						e.printStackTrace();
					}
				}
	        }
	    } 
}

5、测试方法与上一篇博客一样，此处不再赘述。

注意：本博客中用红颜色标注的地方还是挺重要的，控制跳转路径