最近公司在搞一個項目恰好須要用到WebSocket技術來實現實時數據的傳輸,由於以前也沒接觸過,因此搗鼓了好些天,最近恰巧有空就寫寫。有誤的地方還請大牛們能及時指正。java
項目背景:基於spring+spring MVC+mybatis框架的maven項目web
服務端:spring
一、添加Jar包依賴:apache
<dependency> <groupId>javax.websocket</groupId> <artifactId>javax.websocket-api</artifactId> <version>1.1</version> <scope>provided</scope> </dependency>
2、建立一個WebSocket服務端類MyWebSocketServer,並在類前添加@ServerEndpoint(value = "/websocket")註解,@ServerEndpoint(value = "/websocket")註釋端點表示將 WebSocket 服務端運行在 ws://[Server 端 IP 或域名]:[Server 端口]/項目名/websocket 的訪問端點json
3、實現onOpen、onClose、onMessage、onError等方法api
實例代碼:瀏覽器
MyWebSocketServer 類websocket
import java.io.IOException; import javax.websocket.EncodeException; import javax.websocket.OnClose; import javax.websocket.OnError; import javax.websocket.OnMessage; import javax.websocket.OnOpen; import javax.websocket.Session; import javax.websocket.server.PathParam; import javax.websocket.server.ServerEndpoint; import org.apache.commons.lang.StringUtils; import org.apache.log4j.Logger; import net.sf.json.JSONObject; @ServerEndpoint(value = "/websocket") public class MyWebSocketServer {
private Logger logger = Logger.getLogger(MyWebSocketServer.class); private Session session; /** * 鏈接創建後觸發的方法 */ @OnOpen public void onOpen(Session session){ this.session = session; logger.info("onOpen"+session.getId()); WebSocketMapUtil.put(session.getId(),this); }
/** * 鏈接關閉後觸發的方法 */ @OnClose public void onClose(){ //從map中刪除 WebSocketMapUtil.remove(session.getId()); logger.info("====== onClose:"+session.getId()+" ======"); }
/** * 接收到客戶端消息時觸發的方法 */ @OnMessage public void onMessage(String params,Session session) throws Exception{ //獲取服務端到客戶端的通道 MyWebSocketServer myWebSocket = WebSocketMapUtil.get(session.getId()); logger.info("收到來自"+session.getId()+"的消息"+params); String result = "收到來自"+session.getId()+"的消息"+params; //返回消息給Web Socket客戶端(瀏覽器) myWebSocket.sendMessage(1,」成功!」,result); }
/** * 發生錯誤時觸發的方法 */ @OnError public void onError(Session session,Throwable error){ logger.info(session.getId()+"鏈接發生錯誤"+error.getMessage()); error.printStackTrace(); } public void sendMessage(int status,String message,Object datas) throws IOException{ JSONObject result = new JSONObject(); result.put("status", status); result.put("message", message); result.put("datas", datas); this.session.getBasicRemote().sendText(result.toString()); } }
WebSocketMapUtil 工具類java-web
import java.util.Collection; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; public class WebSocketMapUtil { public static ConcurrentMap<String, MyWebSocketServer> webSocketMap = new ConcurrentHashMap<>(); public static void put(String key, MyWebSocketServer myWebSocketServer){ webSocketMap.put(key, myWebSocketServer); } public static MyWebSocketServer get(String key){ return webSocketMap.get(key); } public static void remove(String key){ webSocketMap.remove(key); } public static Collection<MyWebSocketServer> getValues(){ return webSocketMap.values(); } }
客戶端:session
一、添加Jar包依賴:
<dependency> <groupId>org.java-websocket</groupId> <artifactId>Java-WebSocket</artifactId> <version>1.3.8</version> </dependency>
2、建立Web Socket客戶端類MyWebSocketClient,並繼承WebSocketClient
3、實現構造器,重寫onOpen、onClose、onMessage、onError等方法
實例代碼:
MyWebSocketClient 類
import java.net.URI; import org.activiti.engine.impl.util.json.JSONObject; import org.apache.log4j.Logger; import org.java_websocket.client.WebSocketClient; import org.java_websocket.handshake.ServerHandshake; public class MyWebSocketClient extends WebSocketClient{ Logger logger = Logger.getLogger(MyWebSocketClient.class); public MyWebSocketClient(URI serverUri) { super(serverUri); } @Override public void onOpen(ServerHandshake arg0) { // TODO Auto-generated method stub logger.info("------ MyWebSocket onOpen ------"); } @Override public void onClose(int arg0, String arg1, boolean arg2) { // TODO Auto-generated method stub logger.info("------ MyWebSocket onClose ------"); } @Override public void onError(Exception arg0) { // TODO Auto-generated method stub logger.info("------ MyWebSocket onError ------"); } @Override public void onMessage(String arg0) { // TODO Auto-generated method stub logger.info("-------- 接收到服務端數據: " + arg0 + "--------"); } }
MyTest 測試類
public class MyTest{ public static void main(String[] arg0){ MyWebSocketClient myClient = new MyWebSocketClient("此處爲websocket服務端URI"); // 往websocket服務端發送數據 myClient.send("此爲要發送的數據內容"); } }