Spring使用WebSocket的两种方法&公共聊天室示例

目录

1.使用内置的AbstractWebSocketHandler

2.使用websocket-api提供的注解/编程式接口

3.前端实现和测试

---

以 Spring Boot 2.1.0.RELEASE为例

1.使用内置的AbstractWebSocketHandler

该类是一个抽象类，包含于 org.springframework:spring-websocket 包中

这里引入：

    org.springframework.boot
    spring-boot-starter-websocket
    2.1.0.RELEASE

即可使用

使用时需要继承该类，根据需要重写相应方法即可

例如：

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.AbstractWebSocketHandler;

public class MyWebSocketHandler extends AbstractWebSocketHandler {
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        System.out.println("Connection established");
    }

    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage message) throws Exception {
        System.out.println("收到消息："+message);
        Thread.sleep(2000L);
        session.sendMessage(new TextMessage("Hello World!"));
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        System.out.println("Connection closed");
    }
}

 如果是Spring MVC可以在XML中配置端点映射（例如映射到/hello）：

也可以继承 AbstractWebSocketMessageBrokerConfigurer 并重写相应方法配置端点（还需要进行注入）

@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
    registry.addEndpoint("/hello").withSockJS();
}

然后就可以和网页通信了

2.使用websocket-api提供的注解/编程式接口

引入依赖：

    
          javax.websocket
          javax.websocket-api
          1.1
          provided
      

这里使用注解实现：

import Users;
import org.springframework.stereotype.Component;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;

@ServerEndpoint(value = "/chatroom/{userName}")
@Component
public class WebsocketServer {
    private Session session;
    private static int count=0;

    @OnOpen
    public void onOpen(Session session, @PathParam("userName")String userName) throws IOException {
        this.session=session;
        //Users用来存放数据，user是该类的一个静态HashMap变量
        if(Users.user.get(userName)==null) {
            Users.user.put(userName, this);
            count++;
        }
        session.getBasicRemote().sendText("系统消息：当前在线人数:"+count);
    }

    @OnMessage
    public void onMessage(String msg) throws IOException {
        for(WebsocketServer server:Users.user.values()){
            server.session.getBasicRemote().sendText(msg);
        }
    }
}

还需要注入ServerEndpointExporter：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter confServerEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

这里有一个大坑，网上的很多案例里面，@ServerEndpoint标记的类，都没有使用@Component，我在测试的时候，总是报404错误，无法连接，加上该注解后问题解决

如果是编程式实现，只要继承 javax.websocket.Endpoint 类并实现/重写相关方法，剩下的和注解式相同

3.前端实现和测试

写了两个简单页面，就不用Controller进行映射了，直接把页面放到 resource/static 下

index.html：

    
    


    

        你的名字：
        
    

chat.html：

这样就能实现一个公共聊天室了：

如果想实现私聊也很简单，稍作修改就可以，我写了个简单实现：

修改后的chat.html：

    
    
    
    









对他私聊：

主要就是增加了一个私密发送的方法

WebSocketServer类的onMessage方法略作修改即可：

    @OnMessage
    public void onMessage(String msg) throws IOException {
        if(msg.startsWith("

效果：