說明以tomcat容器為例,tomcat7以上版本開始支援websocket,JFinal內建的jetty伺服器不支援websocket
一、包依賴,tomcat7或是javaee包都行,兩者二選一,容器中已提供是以隻作為提供者
org.apache.tomcat
tomcat-websocket-api
7.0.47
provided
javax
javaee-api
7.0
二、JFinal的配置,需要一個Handler攔截websocket請求,WebSocketHandler實作如下
package com.nmtx.manager.handler;
import java.util.regex.Pattern;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.jfinal.handler.Handler;
import com.jfinal.kit.StrKit;
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);
}
}
JFinalConfig中配置
/**
* 接收處理跳轉
*/
@Override
public void configHandler(Handlers me) {
me.add(new WebSocketHandler("^/websocket"));
}
配置WebSocket處理類
package com.nmtx.manager.controller.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;
import com.jfinal.kit.JsonKit;
import com.jfinal.plugin.redis.Redis;
import com.nmtx.common.ErrorCode;
import com.nmtx.common.MessageResp;
import com.nmtx.manager.common.base.LoggerManager;
import com.nmtx.manager.model.message.Message;
import com.nmtx.manager.model.permission.User;
import com.nmtx.manager.utils.WebSocketSessionUtils;
import com.nmtx.plugins.auth.AuthUser;
import com.nmtx.utils.ModelUtils;
@ServerEndpoint("/websocket")
public class WebSocketController {
@OnOpen
public void onOpen(Session session) {
}
@OnClose
public void onClose(Session session) {
}
@OnMessage
public void onMessage(String requestJson, Session session) {
session.getBasicRemote().sendText(requestJson);
}
}
三,html5端請求
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"> <!-- for HTML5 -->
<title>Java後端WebSocket的Tomcat實作</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:8080/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.close();
}
//發送消息
function send() {
var message = document.getElementById('text').value;
websocket.send(message);
}
</script>
</html>
打包搞定