springmvc+websocket简单实例

资源代码下载：https://download.csdn.net/download/sovinchan/10340829

1、WebSocket简介

WebSocket是HTML5提供的一种全双工通信的协议，通常是浏览器（或其他客户端）与Web服务器之间的通信。这使得它适合于高度交互的Web应用程序，如及时通讯聊天等。

2、Spring+websocket

spring4.0已经就支持websocket了，可以去查看官网。

官网：spring websocket

3、配置环境

3.1、环境：

spring-4.2.0.RELEASE java1.8 apache-tomcat-8.5.29

maven构建项目：

pom.xml配置：

<properties>

<!-- spring版本号 -->

<spring.version>4.2.0.RELEASE</spring.version>

<!-- log4j日志文件管理包版本 -->

<slf4j.version>1.7.7</slf4j.version>

<log4j.version>1.2.17</log4j.version>

<!-- junit版本号 -->

<junit.version>4.12</junit.version>

<!-- mybatis版本号 -->

<mybatis.version>3.2.8</mybatis.version>

<jackson.version>2.7.4</jackson.version>

<!-- jdbc driver setting -->

<mysql.driver.version>5.1.30</mysql.driver.version>

<!-- <oracle.driver.version>10.2.0.4.0</oracle.driver.version> -->

<!-- environment setting -->

<jdk.version>1.8</jdk.version>

<jetty.version>7.6.14.v20131031</jetty.version>

<webserver.port>8181</webserver.port>

</properties>

<dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>${jackson.version}</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>${jackson.version}</version> </dependency>

<!-- springMVC begin --> <dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-webmvc</artifactId>

<version>${spring.version}</version>

</dependency>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context</artifactId>

<version>${spring.version}</version>

</dependency>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context-support</artifactId>

<version>${spring.version}</version>

</dependency>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-aop</artifactId>

<version>${spring.version}</version>

</dependency> <!-- springMVC end -->

<!-- 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>

3.2、Servlet-api

servlet-api必须是3.0+，才支持websocket，所以如果不是，则要更新jar包。

<dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> </dependency>

3.3、web.xml配置

并且 web.xml的namespace也要确保是3.0+，

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_3_0.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0"> <!-- WebSocket 需要Servlet3.0 需要web.xml 3.0及以上，并要配置此 --> <absolute-ordering /></web-app>

代码：<absolute-ordering />也要添加在web.xml开始。

---

并且必须将所以的filter和servlet都要添加异步：

<async-supported>true</async-supported>

如：springMVC在web.xml中的配置也要添加：

<!-- springMVC 配置 start --> <servlet> <servlet-name>springMVC</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:springMVC.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> <async-supported>true</async-supported> </servlet> <servlet-mapping> <servlet-name>springMVC</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> <!-- springMVC 配置 end -->

4、service服务端的具体实现

4、service服务端的具体实现

4.1、首先创建websocket的处理类

WebsocketEndPoint.java

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;


import org.apache.log4j.Logger;
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 com.google.common.reflect.TypeToken;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;


public class WebsocketEndPoint implements WebSocketHandler {
private static final Logger log = Logger.getLogger(WebsocketEndPoint.class);


    // 保存所有的用户session
public static final Map<String, WebSocketSession> userSocketSessionMap; 
  
  static { 
    userSocketSessionMap = new HashMap<String, WebSocketSession>(); 
  } 




    // 连接 就绪时 
    @Override
    public void afterConnectionEstablished(WebSocketSession session)
            throws Exception {


        log.info("connect websocket success.......");


        //users.add(session);


    }




    // 处理信息
    @Override
    public void handleMessage(WebSocketSession session,
            WebSocketMessage<?> message) throws Exception {


        Gson gson = new Gson();


        // 将消息JSON格式通过Gson转换成Map
        // message.getPayload().toString() 获取消息具体内容
        Map<String, Object> msg = gson.fromJson(message.getPayload().toString(), 
                new TypeToken<Map<String, Object>>() {}.getType());


        log.info("handleMessage......."+message.getPayload()+"..........."+msg);
        
        TextMessage textMessage = new TextMessage("我是服务端", true);
        session.sendMessage(textMessage);
    }
    // 处理传输时异常
    @Override
    public void handleTransportError(WebSocketSession session,
            Throwable exception) throws Exception {
        // TODO Auto-generated method stub


    }
    // 关闭 连接时
    @Override
    public void afterConnectionClosed(WebSocketSession session,
            CloseStatus closeStatus) throws Exception {


        log.info("connect websocket closed.......");


        //users.remove(session);


    }






    @Override
    public boolean supportsPartialMessages() { 
      // TODO Auto-generated method stub 
      return false; 
    } 
    /** 
     * 群发 
     */
    public void broadcast(final TextMessage message) throws IOException { 
      Iterator<Entry<String, WebSocketSession>> it = userSocketSessionMap 
          .entrySet().iterator(); 
    
      // 多线程群发 
      while (it.hasNext()) { 
    
        final Entry<String, WebSocketSession> entry = it.next(); 
    
        if (entry.getValue().isOpen()) { 
          new Thread(new Runnable() { 
    
            public void run() { 
              try { 
                if (entry.getValue().isOpen()) { 
                  entry.getValue().sendMessage(message); 
                } 
              } catch (IOException e) { 
                e.printStackTrace(); 
              } 
            } 
    
          }).start(); 
        } 
    
      } 
    } 
      
    /** 
     * 给所有在线用户的实时工程检测页面发送消息 
     * 
     * @param message 
     * @throws IOException 
     */
    public void sendMessageToJsp(final TextMessage message,String type) throws IOException { 
      Iterator<Entry<String, WebSocketSession>> it = userSocketSessionMap 
          .entrySet().iterator(); 
    
      // 多线程群发 
      while (it.hasNext()) { 
    
        final Entry<String, WebSocketSession> entry = it.next(); 
        if (entry.getValue().isOpen() && entry.getKey().contains(type)) { 
          new Thread(new Runnable() { 
    
            public void run() { 
              try { 
                if (entry.getValue().isOpen()) { 
                  entry.getValue().sendMessage(message); 
                } 
              } catch (IOException e) { 
                e.printStackTrace(); 
              } 
            } 
    
          }).start(); 
        } 
    
      } 
    }


}

4.2、创建握手（handshake）接口/拦截器

HandshakeInterceptor .java

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.support.HttpSessionHandshakeInterceptor;  
  
public class HandshakeInterceptor extends HttpSessionHandshakeInterceptor{  
  
    @Override  
    public boolean beforeHandshake(ServerHttpRequest request,  
            ServerHttpResponse response, WebSocketHandler wsHandler,  
            Map<String, Object> attributes) throws Exception {  
        System.out.println("Before Handshake");  
        return super.beforeHandshake(request, response, wsHandler, attributes);  
    }  
  
    @Override  
    public void afterHandshake(ServerHttpRequest request,  
            ServerHttpResponse response, WebSocketHandler wsHandler,  
            Exception ex) {  
        System.out.println("After Handshake");  
        super.afterHandshake(request, response, wsHandler, ex);  
    }  
  
} 

这个的主要作用是可以在握手前做一些事，把所需要的东西放入到attributes里面，然后可以在WebSocketHandler的session中， 取到相应的值，具体可参考HttpSessionHandshakeInterceptor，这儿也可以实现HandshakeInterceptor 接口。

4.3、注册处理类及握手接口

这个有两种方式：

3. 创建一个类来实现注册
4. 使用xml配置文件实现

4.3.1、创建类MyWebSocketConfig

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;

@Configuration

@EnableWebMvc

@EnableWebSocket

public class MyWebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {

@Override

public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {

//前台 可以使用websocket环境

registry.addHandler(myWebSocketHandler(),"/websocket").addInterceptors(new HandshakeInterceptor());

//前台 不可以使用websocket环境，则使用sockjs进行模拟连接

registry.addHandler(myWebSocketHandler(), "/sockjs/websocket").addInterceptors(new HandshakeInterceptor())

.withSockJS();

}

// websocket 处理类

@Bean

public WebSocketHandler myWebSocketHandler(){

return new WebsocketEndPoint();

}

}

注意：不要忘记在springmvc的配置文件中配置对此类的自动扫描

<context:component-scan base-package="*.*.*" />（配置文件的包名）

• 1

---

4.3.2、xml配置方式(之前用的4.1的版本，始终连接不上，后来换成4.3就可以了，不知道原因)

spring-websocket.xml

<?xml version="1.0" encoding="UTF-8"?>

<!-- xmlns:websocket="http://www.springframework.org/schema/websocket"

http://www.springframework.org/schema/websocket

http://www.springframework.org/schema/websocket/spring-websocket.xsd-->

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:context="http://www.springframework.org/schema/context" xmlns:jdbc="http://www.springframework.org/schema/jdbc"

xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"

xmlns:util="http://www.springframework.org/schema/util" xmlns:task="http://www.springframework.org/schema/task" xsi:schemaLocation="

http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd

http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd

http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-4.3.xsd

http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.3.xsd

http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd

http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.3.xsd

http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.3.xsd">

<!-- <import resource="memcached-content.xml"/>

--> <!-- 加载配置文件 -->

<context:property-placeholder ignore-unresolvable="true" location="classpath:jdbc.properties" />

<!-- 使用Annotation自动注册Bean，解决事物失效问题：在主容器中不扫描@Controller注解，在SpringMvc中只扫描@Controller注解。 -->

<context:component-scan base-package="com.screen.modules.**">

<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller" />

</context:component-scan>

<!--扫描websocket配置类 -->

<context:component-scan base-package="com.screen.modules.websocket" />

<!--websocket处理类和握手协议的spring配置 xml配置方法-->

<bean id="websocket" class="com.screen.modules.websocket.WebsocketEndPoint"/>

<!-- 握手接口/拦截器 --> <bean id="myInterceptor" class="com.screen.modules.websocket.HandshakeInterceptor"/>

<websocket:handlers>

<websocket:mapping path="/websocket" handler="websocket"/>

<websocket:handshake-interceptors>

<bean class="com.screen.modules.websocket.HandshakeInterceptor"/> <ref bean="myInterceptor"/>

</websocket:handshake-interceptors>

</websocket:handlers>

<!-- 注册 sockJS --> <websocket:handlers> <websocket:mapping path="/sockjs/websocket" handler="websocket"/> <websocket:handshake-interceptors> <ref bean="myInterceptor"/> </websocket:handshake-interceptors> <websocket:sockjs /> </websocket:handlers>

</beans>

5、client客户端的实现

<%@ page contentType="text/html;charset=UTF-8"%>

<html lang="zh">

<head>

<meta charset="UTF-8">

<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Websocket</title>

</head>

<body>

<div style="width:200px;height:200px;float: right;margin-bottom:0px;position:absolute;">

<a style="color:white;" href="javascript:WebSocketTest()">测试~~~~~</a>

</div>

</div>

</body>

<script type="text/javascript">

//打开一个 web socket

var websocket;

$(function(){

if ("WebSocket" in window)

{

alert("您的浏览器支持 WebSocket!");

// 首先判断是否 支持 WebSocket

if('WebSocket' in window) {

websocket = new WebSocket("ws://localhost:8080/screen-socket/websocket");

} else if('MozWebSocket' in window) {

websocket = new MozWebSocket("ws://localhost:8080/screen-socket/websocket");

} else {

websocket = new SockJS("http://localhost:8080/screen-socket/sockjs/websocket");

}

// 打开时

websocket.onopen = function(evnt) {

console.log(" websocket.onopen ");

};

// 处理消息时

websocket.onmessage = function(evnt) {

console.log(evnt);

};

websocket.onerror = function(evnt) {

console.log(" websocket.onerror ");

};

websocket.onclose = function(evnt) {

console.log(" websocket.onclose ");

};

}

});

function WebSocketTest()

{

// 获取消息内容

var text = "我是客户端";

// 判断

if(text == null || text == ""){

alert(" content can not empty!!");

return false;

}

var msg = {

msgContent: text,

postsId: 1

};

// 发送消息

websocket.send(JSON.stringify(msg));

}

</script>

</html>