172.Spring Boot WebSocket：编码分析

 

【视频&交流平台】

à SpringBoot视频

http://study.163.com/course/introduction.htm?courseId=1004329008&utm_campaign=commission&utm_source=400000000155061&utm_medium=share

à SpringCloud视频

http://study.163.com/course/introduction.htm?courseId=1004638001&utm_campaign=commission&utm_source=400000000155061&utm_medium=share

à Spring Boot源码

https://gitee.com/happyangellxq520/spring-boot

à Spring Boot交流平台

http://412887952-qq-com.iteye.com/blog/2321532

 

前言：

       在上一篇文章中讲到了WebSocket的原理，这节中我们先简单的编码分析下，这样有助于在之后的实战编码。

说明：

（1）编码中使用的Spring Boot版本是： 1.5.8；

（2） 使用WebSocket有两种方式: 第一种方式使用socketJS， 第二种方式是使用H5的标准。实例中使用的是第二种方式；

（3）最后提供源代码；

 

 

编码分析：

       在例子中，我们需要编写两端的代码：服务端和客户端（当然代码都在一个工程里）。

（1）Client：客户端说明

       客户端的代码主要是使用H5的WebSocket进行实现，在前端网页中使用WebSocket进行连接服务端，然后建立Socket连接进行通讯。

（2）Server：服务端说明

       服务端主要是建立多个客户端的关系，进行消息的中转等。客户端成功连接到服务端之后，就可以通过建立的通道进行发送消息到服务端，服务端接收到消息之后在群发给所有的客户端。

（3）客户端和服务端怎么连接？

       客户端通过JS中的WebSocket对象进行连接到服务端：

var websocket = new WebSocket("ws://localhost:8080/websocket");

   

    服务端映射出在上面使用的/websocket端点呢，使用注解@ServerEndpoint即可：

@ServerEndpoint(value = "/websocket")

   

    当客服端有连接请求了，服务端怎么接收请求，使用注解@OnOpen即可：

@OnOpen
public void onOpen(Session session) {
        this.session = session;
 }

 

 

（4）客户端和服务端怎么发送消息？

       客户端可以使用webSocket提供的send()方法，如下代码：

//获取输入的文本信息进行发送

var message = document.getElementById('text').value;
websocket.send(message);

 

     

    服务端怎么发送消息呢？主要是使用在成功建立连接的时候，创建的Session对象进行发送，如下代码：

 session.getAsyncRemote().sendText("恭喜您成功连接上WebSocket");

  

（5）客户端和服务端怎么接收消息？

       客户端接收消息消息使用的是websocket的onmessage回调方法，如下代码：

websocket.onmessage = function(event) {
           //文本信息直接显示，如果是json信息，需要转换下在显示.
       var data = event.data;
       document.getElementById('message').innerHTML += data;
}

 

       服务端怎么接收到消息，使用注解@OnMessage，如下代码：

@OnMessage
public void onMessage(String message, Session session) {
        System.out.println("来自客户端的消息:" + message);
}

 

 

（6）客户端和服务端关闭连接处理？

       客户端使用websocket.close()进行关闭连接；

       服务端使用@OnClose注解监听客户端的关闭动作。

 

（7）客户端和服务端异常处理？

       客户端当有异常信息的时候会回调方法：websocket.onerror；

       服务端使用@OnError注解监听异常信息。

 

（8）群聊原理（群发消息）

       服务端在和客户端建立连接的时候，会创建一个webSocket对象，我们会将每个连接创建的对象进行报错到一个列表中，比如：CopyOnWriteArraySet（这是线程安全的）；在要进行群发的时候，编写我们的列表对象进行群发消息。

 

（9）单聊原理（一对一消息）

       单聊的时候，就无需遍历列表，而是需要知道发送者和接受者各自的Session对象，这个Session对象怎么获取呢？Session可以获取到sessionId，发送者在发送消息的时候，携带接收消息的sessionId，那么问题就演变成了：发送者怎么知道接受者的sessionId，那就是加入一个在线用户列表即可，在线用户列表中有用户的基本信息，包括sessionId。

       明白了这些，在接下里的编码中就会轻松很多。