百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 文章教程 > 正文

springboot2.2.X手册:5分钟用Netty搭建高性能异步WebSocket服务

xsobi 2024-12-19 17:12 1 浏览

溪云阁:专注编程教学,架构,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种复制方式性能对比

springboot2.2.X手册:基于OSS解决文件存储(一年9元^^,赚了)

springboot2.2.X手册:36个注解详细解析,一目了然

相关推荐

js向对象中添加元素(对象,数组) js对象里面添加元素

一、添加一个元素对象名["属性名"]=值(值:可以是一个值,可以是一个对象,也可以是一个数组)这样添加进去的元素,就是一个值或对象或数组...

JS小技巧,如何去重对象数组?(一)

大家好,关于数组对象去重的业务场景,想必大家都遇到过类似的需求吧,这对这样的需求你是怎么做的呢。下面我就先和大家分享下如果是基于对象的1个属性是怎么去重实现的。方法一:使用.filter()和....

「C/C++」之数组、vector对象和array对象的比较

数组学习过C语言的,对数组应该都不会陌生,于是这里就不再对数组进行展开介绍。模板类vector模板类vector类似于string,也是一种动态数组。能够在运行阶段设置vector对象的长度,可以在末...

如何用sessionStorage保存对象和数组

背景:在工作中,我将[{},{}]对象数组形式,存储到sessionStorage,然后ta变成了我看不懂的形式,然后我想取之用之,发现不可能了~记录这次深刻的教训。$clickCouponIndex...

JavaScript Array 对象 javascript的array对象

Array对象Array对象用于在变量中存储多个值:varcars=["Saab","Volvo","BMW"];第一个数组元素的索引值为0,第二个索引值为1,以此类推。更多有...

JavaScript中的数组Array(对象) js array数组

1:数组Array:-数组也是一个对象-数组也是用来存储数据的-和object不同,数组中可以存储一组有序的数据,-数组中存储的数据我们称其为元素(element)-数组中的每一个元素都有一...

数组和对象方法&amp;数组去重 数组去重的5种方法前端

列举一下JavaScript数组和对象有哪些原生方法?数组:arr.concat(arr1,arr2,arrn);--合并两个或多个数组。此方法不会修改原有数组,而是返回一个新数组...

C++ 类如何定义对象数组?初始化数组?linux C++第43讲

对象数组学过C语言的读者对数组的概念应该很熟悉了。数组的元素可以是int类型的变量,例如int...

ElasticSearch第六篇:复合数据类型-数组,对象

在ElasticSearch中,使用JSON结构来存储数据,一个Key/Value对是JSON的一个字段,而Value可以是基础数据类型,也可以是数组,文档(也叫对象),或文档数组,因此,每个JSON...

第58条:区分数组对象和类数组对象

示例设想有两个不同类的API。第一个是位向量:有序的位集合varbits=newBitVector;bits.enable(4);bits.enable([1,3,8,17]);b...

八皇后问题解法(Common Lisp实现)

如何才能在一张国际象棋的棋盘上摆上八个皇后而不致使她们互相威胁呢?这个著名的问题可以方便地通过一种树搜索方法来解决。首先,我们需要写一个函数来判断棋盘上的两个皇后是否互相威协。在国际象棋中,皇后可以沿...

visual lisp修改颜色的模板函数 怎么更改visual studio的配色

(defunBF-yansemokuai(tuyuanyanse/ss)...

用中望CAD加载LISP程序技巧 中望cad2015怎么加载燕秀

1、首先请加载lisp程序,加载方法如下:在菜单栏选择工具——加载应用程序——添加,选择lisp程序然后加载,然后选择添加到启动组。2、然后是添加自定义栏以及图标,方法如下(以...

图的深度优先搜索和广度优先搜索(Common Lisp实现)

为了便于描述,本文中的图指的是下图所示的无向图。搜索指:搜索从S到F的一条路径。若存在,则以表的形式返回路径;若不存在,则返回nil。...

两个有助于理解Common Lisp宏的例子

在Lisp中,函数和数据具有相同的形式。这是Lisp语言的一个重大特色。一个Lisp函数可以分析另一个Lisp函数;甚至可以和另一个Lisp函数组成一个整体,并加以利用。Lisp的宏,是实现上述特色的...