最近在学习WebSocket的时候发现,当使用Struts2框架的时候发现WebSocket连接失效,浏览器Firefox(54.0.1)报错为:Firefox 无法建立到 ws://localhost/echoSocket 服务器的连接。
当然了,你不用怀疑浏览器出什么毛病了,当你使用chrome浏览器以及高版本的IE(11)浏览器的时候也报同样的错误。
下面我们就说说为什么会出现这种错误:
首先,你的Struts2在web.xml文件中的fiter-mapping配置肯定是如下的:
<filter-mapping>
<fiter-name>struts2</fiter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
这样的配置会拦截所有的http协议请求。这时你会问我的协议不是ws协议吗,为什么会被拦截?请注意:在实现websocket连线过程中,需要通过浏览器发出websocket连线请求,然后服务器发出回应,这个过程通常称为“握手” 。在 WebSocket API,浏览器和服务器只需要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快速通道。明白了吗?在通道第一次建立的时候,发送的依旧是http协议请求,只不过该http协议包含了一些关于ws协议的头信息,当整个通道建立以后,之间的通信才切换为ws协议进行通信。
这下明白为什么websocket在struts2中会产生冲突了吧。当前了,如果还不明白的请看下面解释
当strut2拦截了所有请求或者websocket的请求地址在struts2的拦截范围内。那么!!!struts2会根据该请求地址去找对应的action,那么这样的话你的action中肯定没有配置该请求地址,所有就没有返回或者返回报错,因而websocket通道建立失败。浏览器就会报出上面的错误。
解决措施:
在struts2的struts.xml中文件配置一个struts.action.excludePattern属性将该请求地址不做处理,那么struts2自然不会理睬这个请求地址,因而websocket通道自然而然的就建立起来了。
<constant name="struts.action.excludePattern" value=".*Socket"/>
请注意: value的值是正则表达式验证串,为什么要这么设计呢。请记住一句话,约定优于配置。
当然了,如果你只有一个websocket后台的话,那么你的value值的正则表达式的规则可以直接写成你的这个websocket请求地址。
如果像我上面那样写的话,那么所有以Socket结尾的websocket都不被sturts2理睬了。有意思的是,如果你的action的name值有以Socket结尾的,那么这个action就失效了,请牢记,约定优于配置。
下面给一些代码:(当然是拷贝别人的了,我怎么可能会自己动手写代码呢)
jsp页面代码:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<%
String basePath = request.getScheme() + "://" + request.getServerName() + request.getContextPath() + "/";//定位到根目录
%>
<html>
<head>
<base href="<%=basePath%>">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Insert title here</title>
<script type="text/javascript" src="plugins/jquery.js"></script>
<script type="text/javascript">
var ws;
var url = "ws://localhost/echoSocket";
function connect() {
alert("准备连接");
if ('WebSocket' in window) {
alert("创建WebSocket连接");
ws = new WebSocket(url);
} else if ('MozWebSocket' in window) {
alert("创建MozWebSocket连接");
ws = new MozWebSocket(url);
} else {
alert('WebSocket is not supported by this browser.');
return;
}
ws.onmessage = function (event) {
console.debug(event);
$("#content").append(event.data + "<br/>");
};
}
function send() {
var value = $("#msg").val();
ws.send(value);
}
</script>
</head>
<body>
<button οnclick="connect();">connect</button>
<hr/>
<input id="msg"/>
<button οnclick="send();">send</button>
<div id="content" style="border: 1px solid black; width: 200px; height: 300px;"></div>
</body>
</html>
后台WebSocket的java代码
package cn.sharek.bsg.vmi.websocket;
import java.io.IOException;
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
@ServerEndpoint(value = "/echoSocket")
public class EchoSocket {
@OnOpen
public void open(Session session) {
System.out.println("Session ID:" + session.getId());
}
@OnMessage
public void receive(Session session, String msg) {
System.out.println(msg);
try {
session.getBasicRemote().sendText("Echo:" + msg);
} catch (IOException e) {
e.printStackTrace();
}
}
@OnClose
public void close(Session session) {
System.out.println(session.getId() + " session 关闭");
}
}
请注意,这里没有什么WebSocket配置类。因为没有那个类也能用,只不过所有的websocket类都会被注册到tomcat中去。如果要加配置类也只是为了指定哪些websocket不注册或者是对指定的websocket做一些特别的处理,因而在无特殊要求的情况下也没有必要使用WebSocket配置类。