浅谈WebSocket+SpringBoot例子

目录

1.HTTP 升级特性

2.使用HTTP升级的WebSocket协议

3.WebSocket协议的优点

4.WebSocket的众多用途

5.SpringBoot+WebSocket例子                                         ​     


1.HTTP 升级特性

所谓的升级就是通过HTTP网络通讯协议升级到另一种网络通讯协议。比如:WebSocket网络通讯协议

所有的HTTP客户端(不仅是浏览器)都可以在请求中加上:

Connection:Upgrade   (表示客户端希望升级)

Upgrade:websocket    (必须指定一个或多个协议列表,这些列表都必须兼容HTTP协议。例如:IRC或者RTA)

如果服务器接受升级请求,那么将返回状态码 101 Switching Protocols

并在响应的Upgrade头中使用单个值:请求协议列表中服务器支持的第一个协议

HTTP升级的最重要的特性是:最终我们可以使用任意的协议,在升级握手完成之后,它就不再使用HTTP连接

得到上面的响应后,HTTP连接将消失,取而代之的是使用了相同的下层TCP连接的WebSocket连接

2.使用HTTP升级的WebSocket协议

WebSocket连接首先将使用非正常的HTTP协议请求以特定的模式访问一个URL。

URL模式ws和wss分别对应于HTTP的http和https。

除了Connection:Upgrade头之外,还有Upgrade:websocket头存在,将告诉服务器把连接升级为WebSocket协议

在握手完成之后,文本和二进制消息将可以同时在两个方向上进行,而不需要关闭和重建连接。

此时,这实时上与客户端和服务器的通信方式并没有区别--它们在连接上有着对等的能力,并且只是简单的节点

3.WebSocket协议的优点

  • 因为连接在端口80(ws)或者443(wss)上创建,与HTTP使用的端口相同,几乎所有的防火墙都不会阻塞WebSocket连接。
  • 因为使用HTTP进行握手,所以该协议可以自然地集成到网络浏览器和HTTP服务器中。
  • WebSocket连接关闭时将发送一个特殊的关闭消息,其中可以包含原因代码和用于解释连接被关闭原因的文本。
  • WebSocket协议可以安全地支持跨域连接,避免了Ajax和XMLHttpRequest上的限制。
  • HTTP规范要求浏览器将并发连接数限制为每个主机名两个连接,但是在握手完成之后该限制就不再存在,因为此时的连接已经不再是HTTP连接了。

4.WebSocket的众多用途

  • JavaScript聊天
  • 多人在线游戏
  • 在线股票网站
  • 在线即时新闻网站
  • 高清视频流
  • 应用程序群集节点之间的通信
  • 在应用程序之间跨网络传输大量事务数据
  • 远程系统或者软件状态和性能的实时监控        

5.SpringBoot+WebSocket例子                                              

   

模板引擎是用FreeMarker,所以需要引入依赖。还需要引入WebSocket的依赖。

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

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

先编写客户端的代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WebSocket</title>
</head>
<body>
    <input id="text" type="text"/>
    <button onclick="send()">发送消息</button>
    <hr/>
<button onclick="closeWebSocket()">关闭WebSockeet连接</button>
<hr/>
<div id="message"></div>
</body>
</html>
<script type="text/javascript">
    var  webSocket=null;

    //判断当前浏览器是否支持WebSocket
    if ('WebSocket' in window){
        webSocket=new WebSocket('ws://localhost:8080/webSocket');
    } else{
        alert("当前浏览器不支持WebSocket");
    }

    //连接发生错误的回调方法
    webSocket.onerror=function () {
        setMessageInnerHTML("WebSocket连接发生错误!");
    }

    webSocket.onopen=function () {
        setMessageInnerHTML("WebSocket连接成功!")
    }

    webSocket.onmessage=function (event) {
        setMessageInnerHTML(event.data);
    }

    webSocket.onclose=function () {
        setMessageInnerHTML("WebSocket连接关闭");
    }

    window.onbeforeunload=function () {
        closeWebSocket();
    }

    function closeWebSocket() {
        webSocket.close();
    }

    function send() {
        var message=document.getElementById('text').value;
        webSocket.send(message);
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML+=innerHTML+'<br/>';
    }
</script>

package com.example.websocket.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class clientController {

    @GetMapping("/client")
    public ModelAndView client(){
        return new ModelAndView("client");
    }
}

用SpringBoot最重要的一步是要配置WebSocket,我当初就因为没有配置搞了几个小时找错误。

package com.example.websocket.config;

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

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

   

package com.example.websocket.service;

import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.CopyOnWriteArraySet;

@Component
@ServerEndpoint("/webSocket")
public class WebSocket {

    private Session session;

    private static CopyOnWriteArraySet<WebSocket> webSockets=new CopyOnWriteArraySet<>();

    @OnOpen
    public void onOpen(Session session){
        this.session=session;
        webSockets.add(this);
        System.out.println("有新的连接,总数"+webSockets.size());
    }

    @OnClose
    public void onClose(){
        webSockets.remove(this);
        System.out.println("有新的断开,总数"+webSockets.size());
    }

    @OnMessage
    public void onMessage(String message){

        System.out.println(message);

        send(message);
    }

    public void send(String message){
        for (WebSocket webSocket:webSockets){
            try {
                webSocket.session.getBasicRemote().sendText(message);
            }catch (Exception e){
                e.printStackTrace();
            }
        }
    }

}

  期间还报了一个错误,找了很久的错误

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2018-08-02 21:21:36.933 ERROR 7844 --- [           main] o.s.boot.SpringApplication               : Application run failed

java.lang.IllegalStateException: Failed to register @ServerEndpoint class: class com.example.websocket.service.WebSocket
	at org.springframework.web.socket.server.standard.ServerEndpointExporter.registerEndpoint(ServerEndpointExporter.java:158) ~[spring-websocket-5.0.8.RELEASE.jar:5.0.8.RELEASE]
	at org.springframework.web.socket.server.standard.ServerEndpointExporter.registerEndpoints(ServerEndpointExporter.java:133) ~[spring-websocket-5.0.8.RELEASE.jar:5.0.8.RELEASE]
	at org.springframework.web.socket.server.standard.ServerEndpointExporter.afterSingletonsInstantiated(ServerEndpointExporter.java:111) ~[spring-websocket-5.0.8.RELEASE.jar:5.0.8.RELEASE]
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:776) ~[spring-beans-5.0.8.RELEASE.jar:5.0.8.RELEASE]
	at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:869) ~[spring-context-5.0.8.RELEASE.jar:5.0.8.RELEASE]
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:550) ~[spring-context-5.0.8.RELEASE.jar:5.0.8.RELEASE]
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:140) ~[spring-boot-2.0.4.RELEASE.jar:2.0.4.RELEASE]
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:762) [spring-boot-2.0.4.RELEASE.jar:2.0.4.RELEASE]
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:398) [spring-boot-2.0.4.RELEASE.jar:2.0.4.RELEASE]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:330) [spring-boot-2.0.4.RELEASE.jar:2.0.4.RELEASE]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1258) [spring-boot-2.0.4.RELEASE.jar:2.0.4.RELEASE]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1246) [spring-boot-2.0.4.RELEASE.jar:2.0.4.RELEASE]
	at com.example.websocket.WebsocketApplication.main(WebsocketApplication.java:11) [classes/:na]
Caused by: javax.websocket.DeploymentException: No Throwable parameter was present on the method [onError] of class [com.example.websocket.service.WebSocket] that was annotated with OnError
	at org.apache.tomcat.websocket.pojo.PojoMethodMapping.getPathParams(PojoMethodMapping.java:327) ~[tomcat-embed-websocket-8.5.32.jar:8.5.32]
	at org.apache.tomcat.websocket.pojo.PojoMethodMapping.<init>(PojoMethodMapping.java:187) ~[tomcat-embed-websocket-8.5.32.jar:8.5.32]
	at org.apache.tomcat.websocket.server.WsServerContainer.addEndpoint(WsServerContainer.java:147) ~[tomcat-embed-websocket-8.5.32.jar:8.5.32]
	at org.apache.tomcat.websocket.server.WsServerContainer.addEndpoint(WsServerContainer.java:234) ~[tomcat-embed-websocket-8.5.32.jar:8.5.32]
	at org.springframework.web.socket.server.standard.ServerEndpointExporter.registerEndpoint(ServerEndpointExporter.java:155) ~[spring-websocket-5.0.8.RELEASE.jar:5.0.8.RELEASE]
	... 12 common frames omitted

出现上面的报错,我在百度查找的关键词是“Failed to register @ServerEndpoint class”,但是一直没有找到可以解决的办法,白花了几个小时,最后仔细看一下报错的信息。发现:“No Throwable parameter was present on the method [onError] of class [com.example.websocket.service.WebSocket] that was annotated with OnError” 我看到onError才发现,可能是我自己加的这个方法报错了,去掉后,真的可以运行了。

原来是这样的:

运行效果(界面就没去美化它):

       

源码:

链接:https://pan.baidu.com/s/1udfGBr2Ex753ry_MNtypMw  密码:kwqm

参考:

WebSocket 教程

Java后端WebSocket的Tomcat实现

WebSocket实战之——JavaScript例子

WebSocket 详解教程

猜你喜欢

转载自blog.csdn.net/Doctor_LY/article/details/81362718
今日推荐