springboot2.2.X手册:5分钟用Netty搭建高性能异步WebSocket服务
yuyutoo 2024-10-12 01:40 25 浏览 0 评论
溪云阁：专注编程教学，架构，JAVA，Python，微服务，机器学习等领域，欢迎关注，一起学习。
断更快两个月了，6月份工作忙到飞起，7月份家里又有事，已经累到躺下就想睡觉的程度了。
现在我们做WebSocket服务，很多时候都是会整合Netty作为服务器，但是有个问题，就是发现网上的整合起来，比较繁琐，各种配置，各种对应，最关键是千篇一律的网文，看得好辛苦了，今天咱们来介绍一个开源的组件，帮你快速搭建基于Netty的WebSocket服务，让你更加轻松，更加专注于业务开发。
组件介绍
netty-websocket-spring-boot-starter是基于Netty服务器来做的WebSocket服务器，不需要配置Netty服务器信息，只需要配置Webscoket的注解就行，目前用起来还是很方便的。
加载包体
<?xml version="1.0"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.boots</groupId>
<artifactId>boots</artifactId>
<version>1.1.0.RELEASE</version>
</parent>
<groupId>boots.weboscket</groupId>
<artifactId>boots-weboscket</artifactId>
<version>2.0.0.RELEASE</version>
<name>boots-weboscket</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<!-- 公共组件：swagger服务+入参出参+统一异常拦截 -->
<dependency>
<groupId>com.boots</groupId>
<artifactId>module-boots-api</artifactId>
<version>2.0.0.RELEASE</version>
</dependency>
<!-- netty工具类 -->
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
</dependency>
<!-- netty-websocket整合工具类 -->
<dependency>
<groupId>org.yeauty</groupId>
<artifactId>netty-websocket-spring-boot-starter</artifactId>
<version>0.9.5</version>
</dependency>
</dependencies>
</project>
配置文件
######配置基本信息######
##配置应用名称
spring.application.name: boots-websocket
##配置时间格式,为了避免精度丢失,全部换成字符串
spring.jackson.timeZone: GMT+8
spring.jackson.dateFormat: yyyy-MM-dd HH:mm:ss
spring.jackson.generator.writeNumbersAsStrings: true单个推送后端代码
/**
* All rights Reserved, Designed By 林溪
* Copyright: Copyright(C) 2016-2020
* Company 溪云阁 .
*/
package com.boots.websocket.websocket;
import org.yeauty.annotation.OnClose;
import org.yeauty.annotation.OnError;
import org.yeauty.annotation.OnMessage;
import org.yeauty.annotation.OnOpen;
import org.yeauty.annotation.ServerEndpoint;
import org.yeauty.pojo.Session;
import com.module.boots.exception.CommonRuntimeException;
import io.netty.handler.codec.http.HttpHeaders;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
/**
* 单个推送服务
* @author：溪云阁
* @date：2020年8月4日
*/
@Slf4j
@ServerEndpoint(path = "/SingleSocket", host = "127.0.0.1", port = "8900")
public class SingleSocket {
/**
* 新建WebSocket的时候，执行该方法
* @author 溪云阁
* @param session
* @param headers void
*/
@OnOpen
@SneakyThrows(CommonRuntimeException.class)
public void onOpen(Session session, HttpHeaders headers) {
log.info("WebSocket服务连接成功");
}
/**
* 关闭WebSocket的时候，执行该方法
* @author 溪云阁
* @param session void
*/
@OnClose
@SneakyThrows(CommonRuntimeException.class)
public void onClose(Session session) {
log.info("WebSocket服务关闭成功");
}
/**
* WebSocket发生异常的时候，执行该方法
* @author 溪云阁
* @param session
* @param th void
*/
@OnError
public void onError(Session session, Throwable th) {
log.error("{}", th.fillInStackTrace());
th.printStackTrace();
}
/**
* WebSocket接收到的消息为字符串的时候，指定该方法
* @author 溪云阁
* @param session
* @param msg void
*/
@OnMessage
@SneakyThrows(CommonRuntimeException.class)
public void OnMessage(Session session, String msg) {
log.info("接收到的信息：{}", msg);
session.sendText(msg);
}
}
单个推送前端页面
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>单个推送</title>
<meta name="renderer" content="webkit">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link rel="stylesheet" href="/layui/css/layui.css" media="all">
</head>
<body>
<fieldset class="layui-elem-field layui-field-title" style="margin-top: 20px; margin-left: 310px; margin-right: 310px">
<legend>输出内容</legend>
</fieldset>
<form class="layui-form" action="" style="margin-left: 200px; margin-right: 310px">
<div class="layui-form-item layui-form-text">
<div class="layui-input-block">
<textarea placeholder="请输入内容" class="layui-textarea" rows="20" id="contentArea"></textarea>
</div>
</div>
</form>
<form class="layui-form layui-form-pane" style="margin-left: 310px; margin-right: 310px" action="">
<div class="layui-form-item">
<label class="layui-form-label">输入</label>
<div class="layui-input-block">
<input type="text" name="content" id="content" autocomplete="off" placeholder="请输入内容" class="layui-input">
</div>
</div>
</form>
<div class="layui-form-item" style="margin-left: 310px; margin-right: 310px">
<button class="layui-btn" onclick="sendMsg()">发送</button>
</div>
<script src="/js/jquery.min.js" ></script>
<script src="/layui/layui.js" charset="utf-8"></script>
<script>
var websocket = new WebSocket("ws://127.0.0.1:8900/SingleSocket");
//WebSocket打开
websocket.onopen = function(evt) {
$('#contentArea').html("WebSocket服务连接成功");
};
//WebSocket推送
websocket.onmessage = function(evt) {
var val = $('#contentArea').val() + "
";
$('#contentArea').html(val + evt.data);
};
//WebSocket关闭
websocket.onclose = function(evt) {
$('#contentArea').html("WebSocket服务关闭成功");
};
function sendMsg() {
var text = $('#content').val();
websocket.send(text);
}
</script>
</body>
</html>群发推送后端代码
/**
* All rights Reserved, Designed By 林溪
* Copyright: Copyright(C) 2016-2020
* Company 溪云阁 .
*/
package com.boots.websocket.websocket;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.yeauty.annotation.OnClose;
import org.yeauty.annotation.OnError;
import org.yeauty.annotation.OnMessage;
import org.yeauty.annotation.OnOpen;
import org.yeauty.annotation.ServerEndpoint;
import org.yeauty.pojo.Session;
import com.module.boots.exception.CommonRuntimeException;
import io.netty.handler.codec.http.HttpHeaders;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
/**
* 群组推送服务
* @author：溪云阁
* @date：2020年8月4日
*/
@Slf4j
@ServerEndpoint(path = "/groupSocket", host = "127.0.0.1", port = "8901")
public class GroupSocket {
// 定义存放Session的缓存对象
private Map<String, Session> map = new ConcurrentHashMap<>();
/**
* 新建WebSocket的时候，执行该方法
* @author 溪云阁
* @param session
* @param headers void
*/
@OnOpen
@SneakyThrows(CommonRuntimeException.class)
public void onOpen(Session session, HttpHeaders headers) {
// 把Session放到缓存中，后面群发使用
map.put(session.id().toString(), session);
log.info("WebSocket服务连接成功");
}
/**
* 关闭WebSocket的时候，执行该方法
* @author 溪云阁
* @param session void
*/
@OnClose
@SneakyThrows(CommonRuntimeException.class)
public void onClose(Session session) {
// 当关闭的时候，删除缓存中的session
if (map.containsKey(session.id().toString())) {
map.remove(session.id().toString());
}
log.info("WebSocket服务关闭成功");
}
/**
* WebSocket发生异常的时候，执行该方法
* @author 溪云阁
* @param session
* @param th void
*/
@OnError
public void onError(Session session, Throwable th) {
log.error("{}", th.fillInStackTrace());
th.printStackTrace();
}
/**
* WebSocket接收到的消息为字符串的时候，指定该方法
* @author 溪云阁
* @param session
* @param msg void
*/
@OnMessage
@SneakyThrows(CommonRuntimeException.class)
public void OnMessage(String msg) {
map.forEach((key, session) -> {
log.info("接收到的信息：{}", msg);
session.sendText(msg);
});
}
}
群发推送前端页面
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>群发推送</title>
<meta name="renderer" content="webkit">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link rel="stylesheet" href="/layui/css/layui.css" media="all">
</head>
<body>
<fieldset class="layui-elem-field layui-field-title" style="margin-top: 20px; margin-left: 310px; margin-right: 310px">
<legend>输出内容</legend>
</fieldset>
<form class="layui-form" action="" style="margin-left: 200px; margin-right: 310px">
<div class="layui-form-item layui-form-text">
<div class="layui-input-block">
<textarea placeholder="请输入内容" class="layui-textarea" rows="10" id="contentArea1"></textarea>
</div>
</div>
</form>
<form class="layui-form" action="" style="margin-left: 200px; margin-right: 310px">
<div class="layui-form-item layui-form-text">
<div class="layui-input-block">
<textarea placeholder="请输入内容" class="layui-textarea" rows="10" id="contentArea2"></textarea>
</div>
</div>
</form>
<form class="layui-form layui-form-pane" style="margin-left: 310px; margin-right: 310px" action="">
<div class="layui-form-item">
<label class="layui-form-label">输入</label>
<div class="layui-input-block">
<input type="text" name="content" id="content" autocomplete="off" placeholder="请输入内容" class="layui-input">
</div>
</div>
</form>
<div class="layui-form-item" style="margin-left: 310px; margin-right: 310px">
<button class="layui-btn" onclick="sendMsg()">发送</button>
</div>
<script src="/js/jquery.min.js" ></script>
<script src="/layui/layui.js" charset="utf-8"></script>
<script>
var websocket1 = new WebSocket("ws://127.0.0.1:8901/groupSocket");
var websocket2 = new WebSocket("ws://127.0.0.1:8901/groupSocket");
//第一个WebSocket打开
websocket1.onopen = function(evt) {
$('#contentArea1').html("第一个WebSocket服务连接成功");
};
//第一个WebSocket推送
websocket1.onmessage = function(evt) {
var val = $('#contentArea1').val() + "
";
$('#contentArea1').html(val + evt.data);
};
//第一个WebSocket关闭
websocket1.onclose = function(evt) {
$('#contentArea1').html("第一个WebSocket服务关闭成功");
};
//第二个WebSocket打开
websocket2.onopen = function(evt) {
$('#contentArea2').html("第二个WebSocket服务连接成功");
};
//第二个WebSocket推送
websocket2.onmessage = function(evt) {
var val = $('#contentArea2').val() + "
";
$('#contentArea2').html(val + evt.data);
};
//第二个WebSocket关闭
websocket2.onclose = function(evt) {
$('#contentArea2').html("第二个WebSocket服务关闭成功");
};
function sendMsg() {
var text = $('#content').val();
websocket1.send(text);
websocket2.send(text);
}
</script>
</body>
</html>启动类
package com.boots.websocket;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
/**
* 服务启动类
* @author：溪云阁
* @date：2020年5月2日
*/
@SpringBootApplication
@ComponentScan(basePackages = { "com.module", "com.boots" })
public class BootsWebSocketApplication {
public static void main(String[] args) {
SpringApplication.run(BootsWebSocketApplication.class, args);
}
}
单个推送测试
群发推送测试
总结及拓展
相比于需要自己整合Netty的配置，目前用起来还是很方便的，Netty的配置可以在注解类ServerEndpoint看到，里面一进去就会发现还是很清楚的。
目前发现有个不足的，就是超过一定时间不连接的时候，就会自动断开，不过这个可以在前端做个超时设置或者心跳检测，就可以了，问题不大，用起来还是很爽的。
--END--
作者：@溪云阁
原创作品，抄袭必究
如需要源码，转发，关注后私信我
部分图片或代码来源网络，如侵权请联系删除，谢谢！
历史文章
springboot2.2.X手册：抛弃ELK，百亿日志+调用链的Easylog很放心
springboot2.2.X手册：Eureka不更，Consul被禁，启用Nacos
springboot2.2.X手册：构建全局唯一的短链接数据中心
springboot2.2.X手册：放弃fastdfs，整合Minio做文件服务器真香
springboot2.2.X手册：分布式系统下，重复提交的解决方案
springboot2.2.X手册：Easypoi导出excel，最新版的手感香不香？
springboot2.2.X手册：项目从100M瘦身到100K，部署省事多了！
springboot2.2.X手册：redis的7种类型100个方法全解析
springboot2.2.X手册：是时候用Lettuce替换Jedis操作Redis缓存了
springboot2.2.X手册：构建多元化的API接口，我们这样子设计
springboot2.2.X手册：基于Jasypt的JavaConfig方式敏感信息加密
springboot2.2.X手册：整合最新版MybatisPlus 3.3.1版本
springboot2.2.X手册：对象复制哪种最快？7种复制方式性能对比
相关推荐
- ETCD 故障恢复（etc常见故障）
-
概述Kubernetes集群外部ETCD节点故障，导致kube-apiserver无法启动。...
- 在Ubuntu 16.04 LTS服务器上安装FreeRADIUS和Daloradius的方法
-
FreeRADIUS为AAARadiusLinux下开源解决方案，DaloRadius为图形化web管理工具。...
- 如何排查服务器被黑客入侵的迹象（黑客 抓取服务器数据）
-
---排查服务器是否被黑客入侵需要系统性地检查多个关键点，以下是一份详细的排查指南，包含具体命令、工具和应对策略：---###**一、快速初步检查**####1.**检查异常登录记录**...
- 使用 Fail Ban 日志分析 SSH 攻击行为
-
通过分析`fail2ban`日志可以识别和应对SSH暴力破解等攻击行为。以下是详细的操作流程和关键分析方法：---###**一、Fail2ban日志位置**Fail2ban的日志路径因系统配置...
- 《5 个实用技巧，提升你的服务器安全性，避免被黑客盯上!》
-
服务器的安全性至关重要，特别是在如今网络攻击频繁的情况下。如果你的服务器存在漏洞，黑客可能会利用这些漏洞进行攻击，甚至窃取数据。今天我们就来聊聊5个实用技巧，帮助你提升服务器的安全性，让你的系统更...
- 聊聊Spring AI Alibaba的YuQueDocumentReader
-
序本文主要研究一下SpringAIAlibaba的YuQueDocumentReaderYuQueDocumentReader...
- Mac Docker环境，利用Canal实现MySQL同步ES
-
Canal的使用使用docker环境安装mysql、canal、elasticsearch，基于binlog利用canal实现mysql的数据同步到elasticsearch中，并在springboo...
- RustDesk:开源远程控制工具的技术架构与全场景部署实战
-
一、开源远程控制领域的革新者1.1行业痛点与解决方案...
- 长安汽车一代CS75Plus2020款安装高德地图7.5
-
不用破解原车机，一代CS75Plus2020款，安装车机版高德地图7.5，有红绿灯读秒！废话不多讲，安装步骤如下：一、在拨号状态输入：在电话拨号界面，输入:*#518200#*（进入安卓设置界面，...
- Zookeeper使用详解之常见操作篇（zookeeper ui）
-
一、Zookeeper的数据结构对于ZooKeeper而言，其存储结构类似于文件系统，也是一个树形目录服务，并通过Key-Value键值对的形式进行数据存储。其中，Key由斜线间隔的路径元素构成。对...
- zk源码—4.会话的实现原理一（会话层的基本功能是什么）
-
大纲1.创建会话...
- Zookeeper 可观测性最佳实践（zookeeper能够确保）
-
Zookeeper介绍ZooKeeper是一个开源的分布式协调服务，用于管理和协调分布式系统中的节点。它提供了一种高效、可靠的方式来解决分布式系统中的常见问题，如数据同步、配置管理、命名服务和集群...
- 服务器密码错误被锁定怎么解决（服务器密码错几次锁）
-
#服务器密码错误被锁定解决方案当服务器因多次密码错误导致账户被锁定时，可以按照以下步骤进行排查和解决：##一、确认锁定状态###1.检查账户锁定状态（Linux）```bash#查看账户锁定...
- zk基础—4.zk实现分布式功能（分布式zk的使用）
-
大纲1.zk实现数据发布订阅...
- 《死神魂魄觉醒》卡死问题终极解决方案:从原理到实战的深度解析
-
在《死神魂魄觉醒》的斩魄刀交锋中，游戏卡死犹如突现的虚圈屏障，阻断玩家与尸魂界的连接。本文将从技术架构、解决方案、预防策略三个维度，深度剖析卡死问题的成因与应对之策，助力玩家突破次元壁障，畅享灵魂共鸣...
欢迎 你 发表评论:
- 一周热门
-
-
前端面试:iframe 的优缺点? iframe有那些缺点
-
带斜线的表头制作好了，如何填充内容?这几种方法你更喜欢哪个?
-
漫学笔记之PHP.ini常用的配置信息
-
推荐7个模板代码和其他游戏源码下载的网址
-
其实模版网站在开发工作中很重要，推荐几个参考站给大家
-
[干货] JAVA - JVM - 2 内存两分 [干货]+java+-+jvm+-+2+内存两分吗
-
正在学习使用python搭建自动化测试框架?这个系统包你可能会用到
-
织梦(Dedecms)建站教程 织梦建站详细步骤
-
【开源分享】2024PHP在线客服系统源码(搭建教程+终身使用)
-
2024PHP在线客服系统源码+完全开源 带详细搭建教程
-
- 最近发表
-
- ETCD 故障恢复（etc常见故障）
- 在Ubuntu 16.04 LTS服务器上安装FreeRADIUS和Daloradius的方法
- 如何排查服务器被黑客入侵的迹象（黑客 抓取服务器数据）
- 使用 Fail Ban 日志分析 SSH 攻击行为
- 《5 个实用技巧，提升你的服务器安全性，避免被黑客盯上!》
- 聊聊Spring AI Alibaba的YuQueDocumentReader
- Mac Docker环境，利用Canal实现MySQL同步ES
- RustDesk:开源远程控制工具的技术架构与全场景部署实战
- 长安汽车一代CS75Plus2020款安装高德地图7.5
- Zookeeper使用详解之常见操作篇（zookeeper ui）
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)