2020-10-31

最新推荐文章于 2024-01-24 00:13:16 发布

不懂就问`

最新推荐文章于 2024-01-24 00:13:16 发布

阅读量265

点赞数

分类专栏：笔记

本文链接：https://blog.csdn.net/weixin_45838138/article/details/109408593

版权

笔记专栏收录该内容

6 篇文章 0 订阅

订阅专栏

    *## 标题后台主动推送数据之websocket        使用

websocket是一个全双工通信协议，前端发送请求，会进行一个长连接，后台可以定时推送数据给前台或者实时推送消息给前台

1,WebSocketConfig配置
/*

- blog.coder4j.cn
- Copyright © 2016-2019 All Rights Reserved.

*/
package cn.coder4j.study.example.websocket.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;

/**

@author buhao
@version WebSocketConfig.java, v 0.1 2019-10-21 16:32 buhao
*/
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
// 配置客户端尝试连接地址
registry.addEndpoint("/ws").setAllowedOrigins("*").withSockJS();
}

@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
// 设置广播节点
registry.enableSimpleBroker("/topic", “/user”);
// 客户端向服务端发送消息需有/app 前缀
registry.setApplicationDestinationPrefixes("/app");
// 指定用户发送（一对一）的前缀 /user/
registry.setUserDestinationPrefix("/user/");
}
}
说明
通过实现 WebSocketMessageBrokerConfigurer 接口和加上@EnableWebSocketMessageBroker来进行 stomp 的配置与注解扫描。
其中覆盖 registerStompEndpoints 方法来设置暴露的 stomp 的路径，其它一些跨域、客户端之类的设置。
覆盖 **configureMessageBroker **方法来进行节点的配置。
其中 **enableSimpleBroker 配置的广播节点，也就是服务端发送消息，客户端订阅就能接收消息的节点。
覆盖setApplicationDestinationPrefixes **方法，设置客户端向服务端发送消息的节点。
覆盖 setUs

2，添加webSocketServer服务端类

package com.example.admin.web;

/**

Created by huiyunfei on 2019/5/31.
*/

@ServerEndpoint("/lsgj")
@Component
@Slf4j
public class WebSocketServer {
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();
public static long toral=0;
Lock lock=new RetrantLock()；
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;

*/

/**
* 连接建立成功调用的方法*//*
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //加入set中
//在线数加1
JSONObject jso=new JSONObject();
jso. put(“total”,total)；
this.sid=sid;
try {
session.getBasicRemote().sendText(json.toString());

        sendMessage("连接成功");
    } catch (IOException e) {
        log.error("websocket IO异常");
    }
}
*/

/**
* 连接关闭调用的方法
//
@OnClose
public void onClose() {
webSocketSet.remove(this); //从set中删除
subOnlineCount(); //在线数减1
log.info(“有一连接关闭！当前在线人数为” + getOnlineCount());
}
/
/*
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息*//*
@OnMessage
public void onMessage(String message, Session session) {
log.info(“收到来自窗口”+sid+“的信息:”+message);
//群发消息
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/
/*
*
* @param session
* @param error
//
@OnError
public void onError(Session session, Throwable error) {
log.error(“发生错误”);
error.printStackTrace();
}
/
/*
* 实现服务器主动推送
//
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/
/*
* 群发自定义消息
* //
public static void sendInfo(String message,@PathParam(“sid”) String sid) throws IOException {
log.info(“推送消息到窗口”+sid+"，推送内容:"+message);
for (WebSocketServer item : webSocketSet) {
try {
//这里可以设定只推送给这个sid的，为null则全部推送
if(sid==null) {
item.sendMessage(message);
}else if(item.sid.equals(sid)){
item.sendMessage(message);
}
} catch (IOException e) {
continue;
}
}
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount–;
}
public static CopyOnWriteArraySet getWebSocketSet() {
return webSocketSet;
}
}

1.3：添加对应的controller

搜索博文/帖子/用户
登录

不偷腥的mao
关注
springboot集成websocket的两种实现方式原创
2019-05-31 17:21:22
12点赞

不偷腥的mao

码龄10年

关注
WebSocket跟常规的http协议的区别和优缺点这里大概描述一下

一、websocket与http

http协议是用在应用层的协议，他是基于tcp协议的，http协议建立链接也必须要有三次握手才能发送信息。http链接分为短链接，长链接，短链接是每次请求都要三次握手才能发送自己的信息。即每一个request对应一个response。长链接是在一定的期限内保持链接。保持TCP连接不断开。客户端与服务器通信，必须要有客户端发起然后服务器返回结果。客户端是主动的，服务器是被动的。
WebSocket是HTML5中的协议，他是为了解决客户端发起多个http请求到服务器资源浏览器必须要经过长时间的轮训问题而生的，他实现了多路复用，他是全双工通信。在webSocket协议下客服端和浏览器可以同时发送信息。

二、HTTP的长连接与websocket的持久连接

HTTP1.1的连接默认使用长连接（persistent connection），

即在一定的期限内保持链接，客户端会需要在短时间内向服务端请求大量的资源，保持TCP连接不断开。客户端与服务器通信，必须要有客户端发起然后服务器返回结果。客户端是主动的，服务器是被动的。

在一个TCP连接上可以传输多个Request/Response消息对，所以本质上还是Request/Response消息对，仍然会造成资源的浪费、实时性不强等问题。

如果不是持续连接，即短连接，那么每个资源都要建立一个新的连接，HTTP底层使用的是TCP，那么每次都要使用三次握手建立TCP连接，即每一个request对应一个response，将造成极大的资源浪费。

长轮询，即客户端发送一个超时时间很长的Request，服务器hold住这个连接，在有新数据到达时返回Response

websocket的持久连接只需建立一次Request/Response消息对，之后都是TCP连接，避免了需要多次建立Request/Response消息对而产生的冗余头部信息。

Websocket只需要一次HTTP握手，所以说整个通讯过程是建立在一次连接/状态中，而且websocket可以实现服务端主动联系客户端，这是http做不到的。

springboot集成websocket的不同实现方式：

pom添加依赖

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

因涉及到js连接服务端，所以也写了对应的html，这里集成下thymeleaf模板，前后分离的项目这一块全都是前端做的

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

配置文件：

server:
port: 8885

#添加Thymeleaf配置
thymeleaf:
cache: false
prefix: classpath:/templates/
suffix: .html
mode: HTML5
encoding: UTF-8
content-type: text/html

1：自定义WebSocketServer，使用底层的websocket方法，提供对应的onOpen、onClose、onMessage、onError方法

1.1：添加webSocketConfig配置类

/**

开启WebSocket支持
Created by huiyunfei on 2019/5/31.
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
1.2：添加webSocketServer服务端类

package com.example.admin.web;

/**

Created by huiyunfei on 2019/5/31.
*/

@ServerEndpoint("/websocket/{sid}")
@Component
@Slf4j
public class WebSocketServer {
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();

//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;

//接收sid
private String sid="";


*/

/**
* 连接建立成功调用的方法*//*
@OnOpen
public void onOpen(Session session, @PathParam(“sid”) String sid) {
this.session = session;
webSocketSet.add(this); //加入set中
addOnlineCount(); //在线数加1
log.info(“有新窗口开始监听:”+sid+",当前在线人数为" + getOnlineCount());
this.sid=sid;
try {
sendMessage(“连接成功”);
} catch (IOException e) {
log.error(“websocket IO异常”);
}
}
/
/*
* 连接关闭调用的方法
//
@OnClose
public void onClose() {
webSocketSet.remove(this); //从set中删除
subOnlineCount(); //在线数减1
log.info(“有一连接关闭！当前在线人数为” + getOnlineCount());
}
/
/*
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息*//*
@OnMessage
public void onMessage(String message, Session session) {
log.info(“收到来自窗口”+sid+“的信息:”+message);
//群发消息
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/
/*
*
* @param session
* @param error
//
@OnError
public void onError(Session session, Throwable error) {
log.error(“发生错误”);
error.printStackTrace();
}
/
/*
* 实现服务器主动推送
//
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
/
/*
* 群发自定义消息
* //
public static void sendInfo(String message,@PathParam(“sid”) String sid) throws IOException {
log.info(“推送消息到窗口”+sid+"，推送内容:"+message);
for (WebSocketServer item : webSocketSet) {
try {
//这里可以设定只推送给这个sid的，为null则全部推送
if(sid==null) {
item.sendMessage(message);
}else if(item.sid.equals(sid)){
item.sendMessage(message);
}
} catch (IOException e) {
continue;
}
}
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount–;
}
public static CopyOnWriteArraySet getWebSocketSet() {
return webSocketSet;
}
}
1.3：添加对应的controller

@Controller
@RequestMapping("/system")
public class SystemController {
//推送数据接口
@Scheduled(fixedRate=6000)
@ResponseBody
@RequestMapping("/socket/push/{cid}")
public Map pushToWeb(@PathVariable String cid, String message) {
Map result = new HashMap();
try {
//自定义发送
WebSocketServer.sendInfo(message,cid);
result.put(“code”, 200);
result.put(“msg”, “success”);
} catch (IOException e) {
e.printStackTrace();
}
return result;