websocket学习总结记录_socketmap.get(key).onopen

Websocket

1.基本概念

WebSocket是一种网络通信协议。

websocket和http 的区别，http的缺陷，只能从客户端发起请求（单项请求）不能从服务器发起请求。如果服务器有连续性的变化时，如果我们想要每一个时刻都获得最新的数据时，就需要不断的由客户端发起请求不停的发起连接，就会浪费很大一部分资源。

所以websocket的诞生就是为了解决之一问题，使得服务器也可以向客户端发起请求~实现网站实时推送的需求

websocket的特点：

1.建立在tcp协议之上

2.兼容http协议，握手阶段采用http协议。

3.数据格式轻量级，可以发送文本，还可以发送二进制数据

5.没有同源限制，客户端可以和任意服务器通信

协议标识：ws（加密后为wss

总结：websocket是一种网络协议，支持服务器与客户端的全双工连接。

websocket前端往后端发送数据，

 socket.send("这是来自客户端的消息");
1

执行socket.send后对应着后端的WebSocketService.onMessage事件

websocket同时还定义了几个监听函数　　　　
　　　1、onopen 当网络连接建立时触发该事件
　　　2、onerror 当网络发生错误时触发该事件
　　　3、onclose 当websocket被关闭时触发该事件
　　　4、onmessage 当websocket接收到服务器发来的消息的时触发的事件。

在后端我们可以新建一个WebSocketService类来做整对websocket的以上四种状态来执行以下业务逻辑。

但在这之前需要导入websocket的依赖以及配置文件，很简单：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
1
2
3
4

@Configuration
public class WebSocketConfig{
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}
1
2
3
4
5
6
7

然后前端写的四个状态与后端定义的相对于

@Service
@ServerEndpoint("/imServer/{username}")
public class WebSocketService {
    public static PlayerService playerService;
    /**统计在线的人数*/
    private static int onlineCount = 0;
    /**concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。*/
    private static ConcurrentHashMap<String,WebSocketService> webSocketMap = new ConcurrentHashMap<>();
    /**与某个客户端的连接会话，需要通过它来给客户端发送数据*/
    private Session session;
    /**接收userId*/
    private String userId"";

    @OnOpen
    public void onOpen(Session session, @PathParam("username") String username){

    }

    @OnClose
    public void onClose() throws IOException {

    }

    @OnMessage
    public void onMessage(String message, Session session) throws IOException {

    }

    /**
     * 通过遍历webSocketMap当前在线人数的session向每一个在线用户推送消息
     * 实现服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        for (String s : webSocketMap.keySet()) {
            webSocketMap.get(s).session.getBasicRemote().sendText(message);
        }
    }


    /**
     * 发送自定义消息
     * */
    public static void sendInfo(String message,@PathParam("username") String toUsername) throws IOException {
        if(webSocketMap.containsKey(toUsername)){
            webSocketMap.get(toUsername).sendMessage(message);
        }else{
            System.out.println("用户"+toUsername+",不在线！");
        }
    }



    public static synchronized void addOnlineCount() {
        WebSocketService.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocketService.onlineCount--;
    }

    public static synchronize int getOnlineCount() {
        return onlineCount;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

@ServerEndpoint("/imServer/{username}")则表示前端在新建websocket的连接时需要的url

对应这里我写的，前端代码就是：

let url="http://localhost:8082/imServer/"+username;
url=url.replace("https","ws").replace("http","ws");
socket =new WebSocket(url);
//打开事件
socket.onopen = function() {

};
//获得消息事件
socket.onmessage = function(msg) {

};
//关闭事件
socket.onclose = function(msg) {

};
//发生了错误事件
socket.onerror = function() {
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

后端业务可以通过sendMessage方法向前端传送数据：包括字符串、对象、二进制位、文件。

后端sendMessage传来的数据时就会执行socket.onmessage里面的代码

---

---

---

一.WebSocket与传统的异同点

参考文章：http://blog.jobbole.com/106009/

短答案

就像Java和JavaScript，并没有什么太大的关系，但又不能说完全没关系。可以这么说：

• 命名方面，Socket是一个深入人心的概念，WebSocket借用了这一概念；
• 使用方面，完全两个东西。

长答案

Socket可以有很多意思，和IT较相关的本意大致是指 在端到端的一个连接中，这两个端叫做Socket 。对于IT从业者来说，它往往指的是TCP/IP网络环境中的两个连接端，大多数的API提供者（如操作系统，JDK）往往会提供基于这种概念的接口，所以对于开发者来说也往往是在说一种编程概念。同时，操作系统中进程间通信也有Socket的概念，但这个Socket就不是基于网络传输层的协议了。

网络中的 Socket

通常所说的Socket API，是指操作系统中（也可能不是操作系统）提供的对于传输层（TCP/UDP）抽象的接口。现行的Socket API大致都是遵循了BSD Socket规范（包括Windows）。这里称规范其实不太准确，规范其实是POSIX，但BSD Unix中对于Socket的实现被广为使用，所以成为了实际的规范。如果你要使用HTTP来构建服务，那么就不需要关心Socket，如果你想基于TCP/IP来构建服务，那么Socket可能就是你会接触到的API。

Socket

历史中使用到的Socket，包括TCP文档中使用到的Socket，其实指的是网络传输中的一端，是一个虚拟化的概念。也算是一种编程的思想。

WebSocket

w3c放弃了HTML然后有一群人（也有说是这些人供职的公司，不过官方的文档上是说的个人）创立了WHATWG组织来推动HTML语言的继续发展，同时，他们还发展了很多关于Web的技术标准，这些标准不断地被官方所接受。WebSocket就属于WHATWG发布的Web Application的一部分（即HTML5）的产物。

结论

可以把WebSocket想象成HTTP，HTTP和Socket什么关系，WebSocket和Socket就是什么关系。

也可以理解为

Socket其实并不是一个协议，而是为了方便使用TCP或UDP而抽象出来的一层，是位于应用层和传输控制层之间的一组接口。

Socket是应用层与TCP/IP协议族通信的中间软件抽象层，它是一组接口。在设计模式中，Socket其实就是一个门面模式，它把复杂的TCP/IP协议族隐藏在Socket接口后面，对用户来说，一组简单的接口就是全部，让Socket去组织数据，以符合指定的协议。

当两台主机通信时，必须通过Socket连接，Socket则利用TCP/IP协议建立TCP连接。TCP连接则更依靠于底层的IP协议，IP协议的连接则依赖于链路层等更低层次。

WebSocket则是一个典型的应用层协议。

​ Socket是传输控制层协议，WebSocket是应用层协议。

websocket详解

随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，

它实现了浏览器与服务器的全双工通信，扩展了浏览器与服务端的通信功能，使服务端也能主动向客户端发送数据。

我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通信、实时数据、订阅推送等功能的应 用。在WebSocket规范提出之前，开发人员若要实现这些实时性较强的功能，经常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。

轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会导致过多不必要的请求，浪费流量和服务器资源。

Comet技术又可以分为长轮询和流技术。长轮询改进了上述的轮询技术，减小了无用的请求。它会为某些数据设定过期时间，当数据过期后才会向服务端发送请求；这种机制适合数据的改动不是特别频繁的情况。流技术通常是指客户端使用一个隐藏的窗口与服务端建立一个HTTP长连接，服务端会不断更新连接状态以保持HTTP长连接存活；这样的话，服务端就可以通过这条长连接主动将数据发送给客户端；流技术在大并发环境下，可能会考验到服务端的性能。

这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了一定流量在相同的头部信息上，并且开发复杂度也较大。

伴随着HTML5推出的WebSocket，真正实现了Web的实时通信，使B/S模式具备了C/S模式的实时通信能力。WebSocket的工作流程是这 样的：浏览器通过JavaScript向服务端发出建立WebSocket连接的请求，在WebSocket连接建立成功后，客户端和服务端就可以通过 TCP连接传输数据。因为WebSocket连接本质上是TCP连接，不需要每次传输都带上重复的头部数据，所以它的数据传输量比轮询和Comet技术小 了很多。

JavaEE 7中出了JSR-356:Java API for WebSocket规范。不少Web容器，如Tomcat,Nginx,Jetty等都支持WebSocket。Tomcat从7.0.27开始支持 WebSocket，从7.0.47开始支持JSR-356，下面的Demo代码也是需要部署在****Tomcat7.0.47****以上的版本才能运行。

二.WebSocket示例

首先建一个javaxiangm

在pom.xml中添加Jar包依赖

<dependency>
           <groupId>javax</groupId>
           <artifactId>javaee-api</artifactId>
           <version>7.0</version>
           <scope>provided</scope>
</dependency>
1
2
3
4
5
6

客户端（Web主页）代码：

<%@ page language="java" pageEncoding="UTF-8" %>
<!DOCTYPE html>
<html>
<head>
        <title>Java后端WebSocket的Tomcat实现</title>
</head>
<body>
<h2>Hello World!</h2>
webSocket测试
<div>
    请输入发送内容:<input type="text" id="sendContent"><button id="send" οnclick="send()">发送消息</button>
    <hr>
</div>
<div>
    <button οnclick="closeWebSocket()">关闭webSocket连接</button>
</div>
<label>消息记录:</label>
<div id="message">
</div>
</body>
<script src="./js/jquery-3.2.1.min.js"></script>
<script type="text/javascript">
    function myBrowser(){
        var userAgent = navigator.userAgent; //取得浏览器的userAgent字符串
        var isOpera = userAgent.indexOf("Opera") > -1;
        //判断是否Opera浏览器
        if (isOpera) {
            return "Opera"
        };
        //判断是否Firefox浏览器
        if (userAgent.indexOf("Firefox") > -1) {
            return "Firefox";
        }
        //判断谷歌
        if (userAgent.indexOf("Chrome") > -1){
            return "Chrome";
        }
        //判断是否Safari浏览器
        if (userAgent.indexOf("Safari") > -1) {
            return "Safari";
        }
        //判断是否IE浏览器
        if (userAgent.indexOf("compatible") > -1 && userAgent.indexOf("MSIE") > -1 && !isOpera) {
            return "IE";
        };
 
    }
 
    //发送按钮保持选中
    $(document).keydown(function(event) {
        if (event.keyCode == 13) {
            $("#send").click();
        }
    });
 
        $(document).ready(function(){
        $("div").css("margin-top","50px");
    })
    var webSocket = null;
    //判断浏览器是否支持webSocket通信
    if('WebSocket' in window){
        webSocket = new WebSocket("ws://localhost:8080/webSocket");
    }else{
        alert("您的浏览器不支持webSocket通信,请升级浏览器或更换浏览器重试！")
    }
    console.log(webSocket);
    //连接发生错误的回调方法
    webSocket.onerror = function () {
             setMessageInnerHTML("WebSocket连接发生错误");
     };
    //连接成功建立的回调方法
    webSocket.onopen = function () {
           setMessageInnerHTML("WebSocket连接成功");
    }
 
    //接收到消息的回调方法
    webSocket.onmessage = function (event) {
        var message = $("#message").html();
        setMessageInnerHTML(message+event.data+"<br/>");
    }
 
    //连接关闭的回调方法
    webSocket.onclose = function () {
        setMessageInnerHTML("WebSocket连接关闭");
    }
 
    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function () {
        closeWebSocket();
    }
 
    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        $("#message").html(innerHTML+"<br/>")
    }
 
    //关闭WebSocket连接
    function closeWebSocket() {
        webSocket.close();
    }
 
    //发送消息
    function send() {
        var browser = myBrowser()
        var message = $("#sendContent").val();
        webSocket.send(browser+":   "+message);
    }
 
</script>
</html>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

Java Web后端代码

package com.deng.websocket;
 
/**
 * Created by surplusDeng on 2017/10/27.
 */
 
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
 
/**
 * @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
 * 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
 */
@ServerEndpoint("/webSocket")
public class WebSocketTest {
    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;
 
    //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户标识
    private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();
 
    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;
 
    /**
     * 连接建立成功调用的方法
     * @param session  可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
     */
    @OnOpen
    public void onOpen(Session session){
        this.session = session;
        webSocketSet.add(this);     //加入set中
        addOnlineCount();           //在线数加1
        System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());
    }
 
    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(){
        webSocketSet.remove(this);  //从set中删除
        subOnlineCount();           //在线数减1
        System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
    }
 
    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     * @param session 可选的参数
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("来自客户端的消息:" + message);
        //群发消息
        for(WebSocketTest item: webSocketSet){
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
                continue;
            }
        }
    }
 
    /**
     * 发生错误时调用
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error){
        System.out.println("发生错误");
        error.printStackTrace();
    }
 
    /**
     * session.getBasicRemote().sendText(message)发送消息到客户端getBasicRemote，同步，getAsyncRemote异步
     * 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
        //this.session.getAsyncRemote().sendText(message);
    }
 
    public static synchronized int getOnlineCount() {
        return onlineCount;
    }
 
    public static synchronized void addOnlineCount() {
        WebSocketTest.onlineCount++;
    }
 
    public static synchronized void subOnlineCount() {
        WebSocketTest.onlineCount--;
    }
 
 
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103