利用Spring MVC实现WebSocket实时通信,可以集成到SSH项目中
-
配置的修改:
1.struts.xml,不拦截socket的请求,我的位置为:/pages/mess/gc<constant name="struts.action.excludePattern" value="/pages/mes/TakePhoto.html,/pages/mess/gc"/>
2.web.xml,加入以下配置
<!-- servlet配置 --> <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:spring-webSocket.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>/pages/mess/gc</url-pattern> </servlet-mapping>
3.spring-webSocket.xml,文件放到src下:
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:websocket="http://www.springframework.org/schema/websocket"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/websocket
http://www.springframework.org/schema/websocket/spring-websocket-4.0.xsd">
<!-- websocket处理类 -->
<bean id="msgHandler" class="demo.ssh.dbutil.MyWebSocketHandler" />
<!-- 握手接口/拦截器 ,看项目需求是否需要-->
<bean id="handshakeInterceptor" class="demo.ssh.dbutil.MyHandshakeInterceptor" />
<websocket:handlers>
<websocket:mapping path="/pages/mess/gc" handler="msgHandler" />
<websocket:handshake-interceptors>
<ref bean="handshakeInterceptor" />
</websocket:handshake-interceptors>
</websocket:handlers>
<!-- 注册 sockJS,sockJs是spring对不能使用websocket协议的客户端提供一种模拟 -->
<websocket:handlers>
<websocket:mapping path="/sockjs/pages/mess/gc" handler="msgHandler" />
<websocket:handshake-interceptors>
<ref bean="handshakeInterceptor" />
</websocket:handshake-interceptors>
<websocket:sockjs />
</websocket:handlers>
</beans>
实现类,如果类报错,可能是因为缺少相应jar包造成的,添加即可:
- MyWebSocketHandler:
package demo.ssh.dbutil;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
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 MyWebSocketHandler implements WebSocketHandler {
//private Logger logger = LoggerFactory.getLogger(MsgWebSocketHandler.class);
//保存用户链接
private static ConcurrentHashMap<String, WebSocketSession> users = new ConcurrentHashMap<String, WebSocketSession>();
// 连接 就绪时
//连接成功时候,会触发UI上onopen方法
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
String userName = (String) session.getAttributes().get("HTTP.SESSION.userName");
//System.out.println(userName);
//System.out.println(session.getId()+":连接成功"+session);
//不为空则遍历,空则直接添加
if(!users.isEmpty()){
for (ConcurrentHashMap.Entry<String, WebSocketSession> user : users.entrySet()) {
if (user.getKey().equals(userName)) {
//System.out.println("用户已存在:"+userName);
//通知用户断开连接,清除用户,结束循环
try {
if (user.getValue().isOpen()) {
user.getValue().sendMessage(new TextMessage("您的账号在其他位置登录,当前连接已断开,如非本人操作请立即修改密码"));
}
} catch (IOException e) {
e.printStackTrace();
}
user.getValue().close();
users.remove(user);
break;
}
}
}
users.put(userName, session);
//刷新在线用户信息,群发更新在线用户
String onlineUsers = "";
for(String user:users.keySet()){
onlineUsers = onlineUsers + user + ";";
}
sendMessageToUsers(new TextMessage(onlineUsers));
}
// 处理信息
//在UI在用js调用websocket.send()时候,会调用该方法,将message分发出去
@Override
public void handleMessage(WebSocketSession session,WebSocketMessage<?> message) throws Exception {
//发送信息给指定用户,通过session保存的用户名去匹配,
//sendMessageToUser("",new TextMessage("StartReturn"));
//发送信息给所有在线用户
sendMessageToUsers(message);
}
// 处理传输时异常
@Override
public void handleTransportError(WebSocketSession session,Throwable exception) throws Exception {
}
// 关闭 连接时
@Override
public void afterConnectionClosed(WebSocketSession session,CloseStatus closeStatus) {
//logger.debug("用户: " + session.getRemoteAddress() + " is leaving, because:" + closeStatus);
//System.out.println("用户: " + session.getRemoteAddress() + " is leaving, because:" + closeStatus);
users.remove((String) session.getAttributes().get("HTTP.SESSION.userName"));
}
/**
* 给所有在线用户发送消息
*
* @param message
*/
public void sendMessageToUsers(WebSocketMessage<?> message) {
for (WebSocketSession user:users.values()) {
try {
if (user.isOpen()) {
user.sendMessage(message);
System.out.println(user+"成功:给所有在线用户发送消息");
}
} catch (IOException e) {
System.out.println("失败:给所有在线用户发送消息");
e.printStackTrace();
}
}
}
/**
* 给某个用户发送消息
*
* @param userName
* @param message
*/
public void sendMessageToUser(String userName, TextMessage message) {
for (ConcurrentHashMap.Entry<String, WebSocketSession> user : users.entrySet()) {
if (user.getKey().equals(userName)) {
try{
if (user.getValue().isOpen()) {
user.getValue().sendMessage(message);
}
}catch (IOException e) {
e.printStackTrace();
}
break;
}
}
}
//是否支持分包
@Override
public boolean supportsPartialMessages() {
return false;
}
}
- MyHandshakeInterceptor,注意用Spring的:import org.springframework.http.server.
package demo.ssh.dbutil;
import java.util.Map;
import javax.servlet.http.HttpSession;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;
public class MyHandshakeInterceptor extends HttpSessionHandshakeInterceptor {
// 握手前
@Override
public boolean beforeHandshake(ServerHttpRequest request,ServerHttpResponse response, WebSocketHandler wsHandler,Map<String, Object> attributes) throws Exception {
//System.out.println("++++++++++++++++ HandshakeInterceptor: beforeHandshake ++++++++++++++" + attributes);
if(request instanceof ServerHttpRequest){
ServletServerHttpRequest servletRequest=(ServletServerHttpRequest) request;
//获取httpSession,用于拿到登录时保存的用户名
HttpSession session=servletRequest.getServletRequest().getSession(false);
if (session != null) {
if (this.isCopyHttpSessionId()) {
String userName = "";
if(session.getAttribute("userName")!=null){
userName = session.getAttribute("userName").toString();
}
//attributes.put("HTTP.SESSION.ID",session.getId()); // 保存 sessionid
attributes.put("HTTP.SESSION.userName",userName); // 保存 用户姓名
/*for(Object user:attributes.values()){
System.out.println(user);
}*/
//attributes.put("HTTP.SESSION.ID",session.getId());
}
}
}
//HttpServletRequest servletrequest = ServletActionContext.getRequest();
//HttpSession session = servletrequest.getSession(true);
return super.beforeHandshake(request, response, wsHandler, attributes);
}
// 握手后
@Override
public void afterHandshake(ServerHttpRequest request,ServerHttpResponse response, WebSocketHandler wsHandler,Exception ex) {
//System.out.println("++++++++++++++++ HandshakeInterceptor: afterHandshake ++++++++++++++");
super.afterHandshake(request, response, wsHandler, ex);
}
}
- WebSocketServerConfig
package demo.ssh.dbutil;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.SockJsServiceRegistration;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
@Configuration
@EnableWebSocket
public class WebSocketServerConfig implements WebSocketConfigurer {
@SuppressWarnings("unused")
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
// 添加拦截地址以及相应的websocket消息处理器
WebSocketHandlerRegistration registration = registry.addHandler(new MyWebSocketHandler(), "/pages/mess/gc","sockjs/pages/mess/gc");
SockJsServiceRegistration sockJS = registration.withSockJS();
// 添加拦截器
registration.addInterceptors(new MyHandshakeInterceptor());
}
}
- JSP
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
<%
String userName = "WebBrowser";
session.setAttribute("userName",userName);
%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<base href="<%=basePath%>">
<title>My JSP 'ConnectC#.jsp' starting page</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="pragma" content="no-cache">
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="expires" content="0">
<meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
<meta http-equiv="description" content="This is my page">
<!--
<link rel="stylesheet" type="text/css" href="styles.css">
-->
<style type="text/css">
#tb{
position:relative;
width:100%;
border:1px solid black;
border-collapse:collapse;
}
#tb th{
border:1px solid black;
width:50%;
}
#tb td{
border:1px solid black;
}
</style>
<script type="text/javascript" src="<%=basePath%>assets/js/jquery-3.1.1.min.js" ></script>
<script type="text/javascript" src="<%=basePath%>assets/js/sockjs/sockjs.min.js"></script>
<script language="javascript" type="text/javascript">
var socket;
if (!!window.WebSocket && window.WebSocket.prototype.send){
//alert("您的浏览器支持Websocket通信协议");
if( typeof(WebSocket) != "function" || typeof WebSocket == 'undefined') {
alert("您的浏览器不支持Websocket通信协议,将通过SockJS实现,若失败请更换浏览器为Chrome或者Firefox再次使用!")
socket = new SockJS('ws://192.168.2.181:8888/MES/pages/mess/gc');
}else{
socket = new WebSocket('ws://192.168.2.181:8888/MES/pages/mess/gc');
}
}else{
alert("您的浏览器不支持Websocket通信协议,请使用Chrome或者Firefox浏览器!")
}
//打开连接
socket.onopen = function(event){
console.log(event);
}
socket.onclose = function(event){
console.log(event);
}
socket.onerror = function(event){
console.log(event);
}
function chat(){
socket.send(document.getElementById("SendMessage").value);
}
//接收
socket.onmessage = function(event){
console.log(event)
//alert(event.data)
document.getElementById("GetMessage").value = event.data;
}
</script>
</head>
<body>
<input id="SendMessage" style="width:300px;height:30px;"/>
<input id="GetMessage" style="width:300px;height:30px;"/>
<input type="button" style="width:49%" value="发送" onclick="chat();">
<br><br>
</body>
</html>