websocket学习

websocket介绍

WebSocket是一种在基于TCP连接上进行全双工通信的协议

全双工（Full Duplex）：允许数据在两个方向上同时传输
半双工（Half Duplex）：允许数据在两个方向上传输，但是同一个时间端内只允许一个方向上传输

2. websocket API

2.1 客户端API

• websocket对象创建

let ws = new WebSocket(URL);

格式：协议://ip地址/访问路径
协议：协议名称为ws

• websocket对象相关事件
  

• websocket对象提供的方法
  
  

2.2 服务端API

Tomcat的7.0.5 版本开始支持WebSocket，并且实现了JAVA WebSocket规范
Java WebSocket应用由一系列的Endpoint组成。Endpoint是一个java对象，代表WebSocket连接的一段，对于服务端，我们可以视为处理具体WebSocket消息的接口
我们可以通过两种方式定义Endpoint：
第一种是编程式，即继承类javax.websocket.Endpoint并实现其方法
第二种是注解式，即定义一个POJO，并添加@ServerEndpoint相关注解

Endpoint实例在WebSocket握手时创建，并在客户端宇服务端链接过程中有效，最后在链接关闭时结束，在Endpoint接口中明确定义了与其生命周期相关的方法，规范实现者确保生命周期的各个阶段调用实例的相关方法。生命周期方法如下：

服务端如何接受客户端发送的数据呢？

• 编程式： 通过添加MessageHandler消息处理器来接收消息
• 注解式： 在定义Endpoint时，通过@OnMessage注解指定接收消息的方法

服务器如何推送数据给客户端呢？

发送消息则由RmeoteEndpoint完成，其实例由Session维护
发送消息有2种方式发送消息
通过session.getBasicRemote 获取同步消息发送的实例，然后调用其sendXxx()方法发送消息
通过session.getAsyncRemote 获取异步消息发送实例，然后调用其sendXxx()方法发送消息

3. 在线聊天式代码

1. 引入注解

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
 </dependency>

2. 发送消息封装类

public class MessageUtils {

    public static String getMessage(boolean isSystemMessage,String fromName, Object message) {

        ResultMessage result = new ResultMessage();
        result.setSystem(isSystemMessage);
        result.setMessage(message);
        if(fromName != null) {
            result.setFromName(fromName);
        }
        return JSON.toJSONString(result);
    }
}

3. 配置类

@Configuration
public class WebsocketConfig {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

public class GetHttpSessionConfig extends ServerEndpointConfig.Configurator {

    @Override
    public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
        //获取HttpSession对象
        HttpSession httpSession = (HttpSession) request.getHttpSession();
        //将httpSession对象保存起来
        sec.getUserProperties().put(HttpSession.class.getName(),httpSession);
    }
}

4.业务类

@ServerEndpoint(value = "/chat",configurator = GetHttpSessionConfig.class)
@Component
public class ChatEndpoint {

    private static final Map<String,Session> onlineUsers = new ConcurrentHashMap<>();

    private HttpSession httpSession;

    /**
     * 建立websocket连接后，被调用
     * @param session
     */
    @OnOpen
    public void onOpen(Session session, EndpointConfig config) {
        //1，将session进行保存
        this.httpSession = (HttpSession) config.getUserProperties().get(HttpSession.class.getName());
        String user = (String) this.httpSession.getAttribute("user");
        onlineUsers.put(user,session);
        //2，广播消息。需要将登陆的所有的用户推送给所有的用户
        String message = MessageUtils.getMessage(true,null,getFriends());
        broadcastAllUsers(message);
    }

    public Set getFriends() {
        Set<String> set = onlineUsers.keySet();
        return set;
    }

    private void broadcastAllUsers(String message) {
        try {
            //遍历map集合
            Set<Map.Entry<String, Session>> entries = onlineUsers.entrySet();
            for (Map.Entry<String, Session> entry : entries) {
                //获取到所有用户对应的session对象
                Session session = entry.getValue();
                //发送消息
                session.getBasicRemote().sendText(message);
            }
        } catch (Exception e) {
            //记录日志
            e.printStackTrace();
        }
    }

    /**
     * 浏览器发送消息到服务端，该方法被调用
     *
     * 张三  -->  李四
     * @param message
     */
    @OnMessage
    public void onMessage(String message) {
        try {
            //将消息推送给指定的用户
            Message msg = JSON.parseObject(message, Message.class);
            //获取 消息接收方的用户名
            String toName = msg.getToName();
            String mess = msg.getMessage();
            //获取消息接收方用户对象的session对象
            Session session = onlineUsers.get(toName);
            String user = (String) this.httpSession.getAttribute("user");
            String msg1 = MessageUtils.getMessage(false, user, mess);
            session.getBasicRemote().sendText(msg1);
        } catch (Exception e) {
            //记录日志
        }
    }

    /**
     * 断开 websocket 连接时被调用
     * @param session
     */
    @OnClose
    public void onClose(Session session) {
        //1,从onlineUsers中剔除当前用户的session对象
        String user = (String) this.httpSession.getAttribute("user");
        onlineUsers.remove(user);
        //2,通知其他所有的用户，当前用户下线了
        String message = MessageUtils.getMessage(true,null,getFriends());
        broadcastAllUsers(message);
    }
}