springboot2.2.X手册:5分钟用Netty搭建高性能异步WebSocket服务
yuyutoo 2024-10-12 01:40 3 浏览 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种复制方式性能对比
相关推荐
- jQuery VS AngularJS 你更钟爱哪个?
-
在这一次的Web开发教程中，我会尽力解答有关于jQuery和AngularJS的两个非常常见的问题，即jQuery和AngularJS之间的区别是什么？也就是说jQueryVSAngularJS？...
- Jquery实时校验，指定长度的「负小数」，小数位未满末尾补0
-
在可以输入【负小数】的输入框获取到焦点时，移除千位分隔符，在输入数据时，实时校验输入内容是否正确，失去焦点后，添加千位分隔符格式化数字。同时小数位未满时末尾补0。HTML代码...
- 如何在pbootCMS前台调用自定义表单?pbootCMS自定义调用代码示例
-
要在pbootCMS前台调用自定义表单，您需要在后台创建表单并为其添加字段，然后在前台模板文件中添加相关代码，如提交按钮和表单验证代码。您还可以自定义表单数据的存储位置、添加文件上传字段、日期选择器、...
- 编程技巧:Jquery实时验证，指定长度的「负小数」
-
为了保障【负小数】的正确性，做成了通过Jquery，在用户端，实时验证指定长度的【负小数】的方法。HTML代码<inputtype="text"class="forc...
- 一篇文章带你用jquery mobile设计颜色拾取器
-
【一、项目背景】现实生活中，我们经常会遇到配色的问题，这个时候去百度一下RGB表。而RGB表只提供相对于的颜色的RGB值而没有可以验证的模块。我们可以通过jquerymobile去设计颜色的拾取器...
- 编程技巧:Jquery实时验证，指定长度的「正小数」
-
为了保障【正小数】的正确性，做成了通过Jquery，在用户端，实时验证指定长度的【正小数】的方法。HTML做成方法<inputtype="text"class="fo...
- jquery.validate检查数组全部验证
-
问题：html中有多个name[]，每个参数都要进行验证是否为空，这个时候直接用required:true话，不能全部验证，只要这个数组中有一个有值就可以通过的。解决方法使用addmethod...
- Vue进阶(幺叁肆):npm查看包版本信息
-
第一种方式npmviewjqueryversions这种方式可以查看npm服务器上所有的...
- layui中使用lay-verify进行条件校验
-
一、layui的校验很简单，主要有以下步骤：1.在form表单内加上class="layui-form"2.在提交按钮上加上lay-submit3.在想要校验的标签，加上lay-...
- jQuery是什么?如何使用? jquery是什么功能组件
-
jQuery于2006年1月由JohnResig在BarCampNYC首次发布。它目前由TimmyWilson领导,并由一组开发人员维护。jQuery是一个JavaScript库，它简化了客户...
- django框架的表单form的理解和用法-9
-
表单呈现...
- jquery对上传文件的检测判断 jquery实现文件上传
-
总体思路：在前端使用jquery对上传文件做部分初步的判断，验证通过的文件利用ajaxFileUpload上传到服务器端，并将文件的存储路径保存到数据库。<asp:FileUploadI...
- Nodejs之MEAN栈开发(四)-- form验证及图片上传
-
这一节增加推荐图书的提交和删除功能，来学习node的form提交以及node的图片上传功能。开始之前需要源码同学可以先在git上fork：https://github.com/stoneniqiu/R...
- 大数据开发基础之JAVA jquery 大数据java实战
-
上一篇我们讲解了JAVAscript的基础知识、特点及基本语法以及组成及基本用途，本期就给大家带来了JAVAweb的第二个知识点jquery，大数据开发基础之JAVAjquery，这是本篇文章的主要...
- 推荐四个开源的jQuery可视化表单设计器
-
jquery开源在线表单拖拉设计器formBuilder(推荐)jQueryformBuilder是一个开源的WEB在线html表单设计器，开发人员可以通过拖拉实现一个可视化的表单。支持表单常用控件...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- 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)