websocket+spring实现定时向前端推送数据

本文不介绍websocket的理论知识，直接进行代码的实现，并且只对服务端进行实现，没有前端页面代码，通过在线工具进行测试

开发环境：eclipse Mars Release(4.5.0) + jdk1.7.0_79 + apache-maven-3.3.9 + tomcat7.0.82

1.项目模块

2.pom.xml中maven坐标的导入

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.lsy</groupId><artifactId>websocket+spring</artifactId><version>0.0.1-SNAPSHOT</version><packaging>war</packaging><properties><spring.version>4.1.7.RELEASE</spring.version></properties><dependencies><!-- spring --><dependency><groupId>org.springframework</groupId><artifactId>spring-core</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-beans</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-context</artifactId><version>${spring.version}</version><exclusions><!-- Exclude Commons Logging in favor of SLF4j --><exclusion><groupId>commons-logging</groupId><artifactId>commons-logging</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-tx</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-web</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-context-support</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.quartz-scheduler</groupId><artifactId>quartz</artifactId><version>2.2.3</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-jdbc</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-aop</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-test</artifactId><version>${spring.version}</version><scope>test</scope></dependency><!-- spring整合websocket --><dependency><groupId>org.springframework</groupId><artifactId>spring-websocket</artifactId><version>${spring.version}</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-messaging</artifactId><version>${spring.version}</version></dependency></dependencies><build><finalName>spring</finalName><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.1</version><configuration><source>1.7</source><target>1.7</target></configuration></plugin></plugins></build></project>

3.java代码的实现

1）spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans"   xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context"   xmlns:aop="http://www.springframework.org/schema/aop"   xmlns:util="http://www.springframework.org/schema/util"   xmlns:websocket="http://www.springframework.org/schema/websocket"   xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-4.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsdhttp://www.springframework.org/schema/utilhttp://www.springframework.org/schema/util/spring-util-4.1.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsdhttp://www.springframework.org/schema/websocket        http://www.springframework.org/schema/websocket/spring-websocket.xsd"><context:component-scan base-package="com.lsy.websocket.demo" /></beans>

2）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" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">  <display-name>spring</display-name>  <filter>    <filter-name>encodingFilter</filter-name>    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>    <async-supported>true</async-supported>    <init-param>      <param-name>encoding</param-name>      <param-value>utf-8</param-value>    </init-param>    <init-param>      <param-name>forceEncoding</param-name>      <param-value>true</param-value>    </init-param>  </filter>  <filter-mapping>    <filter-name>encodingFilter</filter-name>    <url-pattern>/*</url-pattern>  </filter-mapping>  <servlet>    <servlet-name>appServlet</servlet-name>    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>    <init-param>      <param-name>contextConfigLocation</param-name>      <param-value>classpath:spring-mvc.xml</param-value>    </init-param>    <load-on-startup>1</load-on-startup>    <async-supported>true</async-supported>  </servlet>  <servlet-mapping>    <servlet-name>appServlet</servlet-name>    <url-pattern>/</url-pattern>  </servlet-mapping></web-app>

3）FirstWebSocketHandler

package com.lsy.websocket.demo;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;/* * websocket处理器：功能实现的核心代码编写类 */public class FirstWebSocketHandler implements WebSocketHandler{//定义一个全局的初始化值count=0private static int count = 0;//连接关闭后的操作public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {}//建立连接后的操作public void afterConnectionEstablished(WebSocketSession session) throws Exception {while(count <= 100){//向前端推送数据，一秒一次推送，格式：1,2,3,4,5.....session.sendMessage(new TextMessage(count+""));count++;Thread.sleep(1000);}}//消息处理，在客户端通过Websocket API发送的消息会经过这里，然后进行相应的处理public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {}//消息传输错误处理public void handleTransportError(WebSocketSession session, Throwable throwable) throws Exception {if(session.isOpen()){              session.close();          }  }public boolean supportsPartialMessages() {return false;}}

4）WebSocketConfig

package com.lsy.websocket.demo;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.EnableWebMvc;import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;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;/* * websocket配置文件 * 有了该配置文件，就不用在spring-mvc.xml中进行websocket的配置 */@Configuration@EnableWebMvc@EnableWebSocketpublic class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{//添加处理器和拦截器，处理器后面的地址就是websocket的访问路径//setAllowedOrigins：指定的域名或IP，如果不限制使用"*"就可以了public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {registry.addHandler(firstWebSocketHandler(), "/websocket/demo").addInterceptors(myInterceptor()).setAllowedOrigins("*");}//直接注入自己定义的websocket处理器@Beanpublic WebSocketHandler firstWebSocketHandler(){return new FirstWebSocketHandler();}//直接注入自己定义的websocket拦截器@Beanpublic WebSocketHandshakeInterceptor myInterceptor(){return new WebSocketHandshakeInterceptor();}}

5）WebSocketHandshakeInterceptor

package com.lsy.websocket.demo;import java.util.Map;import org.springframework.http.server.ServerHttpRequest;import org.springframework.http.server.ServerHttpResponse;import org.springframework.web.socket.WebSocketHandler;import org.springframework.web.socket.server.HandshakeInterceptor;/** * websocket拦截器：一般情况下不做处理 */public class WebSocketHandshakeInterceptor implements HandshakeInterceptor{public void afterHandshake(ServerHttpRequest arg0, ServerHttpResponse arg1, WebSocketHandler arg2, Exception arg3) {}public boolean beforeHandshake(ServerHttpRequest arg0, ServerHttpResponse arg1, WebSocketHandler arg2,Map<String, Object> arg3) throws Exception {return true;}}

4.测试

点击进入在线测试工具：websocket在线测试工具

输入websocket测试地址：ws://localhost:8080/spring/websocket/demo

5.结果展示

后端数据每隔一秒钟就向前端发送一条数据