当前位置:首页 > Java技术 > SpringBoot 基于注解实现的WebSocketServer

SpringBoot 基于注解实现的WebSocketServer

2022年11月08日 19:08:21Java技术12

Maven 依赖

在线WebScoket客户端

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>javax.websocket</groupId>
            <artifactId>javax.websocket-api</artifactId>
            <version>1.1</version>
        </dependency>
<!--        引用这个依赖是当项目在开发环境运行时才需要或者运行项目是依赖SpringBoot内置的tomcat时才需要的
            @Configuration
            @EnableWebSocket
            public class WebSocketConfig {
                @Bean
                public ServerEndpointExporter serverEndpoint() {
                    return new ServerEndpointExporter();
                }
            }
            通过这个配置注册websocket.
            如果项目是在外置tomcat上运行的该依赖可以不需要导入 上面的那个配置Bean也就不需要了
-->

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
            <!--        打包 排除掉该依赖-->
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <!--排除掉SpringBoot内置的tomcat-->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-tomcat</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

<!--        导入SpringBoot内置的tomcat. 但设置只有在开发阶段生效 。 maven-package将排除掉该依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <scope>provided</scope>
        </dependency>


    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.3.7.RELEASE</version>
                <configuration>
                    <mainClass>com.hwl.socket.SocketApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <failOnMissingWebXml>false</failOnMissingWebXml>
                </configuration>
            </plugin>
        </plugins>
    </build>

一个三个类

启动类

@SpringBootApplication
public class SocketApplication extends SpringBootServletInitializer {

	public static void main(String[] args) {
		SpringApplication.run(SocketApplication.class, args);
	}

//	外置tomcat的启动实现
	@Override
	protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
		return builder.sources(SocketApplication.class);
	}

}

配置类

// 判断只有在开发阶段 底下的所有配置才会生效
@ConditionalOnClass(ServerEndpointExporter.class)
@Configuration
@EnableWebSocket
public class WebSocketConfig {
	@Bean
		public ServerEndpointExporter serverEndpoint() {
		return new ServerEndpointExporter();
	}
}

websocket的处理类

package com.hwl.socket.server;


import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;

// Handler 这个类是多例的. 每一个连接都会导致类实例的创建
// 原生API无法拥有拦截器
@Slf4j
@ServerEndpoint("/websocket/{key}")
@Component
public class Handler {

	//静态变量,用来记录当前在线连接数。
	private static final AtomicInteger onlineCount = new AtomicInteger(0);
	//concurrent包的线程安全
	private static final ConcurrentHashMap<String, Handler> map = new ConcurrentHashMap<String, Handler>();

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

	private String key;

	public static synchronized int getOnlineCount() {
		return onlineCount.get();
	}

	public static synchronized void addOnlineCount() {
		onlineCount.getAndIncrement();

	}

	public static synchronized void subOnlineCount() {
		onlineCount.getAndDecrement();
	}

	//  发生错误时调用
	@OnError
	public void onError(Session session, Throwable error) {
		log.error("[WebSocket] 异常:{}", error.getMessage());
	}

	//	连接建立成功调用的方法
	@OnOpen
	public void afterConnectionEstablished(Session session, @PathParam("key") String key) throws Exception {
		this.session = session;
		this.key = key+session.getId(); // 不然可能出现重复的key 导致map的存储出现问题
		addOnlineCount();
		map.put(key, this);
		log.info("[WebSocket] 新的连接加入:{}\t当前有{}个连接",  key, getOnlineCount());
	}

	//	收到客户端消息后调用的方法
	@OnMessage
	public void handleTextMessage(String message, Session session) throws Exception {
		log.info("[WebSocket] 来自 {} {} 的消息:{}", this.hashCode(),key, message);
		try {
			sendMessage(new SimpleDateFormat("yy-MM-dd HH:mm:ss").format(new Date()));
		} catch (IOException e) {
			e.printStackTrace();
		}
	}

	//	连接关闭调用的方法
	@OnClose
	public void afterConnectionClosed() throws Exception {
		map.remove(key);
		subOnlineCount();           //在线数减1
		log.info("[WebSocket] 连接关闭:{}\t当前有{}个连接", key, getOnlineCount());
	}

	/**
	 * 这个方法与上面几个方法不一样。没有用注解,是根据自己需要添加的方法。
	 */
	public void sendMessage(String message) throws IOException {
		this.session.getBasicRemote().sendText(message);
//		this.session.sendMessage(new TextMessage(message));
		//this.session.getAsyncRemote().sendText(message);
	}
}

作者: 水熊
来源链接:https://blog.csdn.net/weixin_44089726/article/details/121852966

版权声明:
1、JavaClub(https://www.javaclub.cn)以学习交流为目的,由作者投稿、网友推荐和小编整理收藏优秀的IT技术及相关内容,包括但不限于文字、图片、音频、视频、软件、程序等,其均来自互联网,本站不享有版权,版权归原作者所有。

2、本站提供的内容仅用于个人学习、研究或欣赏,以及其他非商业性或非盈利性用途,但同时应遵守著作权法及其他相关法律的规定,不得侵犯相关权利人及本网站的合法权利。
3、本网站内容原作者如不愿意在本网站刊登内容,请及时通知本站(javaclubcn@163.com),我们将第一时间核实后及时予以删除。


本文链接:https://www.javaclub.cn/java/68584.html

分享给朋友:

“SpringBoot 基于注解实现的WebSocketServer” 的相关文章

SpringBoot之Hello World篇,使用eclipse+maven搭建SpringBoot工程

SpringBoot之Hello World篇,使用eclipse+maven搭建SpringBoot工程

首先来了解下什么是SpringBoot 百度百科:Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。通过这种方式,Spring Boot致力于在蓬...

SpringBoot 如何统一后端返回格式

SpringBoot 如何统一后端返回格式

在前后端分离的项目中后端返回的格式一定要友好,不然会对前端的开发人员带来很多的工作量。那么SpringBoot如何做到统一的后端返回格式呢?今天我们一起来看看。为什么要对SpringBoot返回统一的标准格式在默认情况下,SpringBoot的返回格式常见的有三种:返回String@GetMappi...

SpringBoot日志框架

SpringBoot日志框架

概述项目中日志系统是必不可少的的。 目前比较流行的日志框架有log4j、logback等 。可能大家还不知道,这两个框架的作者是同一个人,Logback旨在作为流行的log4j项目的后续版本,从而恢复log4j离开的位置。另外 slf4j(Simple Logging Facade for Java...

Spring Cloud面试问题

Spring Cloud面试问题

问:什么是Spring Cloud?     答: Spring Cloud Stream App Starters是基于Spring Boot的Spring Integration应用程序,提供与外部系统的集成。Spring Cloud Task。...

Spring Boot 2.0 WebFlux 快速入门实践

Spring Boot 2.0 WebFlux 快速入门实践

02:WebFlux 快速入门实践 Spring Boot 2.0 spring.io 官网有句醒目的话是: BUILD ANYTHING WITH SPRING BOOT Spring Boot (Boot 顾名思义,是...

SpringBoot整合 mybatisPlus

SpringBoot整合 mybatisPlus

引言 最近在准备一期SpringBoot整合大全系列文章,同时也会有视频放出(视频还在酝酿中),如果大家觉得有帮助,记得点赞加收藏哦。 话不多说,咱们直接进入正题。 ​ 代码已经上传到码云:https://gitee.com/lezaiclu...

Spring Boot 2 快速教程:WebFlux 集成 Mongodb(四)

Spring Boot 2 快速教程:WebFlux 集成 Mongodb(四)

摘要: 原创出处 https://www.bysocket.com 「公众号:泥瓦匠BYSocket 」欢迎关注和转载,保留摘要,谢谢! 这是泥瓦匠的第104篇原创 文章工程: * JDK 1.8 * Maven 3.5.2 * Spring Boot 2.1.3.R...

SpringCloud 实战|7.SpringCloud 整合Sentinel

SpringCloud 实战|7.SpringCloud 整合Sentinel

手把手教你从0开始搭建spring cloud alibaba 脚手架,关注公众号“AI码师” 获取项目完整源码 引言 这一期主要是整合sentinel,实现流控、降级和授权功能 开整 引入依赖 在comm...

Spring Boot 整合 Redis 实现缓存操作

Spring Boot 整合 Redis 实现缓存操作

摘要: 原创出处 www.bysocket.com 「泥瓦匠BYSocket 」欢迎转载,保留摘要,谢谢! 『 产品没有价值,开发团队再优秀也无济于事 – 《启示录》 』...

spring boot随笔二

spring boot随笔二

pring Boot与日志(日志框架、日志配置) 1、市面上的日志框架JUL、JCL、Jboss-logging、logback、log4、log4j2、slf4j……    ...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。