java 实现websocket的两种方式

2022-10-29 10:11:34

简单说明

1.两种方式，一种使用tomcat的websocket实现，一种使用spring的websocket

2.tomcat的方式需要tomcat 7.x，JEE7的支持。

3.spring与websocket整合需要spring 4.x，并且使用了socketjs，对不支持websocket的浏览器可以模拟websocket使用

方式一：tomcat

使用这种方式无需别的任何配置，只需服务端一个处理类，

服务器端代码

  1. package com.Socket;
  2. import java.io.IOException;
  3. import java.util.Map;
  4. import java.util.concurrent.ConcurrentHashMap;
  5. import javax.websocket.*;
  6. import javax.websocket.server.PathParam;
  7. import javax.websocket.server.ServerEndpoint;
  8. import net.sf.json.JSONObject;
  9. @ServerEndpoint("/websocket/{username}")
  10. public class WebSocket {
  11. private static int onlineCount = 0;
  12. private static Map<String, WebSocket> clients = new ConcurrentHashMap<String, WebSocket>();
  13. private Session session;
  14. private String username;
  15. @OnOpen
  16. public void onOpen(@PathParam("username") String username, Session session) throws IOException {
  17. this.username = username;
  18. this.session = session;
  19. addOnlineCount();
  20. clients.put(username, this);
  21. System.out.println("已连接");
  22. }
  23. @OnClose
  24. public void onClose() throws IOException {
  25. clients.remove(username);
  26. subOnlineCount();
  27. }
  28. @OnMessage
  29. public void onMessage(String message) throws IOException {
  30. JSONObject jsonTo = JSONObject.fromObject(message);
  31. if (!jsonTo.get("To").equals("All")){
  32. sendMessageTo("给一个人", jsonTo.get("To").toString());
  33. }else{
  34. sendMessageAll("给所有人");
  35. }
  36. }
  37. @OnError
  38. public void onError(Session session, Throwable error) {
  39. error.printStackTrace();
  40. }
  41. public void sendMessageTo(String message, String To) throws IOException {
  42. // session.getBasicRemote().sendText(message);
  43. //session.getAsyncRemote().sendText(message);
  44. for (WebSocket item : clients.values()) {
  45. if (item.username.equals(To) )
  46. item.session.getAsyncRemote().sendText(message);
  47. }
  48. }
  49. public void sendMessageAll(String message) throws IOException {
  50. for (WebSocket item : clients.values()) {
  51. item.session.getAsyncRemote().sendText(message);
  52. }
  53. }
  54. public static synchronized int getOnlineCount() {
  55. return onlineCount;
  56. }
  57. public static synchronized void addOnlineCount() {
  58. WebSocket.onlineCount++;
  59. }
  60. public static synchronized void subOnlineCount() {
  61. WebSocket.onlineCount--;
  62. }
  63. public static synchronized Map<String, WebSocket> getClients() {
  64. return clients;
  65. }
  66. }

客户端js

  1. var websocket = null;
  2. var username = localStorage.getItem("name");
  3. //判断当前浏览器是否支持WebSocket
  4. if ('WebSocket' in window) {
  5. websocket = new WebSocket("ws://" + document.location.host + "/WebChat/websocket/" + username + "/"+ _img);
  6. } else {
  7. alert('当前浏览器 Not support websocket')
  8. }
  9. //连接发生错误的回调方法
  10. websocket.onerror = function() {
  11. setMessageInnerHTML("WebSocket连接发生错误");
  12. };
  13. //连接成功建立的回调方法
  14. websocket.onopen = function() {
  15. setMessageInnerHTML("WebSocket连接成功");
  16. }
  17. //接收到消息的回调方法
  18. websocket.onmessage = function(event) {
  19. setMessageInnerHTML(event.data);
  20. }
  21. //连接关闭的回调方法
  22. websocket.onclose = function() {
  23. setMessageInnerHTML("WebSocket连接关闭");
  24. }
  25. //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
  26. window.onbeforeunload = function() {
  27. closeWebSocket();
  28. }
  29. //关闭WebSocket连接
  30. function closeWebSocket() {
  31. websocket.close();
  32. }

发送消息只需要使用websocket.send("发送消息")，就可以触发服务端的onMessage()方法，当连接时，触发服务器端onOpen()方法，此时也可以调用发送消息的方法去发送消息。关闭websocket时，触发服务器端onclose()方法，此时也可以发送消息，但是不能发送给自己，因为自己的已经关闭了连接，但是可以发送给其他人。

方法二：spring整合

此方式基于spring mvc框架，相关配置可以看我的相关博客文章

WebSocketConfig.java

这个类是配置类，所以需要在spring mvc配置文件中加入对这个类的扫描，第一个addHandler是对正常连接的配置，第二个是如果浏览器不支持websocket，使用socketjs模拟websocket的连接。

  1. package com.websocket;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.web.socket.config.annotation.EnableWebSocket;
  5. import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
  6. import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
  7. import org.springframework.web.socket.handler.TextWebSocketHandler;
  8. @Configuration
  9. @EnableWebSocket
  10. public class WebSocketConfig implements WebSocketConfigurer {
  11. @Override
  12. public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
  13. registry.addHandler(chatMessageHandler(),"/webSocketServer").addInterceptors(new ChatHandshakeInterceptor());
  14. registry.addHandler(chatMessageHandler(), "/sockjs/webSocketServer").addInterceptors(new ChatHandshakeInterceptor()).withSockJS();
  15. }
  16. @Bean
  17. public TextWebSocketHandler chatMessageHandler(){
  18. return new ChatMessageHandler();
  19. }
  20. }

ChatHandshakeInterceptor.java

这个类的作用就是在连接成功前和成功后增加一些额外的功能，Constants.java类是一个工具类，两个常量。

  1. package com.websocket;
  2. import java.util.Map;
  3. import org.apache.shiro.SecurityUtils;
  4. import org.springframework.http.server.ServerHttpRequest;
  5. import org.springframework.http.server.ServerHttpResponse;
  6. import org.springframework.web.socket.WebSocketHandler;
  7. import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;
  8. public class ChatHandshakeInterceptor extends HttpSessionHandshakeInterceptor {
  9. @Override
  10. public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
  11. Map<String, Object> attributes) throws Exception {
  12. System.out.println("Before Handshake");
  13. /*
  14. * if (request instanceof ServletServerHttpRequest) {
  15. * ServletServerHttpRequest servletRequest = (ServletServerHttpRequest)
  16. * request; HttpSession session =
  17. * servletRequest.getServletRequest().getSession(false); if (session !=
  18. * null) { //使用userName区分WebSocketHandler，以便定向发送消息 String userName =
  19. * (String) session.getAttribute(Constants.SESSION_USERNAME); if
  20. * (userName==null) { userName="default-system"; }
  21. * attributes.put(Constants.WEBSOCKET_USERNAME,userName);
  22. *
  23. * } }
  24. */
  25. //使用userName区分WebSocketHandler，以便定向发送消息(使用shiro获取session,或是使用上面的方式)
  26. String userName = (String) SecurityUtils.getSubject().getSession().getAttribute(Constants.SESSION_USERNAME);
  27. if (userName == null) {
  28. userName = "default-system";
  29. }
  30. attributes.put(Constants.WEBSOCKET_USERNAME, userName);
  31. return super.beforeHandshake(request, response, wsHandler, attributes);
  32. }
  33. @Override
  34. public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
  35. Exception ex) {
  36. System.out.println("After Handshake");
  37. super.afterHandshake(request, response, wsHandler, ex);
  38. }
  39. }

ChatMessageHandler.java

这个类是对消息的一些处理，比如是发给一个人，还是发给所有人，并且前端连接时触发的一些动作

  1. package com.websocket;
  2. import java.io.IOException;
  3. import java.util.ArrayList;
  4. import org.apache.log4j.Logger;
  5. import org.springframework.web.socket.CloseStatus;
  6. import org.springframework.web.socket.TextMessage;
  7. import org.springframework.web.socket.WebSocketSession;
  8. import org.springframework.web.socket.handler.TextWebSocketHandler;
  9. public class ChatMessageHandler extends TextWebSocketHandler {
  10. private static final ArrayList<WebSocketSession> users;// 这个会出现性能问题，最好用Map来存储，key用userid
  11. private static Logger logger = Logger.getLogger(ChatMessageHandler.class);
  12. static {
  13. users = new ArrayList<WebSocketSession>();
  14. }
  15. /**
  16. * 连接成功时候，会触发UI上onopen方法
  17. */
  18. @Override
  19. public void afterConnectionEstablished(WebSocketSession session) throws Exception {
  20. System.out.println("connect to the websocket success......");
  21. users.add(session);
  22. // 这块会实现自己业务，比如，当用户登录后，会把离线消息推送给用户
  23. // TextMessage returnMessage = new TextMessage("你将收到的离线");
  24. // session.sendMessage(returnMessage);
  25. }
  26. /**
  27. * 在UI在用js调用websocket.send()时候，会调用该方法
  28. */
  29. @Override
  30. protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
  31. sendMessageToUsers(message);
  32. //super.handleTextMessage(session, message);
  33. }
  34. /**
  35. * 给某个用户发送消息
  36. *
  37. * @param userName
  38. * @param message
  39. */
  40. public void sendMessageToUser(String userName, TextMessage message) {
  41. for (WebSocketSession user : users) {
  42. if (user.getAttributes().get(Constants.WEBSOCKET_USERNAME).equals(userName)) {
  43. try {
  44. if (user.isOpen()) {
  45. user.sendMessage(message);
  46. }
  47. } catch (IOException e) {
  48. e.printStackTrace();
  49. }
  50. break;
  51. }
  52. }
  53. }
  54. /**
  55. * 给所有在线用户发送消息
  56. *
  57. * @param message
  58. */
  59. public void sendMessageToUsers(TextMessage message) {
  60. for (WebSocketSession user : users) {
  61. try {
  62. if (user.isOpen()) {
  63. user.sendMessage(message);
  64. }
  65. } catch (IOException e) {
  66. e.printStackTrace();
  67. }
  68. }
  69. }
  70. @Override
  71. public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
  72. if (session.isOpen()) {
  73. session.close();
  74. }
  75. logger.debug("websocket connection closed......");
  76. users.remove(session);
  77. }
  78. @Override
  79. public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
  80. logger.debug("websocket connection closed......");
  81. users.remove(session);
  82. }
  83. @Override
  84. public boolean supportsPartialMessages() {
  85. return false;
  86. }
  87. }

spring-mvc.xml

正常的配置文件，同时需要增加对WebSocketConfig.java类的扫描，并且增加

  1. xmlns:websocket="http://www.springframework.org/schema/websocket"
  2. http://www.springframework.org/schema/websocket
  3. <a target="_blank" href="http://www.springframework.org/schema/websocket/spring-websocket-4.1.xsd">http://www.springframework.org/schema/websocket/spring-websocket-4.1.xsd</a>

客户端

  1. <script type="text/javascript"
  2. src="http://localhost:8080/Bank/js/sockjs-0.3.min.js"></script>
  3. <script>
  4. var websocket;
  5. if ('WebSocket' in window) {
  6. websocket = new WebSocket("ws://" + document.location.host + "/Bank/webSocketServer");
  7. } else if ('MozWebSocket' in window) {
  8. websocket = new MozWebSocket("ws://" + document.location.host + "/Bank/webSocketServer");
  9. } else {
  10. websocket = new SockJS("http://" + document.location.host + "/Bank/sockjs/webSocketServer");
  11. }
  12. websocket.onopen = function(evnt) {};
  13. websocket.onmessage = function(evnt) {
  14. $("#test").html("(<font color='red'>" + evnt.data + "</font>)")
  15. };
  16. websocket.onerror = function(evnt) {};
  17. websocket.onclose = function(evnt) {}
  18. $('#btn').on('click', function() {
  19. if (websocket.readyState == websocket.OPEN) {
  20. var msg = $('#id').val();
  21. //调用后台handleTextMessage方法
  22. websocket.send(msg);
  23. } else {
  24. alert("连接失败!");
  25. }
  26. });
  27. </script>

注意导入socketjs时要使用地址全称，并且连接使用的是http而不是websocket的ws

上一篇：Windows无法安装到这个磁盘。请确保在计算机的BIOS菜单中启用了磁盘控制器


下一篇：Java新建线程的两种方式