前端代码:打开会话通道
<html>
<head>
<meta charset="UTF-8"> <!-- for HTML5 -->
<title>WebSocket实现</title>
</head>
<body>
Welcome<br/>
<input id="text" type="text"/>
<button onclick="send()">发送消息</button>
<hr/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<hr/>
<div id="message"></div>
</body>
<script type="text/javascript">
var websocket = null;
//判断当前浏览器是否支持WebSocket
if ('WebSocket' in window) {
websocket = new WebSocket("ws://localhost:8081/websocket");
}
else {
alert('当前浏览器 Not support websocket')
}
//连接发生错误的回调方法
websocket.onerror = function () {
setMessageInnerHTML("WebSocket连接发生错误");
};
//连接成功建立的回调方法
websocket.onopen = function () {
setMessageInnerHTML("WebSocket连接成功");
}
//接收到消息的回调方法
websocket.onmessage = function (event) {
setMessageInnerHTML(event.data);
}
//连接关闭的回调方法
websocket.onclose = function () {
setMessageInnerHTML("WebSocket连接关闭");
}
//监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
window.onbeforeunload = function () {
closeWebSocket();
}
//将消息显示在网页上
function setMessageInnerHTML(innerHTML) {
document.getElementById('message').innerHTML += innerHTML + '<br/>';
}
//关闭WebSocket连接
function closeWebSocket() {
websocket.send(message);
websocket.close();
}
//发送消息
function send() {
var message = document.getElementById('text').value;
websocket.send(message);
}
</script>
</html>
后台引用依赖:(不管是Spring 还是其他框架 都是一样的步骤,可自行根据框架引入对应的依赖,这里是 Jfinal框架举例:)
//pom.xml 依赖
<!-- webSocket 开始-->
<dependency>
<groupId>org.apache.tomcat</groupId>
<artifactId>tomcat-websocket-api</artifactId>
<version>7.0.47</version>
<scope>provided</scope>
</dependency>
<!-- webSocket 结束-->
创建 Handler 处理器
package com.simpro.handler;/**
* @ClassName WebSocketHandler
* @Description 这里是方法描述
* @Author 爬山虎的JUE
* @Date DATE{TIME}
*/
import com.jfinal.handler.Handler;
import com.jfinal.kit.StrKit;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.regex.Pattern;
public class WebSocketHandler extends Handler {
private Pattern filterUrlRegxPattern;
public WebSocketHandler(String filterUrlRegx) {
if (StrKit.isBlank(filterUrlRegx))
throw new IllegalArgumentException("The para filterUrlRegx can not be blank.");
filterUrlRegxPattern = Pattern.compile(filterUrlRegx);
}
@Override
public void handle(String target, HttpServletRequest request, HttpServletResponse response, boolean[] isHandled) {
if (filterUrlRegxPattern.matcher(target).find())
return ;
else
next.handle(target, request, response, isHandled);
}
}
配置Handler处理器,这里就是一句话加入刚刚创建的Handler,根据自己的框架可能配置不同
me.add(new WebSocketHandler("^/websocket"));
这里就是后台与前端会话打通,握手的关键地方了,后台创建Web Socket类
package com.simpro.websocket;/**
* @ClassName WebSocket
* @Description 这里是方法描述
* @Author 爬山虎的JUE
* @Date DATE{TIME}
*/
import com.jfinal.core.Controller;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import javax.servlet.http.HttpSession;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
/**
* @ClassName WebSocketController
* @Create 2019-07-15 17:51
*/
@ServerEndpoint("/websocket")
public class WebSocketController extends Controller {
// 与某个客户端的连接会话,需要通过它来给客户端发送数据
public static Map<String,Session> sessionMap = new HashMap<String,Session>();
@OnOpen
public void onOpen(Session session) {
System.out.println("****serverClients.size()****" + sessionMap.size());
System.out.println("连接打开了OPEN");
}
/**
* 收到客户端消息时触发
*/
@OnMessage
public void onMessage(Session session, String key) throws IOException {
//向客户端返回发送过来的消息
System.out.println("收到一条消息:--" + key);
//第一次握手的Session通道
this.sessionMap.put(key,session);
//给当前通道及时回复
session.getBasicRemote().sendText("统一回复1:" + key);//推送发送的消息
//
}
/**
* 异常时触发
*/
@OnError
public void onError(Throwable throwable, Session session) {
}
/**
* 关闭连接时触发
*/
@OnClose
public void onClose(Session session) {
System.out.println("连接关闭了~~~~(>_<)~~~~");
//wang.clear();
}
public void sendTextMsg(String name,String msg) throws IOException {
System.out.println("进入到这个msg");
if(sessionMap.size()>0) {
sessionMap.get(name).getBasicRemote().sendText(msg);
}
}
public void sendObjectMsg(String name,Object msg) throws IOException, EncodeException {
System.out.println("进入到这个msg");
sessionMap.get(name).getBasicRemote().sendObject(msg);
}
}
留下最关键的一句话:有的同志前后台能打开通道了,也可以发送回复消息了,但是不能只在这一个方法类里边使用啊,还得通过其他业务层的处理,然后发送给前端通道。这个地方讲述一下WebSocket怎么被其他业务层调用,然后不断地发送消息给前端的。
- 前端打开通道,会触发后端的 onOpen(Session session) 方法
- 前端第一次与后端回话,触发 onMessage(Session session, String key),此时可以携带一个识别符key (key可以是当前登陆的用户名、ID、IP等等....),通过这个key与当前的Session信息绑定,我们成称为一个握手的会话通道
- 很多业务场景是有很多的用户来请求打开通道,只要是握手成功打开通道之后,我这里是在第一次给后台发送消息会话的时候,把这个会话通道存到
public static Map<String,Session> sessionMap = new HashMap<String,Session>();sessionMap 里边。key的值就是 onMessage(Session session, String key)识别符key,同样也是登陆后台系统的用户名。
- 业务调用直接通过sessionMap 获取想要发送消息的那个通道,直接在 sendTextMsg()方法中调用就可以发送到前台了