spring-boot websocket实现聊天功能

最新推荐文章于 2024-03-07 16:15:33 发布
最新推荐文章于 2024-03-07 16:15:33 发布
阅读量236 收藏 1
点赞数
分类专栏： spring-boot code系列 文章标签： java html5
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_30356443/article/details/104773271
版权

一,maven pom.xml的依赖

        <parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.0.RELEASE</version>
	</parent>
	<dependencies>
		<!-- web -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<!-- 模板 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-freemarker</artifactId>
		</dependency>
		<!-- websocket -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-websocket</artifactId>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<!-- <version>1.16.20</version> -->
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>1.3.1</version>
		</dependency>
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>druid</artifactId>
			<version>1.1.3</version>
		</dependency>
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
		<dependency>
			<groupId>com.github.pagehelper</groupId>
			<artifactId>pagehelper-spring-boot-starter</artifactId>
			<version>1.2.5</version>
		</dependency>
		<!-- commons-lang3 -->
		<dependency>
			<groupId>org.apache.commons</groupId>
			<artifactId>commons-lang3</artifactId>
		</dependency>
		<dependency>
			<groupId>commons-codec</groupId>
			<artifactId>commons-codec</artifactId>
		</dependency>
		<dependency>
			<groupId>commons-beanutils</groupId>
			<artifactId>commons-beanutils</artifactId>
			<version>1.9.2</version>
		</dependency>
		<!-- 验证码波纹 -->
		<dependency>
			<groupId>com.jhlabs</groupId>
			<artifactId>filters</artifactId>
			<version>2.0.235</version>
		</dependency>
		<!-- alibaba json -->
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.41</version>
		</dependency>
	</dependencies>
	<!-- 打包spring boot应用 -->
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<includeSystemScope>true</includeSystemScope>
				</configuration>
				<executions>
					<execution>
						<goals>
							<goal>repackage</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
			<plugin>
				<groupId>org.mybatis.generator</groupId>
				<artifactId>mybatis-generator-maven-plugin</artifactId>
				<version>1.3.5</version>
				<dependencies>
					<dependency>
						<groupId>org.mybatis.generator</groupId>
						<artifactId>mybatis-generator-core</artifactId>
						<version>1.3.5</version>
					</dependency>
					<dependency>
						<groupId>mysql</groupId>
						<artifactId>mysql-connector-java</artifactId>
						<version>5.1.45</version>
					</dependency>
				</dependencies>
				<executions>
					<execution>
						<id>mybatis generator</id>
						<phase>deploy</phase>
						<goals>
							<goal>generate</goal>
						</goals>
					</execution>
				</executions>
				<configuration>
					<!-- 允许移动生成的文件 -->
					<verbose>false</verbose>
					<!-- 是否允许覆盖 -->
					<overwrite>false</overwrite>
					<configurationFile>
						src/main/resources/mybatis-generator.xml
					</configurationFile>
				</configuration>
			</plugin>
			<!-- 指定jdk版本 -->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<configuration>
					<!-- jdk版本,spring-boot最好依赖jdk8,否则spring-boot版本过高会造成不兼容 -->
					<source>${java.version}</source>
					<target>${java.version}</target>
					<encoding>${project.build.sourceEncoding}</encoding>
					<compilerArguments>
						<verbose />
						<bootclasspath>${java.home}/lib/rt.jar${path.separator}${java.home}/lib/jce.jar</bootclasspath>
					</compilerArguments>
				</configuration>
			</plugin>
			<!-- 将maven将java项目依赖包一起打入一个jar包内 -->
			<plugin>
				<artifactId>maven-assembly-plugin</artifactId>
				<configuration>
					<descriptorRefs>
						<descriptorRef>jar-with-dependencies</descriptorRef>
					</descriptorRefs>
					<archive>
						<manifest>
							<mainClass></mainClass>
						</manifest>
					</archive>
				</configuration>
				<executions>
					<execution>
						<id>make-assembly</id>
						<phase>package</phase>
						<goals>
							<goal>single</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>

二:,核心代码:实现WebSocketMessageBrokerConfigurer接口,注册授权拦截器与用户ID

1,每次连接首先进入AuthInterceptor拦截器通过HttpRequest获取seesion中自定义字段判断客户是否登录,未登录则不让连接

2,紧接着进入PrincipalHandler冲中取出sesson的自定义字段作为唯一ID,返回给Principal,该ID会作为点对点发给客户端的凭证

3,通过WebSocketHandlerDecoratorFactory可以统计在线人数

package com.lsh.springboot.js.monitor.config;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketTransportRegistration;
import org.springframework.web.socket.handler.WebSocketHandlerDecorator;
import org.springframework.web.socket.handler.WebSocketHandlerDecoratorFactory;

import com.lsh.springboot.js.monitor.socket.AuthInterceptor;
import com.lsh.springboot.js.monitor.socket.LshPrincipal;
import com.lsh.springboot.js.monitor.socket.PrincipalHandler;
import com.lsh.springboot.js.monitor.socket.SocketManager;

/**
 * 功能说明: Socket配置类<br>
 * 系统版本: v1.0<br>
 * 开发人员: @author liansh<br>
 * 开发时间: 2020年3月6日<br>
 */
@Slf4j
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
	@Autowired
	private PrincipalHandler principalHandler;
	@Autowired
	private AuthInterceptor authInterceptor;

	@Override
	public void registerStompEndpoints(StompEndpointRegistry stompEndpointRegistry) {
		stompEndpointRegistry.addEndpoint("/socket").setAllowedOrigins("*").//
				addInterceptors(authInterceptor).//
				setHandshakeHandler(principalHandler).//
				withSockJS();
	}

	@Override
	public void configureMessageBroker(MessageBrokerRegistry registry) {
		/** 前缀:queue 点对点 topic 广播 user 点对点 */
		registry.enableSimpleBroker("/queue", "/topic");
		registry.setUserDestinationPrefix("/user");
	}

	@Override
	public void configureWebSocketTransport(WebSocketTransportRegistration registration) {
		registration.addDecoratorFactory(new WebSocketHandlerDecoratorFactory() {
			@Override
			public WebSocketHandler decorate(WebSocketHandler handler) {
				return new WebSocketHandlerDecorator(handler) {
					@Override
					public void afterConnectionEstablished(WebSocketSession session) throws Exception {
						LshPrincipal principal = (LshPrincipal) session.getPrincipal();
						log.info("有人连接啦  userId = {}", principal);
						if (principal != null) {
							// 身份校验成功，缓存socket连接
							SocketManager.add(principal.getName(), session);
						}
						super.afterConnectionEstablished(session);
					}

					@Override
					public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
						LshPrincipal principal = (LshPrincipal) session.getPrincipal();
						log.info("有人退出连接啦  userId = {}", principal);
						if (principal != null) {
							// 身份校验成功，移除socket连接
							SocketManager.remove(principal.getName());
						}
						super.afterConnectionClosed(session, closeStatus);
					}
				};
			}
		});
	}
}

package com.lsh.springboot.js.monitor.action;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.socket.WebSocketSession;

import com.lsh.springboot.js.monitor.enums.MessCharTypeEnum;
import com.lsh.springboot.js.monitor.enums.MessContTypeEnum;
import com.lsh.springboot.js.monitor.service.IMessService;
import com.lsh.springboot.js.monitor.service.modelObject.MessInfoMO;
import com.lsh.springboot.js.monitor.socket.SocketManager;

/**
 * 功能说明: WebSocket<br>
 * 系统版本: v1.0<br>
 * 开发人员: @author liansh<br>
 * 开发时间: 2019年10月23日<br>
 */
@Slf4j
@Controller
public class SocketAction {
	@Autowired
	private IMessService messService;
	private final SimpMessagingTemplate messagingTemplate;

	@Autowired
	public SocketAction(SimpMessagingTemplate messagingTemplate) {
		this.messagingTemplate = messagingTemplate;
	}

	/**
	 * 定时推送消息
	 */
	// @Scheduled(fixedRate = 5000)
	public void callback() {
		// 发现消息
		DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		messagingTemplate.convertAndSend("/callback", "定时推送消息时间: " + df.format(new Date()));
	}

	/** 服务器指定用户进行推送 */
	@ResponseBody
	@RequestMapping("/sendUser")
	public String sendUser(String userId) {
		log.info("userId = {} ,对其发送您好", userId);
		WebSocketSession webSocketSession = SocketManager.get(userId);
		if (webSocketSession != null) {
			/** 主要防止broken pipe */
			messagingTemplate.convertAndSendToUser(userId, "/queue/sendUser", "您好");
		}
		return "1";
	}

	/** 广播，服务器主动推给连接的客户端 */
	@RequestMapping("/sendTopic")
	public void sendTopic() {
		messagingTemplate.convertAndSend("/topic/sendTopic", "大家晚上好");
	}

	/** 客户端发消息，服务端接收 */
	@MessageMapping("/sendServer")
	public void sendServer(String message) {
		log.info("message:{}", message);
	}

	/** 客户端发消息，大家都接收，相当于直播说话 */
	@MessageMapping("/sendAllUser")
	@SendTo("/topic/sendTopic")
	public String sendAllUser(String message) {
		// 也可以采用template方式
		return message;
	}

	/** 点对点用户聊天，这边需要注意，由于前端传过来json数据，所以使用@RequestBody */
	@MessageMapping("/sendMyUser")
	public void sendMyUser(@RequestBody Map<String, String> map) {
		String acceId = map.get("acceId");
		MessInfoMO messInfoMO = new MessInfoMO();
		messInfoMO.setSendId(Integer.parseInt(map.get("sendId")));
		messInfoMO.setAcceId(Integer.parseInt(acceId));
		messInfoMO.setMessAcceType(MessCharTypeEnum.getMessCharTypeEnumByName(map.get("messSendType")));
		messInfoMO.setMessCont(map.get("messCont"));
		messInfoMO.setMessContType(MessContTypeEnum.getMessContTypeEnum(map.get("messContType")));
		messService.insert(messInfoMO);
		WebSocketSession webSocketSession = SocketManager.get(acceId);
		if (webSocketSession != null) {
			log.info("userId = {}", acceId);
			messagingTemplate.convertAndSendToUser(acceId, "/queue/sendUser", messInfoMO);
		}
	}
}

 

三:客户端通过SockJS实现与服务端通信

var stompClient;
function socketInit() {
	var url = indexConfig.url + '/socket';
	var socket = new SockJS(url);
	stompClient = Stomp.over(socket);
	stompClient.connect({}, function(frame) {
		// 订阅服务端推送(广播)
		stompClient.subscribe("/user/queue/sendUser", function(response) {
			var body = JSON.parse(response.body);
			console.log("subscribe:" + body);
			if (acceMessAction != "") {
				acceMessAction(body);
			}
		});
	});
}
// 发送给服务端,传对方ID,可以实现点对点
function send(data, url) {
	stompClient.send(url || "/sendMyUser", {}, JSON.stringify(data));
}
// 断开连接
function disconnect() {
	stompClient.disconnect();
}

四:遇到的问题:

1,若通过nginx配置域名,需要在http头部区域增加

proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

否则会导致代码报:Handshake failed due to invalid Upgrade header: null

不注意看的话很难注意到,导致本地正常,一部署就发现不能正常通讯

代码示例

云锦の
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spring-boot+webSocket实现向日葵远程控制
07-22
本项目为spring-boot+webSocket实现的向日葵远程控制项目 向日葵是一款很好用的远程操作软件。 一直很好奇这种软件的基本原理是如何的？ 今天带大家通过一个简单的项目来探究一下，并实现一个简单的远程操控软件 ...
基于Springboot+WebSocket+Netty实现在线聊天、群聊系统
热门推荐
wml_JavaKill的博客
04-24 1万+
此文主要实现在好友添加、建群、聊天对话、群聊功能，使用Java作为后端语言进行支持，界面友好，开发简单。
springboot+websocket，一篇足够了
weixin_33725270的博客
01-24 1028
什么是WebSocket WebSocket是一种在单个TCP连接上进行全双工通信的协议 ................. 为什么要实现握手监控管理 如果说，连接随意创建，不管的话，会存在错误，broken pipe 表面看单纯报错，并没什么功能缺陷等，但实际，请求数增加，容易导致系统奔溃。这边画重点。 出现原因有很多种，目前我这边出现的原因，是因为客户端已关闭连接，服务端还持续推送导致。 ...
springboot实现websocket
最新发布
Xuhai0811的博客
03-07 341
2、新建 WebSocketStompConfig 类。5、发送信息格 （to = All：所有人）"username": "发送人名称""message": "消息内容",3、新建 WebSocket 类。
SpringBoot集成WebSocket实现简单的多人聊天室
weixin_46649054的博客
07-07 970
1.什么是WebSocket？ WebSocket协议是由HTML5定义的，基于TCP协议实现的一种网络协议，通过该协议服务器可以主动向客户端发送信息； WebSocket 协议在2008年诞生，2011年成为W3C国际标准； 我们已经有了 HTTP 协议，为什么出现一个websocket协议？ http协议是短连接，因为请求之后，都会关闭连接，下次重新请求数据，需要再次打开链接； WebSocket协议是一种长连接，只需要通过一次请求来初始化连接，然后所有的请求和响应都是通过这个TCP连接进行通讯； 所
maven 实现WebSocket简单demo聊天功能
qq_38775392的博客
03-03 3524
一.WebSocket简单介绍 　　随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，它实现了浏览器与服务器的全双工通信，扩展了浏览器与服务端的通信功能，使服务端也能主动向客户端发送数据。 　　我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理...
ssm+maven项目中配置webSocket
chenyidong521的博客
09-28 4604
只说明要在ssm的Maven项目中添加WebSocket的方法，使用SocketJs框架进行搭建首先在搭建完成的ssm的Maven项目的pom文件中添加如下节点 <!-- start websocket --> <dependency> <groupId>javax.servlet</groupId> <artifactId>j
spring-boot-starter-websocket-1.5.9.RELEASE.jar
02-27
java运行依赖jar包
spring-boot-starter-websocket-2.1.6.RELEASE.jar
02-27
java运行依赖jar包
spring-boot-websocket-client代码示例
08-03
spring-boot-websocket-client 代码示例
基于Spring-boot-websocket的聊天应用开发总结
01-06
最近在研究通过spring-boot-websocket开发简单的聊天应用，以下对这几天做一下总结。 关于WebRTC原理我主要是通过《WebRTC音视频实时互动技术原理、实战与源码分析》这本书了解底层的框架和实现思路，电子版资料可以...
websocket入门
桥豆麻袋～。～
05-06 159
1、导入坐标 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="ht...
websocket简单的java代码示例
m0_51184327的博客
09-22 1493
websocket的j简单ava代码案例，实现websocket连接和通信。
spring cloud gateway中对websocket进行动态鉴权
zzk_01的博客
07-19 1432
微服务中对webosocket进行动态鉴权
使用WebSocket实现聊天室
JohnnyLin
04-14 3157
WebSocket new WebSocket("服务器地址") //创建WebSocket //open: 当webSocket服务连接成功时触发 socket.addEventListener('open',funtion(){ }) Websocket事件 open 连接建立时触发 message 客户端接收服务端数据时触发 error 通讯发生错误时触发 close 连接关闭时触发 Websocket 方法 Socket.send() 使用连接发送数据 Socket.close(
RabbitMQ（二）Springboot整合及使用
fox_bert的博客
09-26 3232
一、RabbitMQ的重要概念 RabbitMQ是一种基于amq协议的消息队列，本文主要记录一下使用spring-boot-starter-amqp操作 rabbitmq。 a) 虚拟主机(vhost) 虚拟主机：一个虚拟主机持有一组交换机、队列和绑定。虚拟主机的作用在于进行权限管控，rabbitmq默认有一个虚拟主机"/"。可以使用rabbitmqctl add_vhost命令添加虚...
8.SpringBoot 与消息
m0_62520968的博客
09-12 867
ActiveMQ是MQ产品中的元⽼级产品，早期标准MQ产品之⼀，在AMQP协议没有出现之前，占据了消息中间件市场的绝⼤部分份额，后期因为AMQP系列产品的出现，迅速⾛弱，⽬前仅在⼀些线上运⾏的产品中出现，新产品开发较少采⽤。peer-2-peer，⽣产者会将消息发送到⼀个保存消息的容器中，通常使⽤队列模型，使⽤队列保存消息。AMQP的出现解决的是消息传递时使⽤的消息种类的问题，化繁为简，但是其并没有完全推翻JMS的操作API，所以说AMQP仅仅是⼀种协议，规范了数据传输的格式⽽已。
Springboot集成WebSocket 指定用户主动推送消息
weixin_42327496的博客
07-09 1898
import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.mes...
十一、Spring Boot 整合 WebSocket（2）
走在bug的路上
08-12 3546
Spring Boot 整合 WebSocket
spring-boot+websocket实现向日葵远程控制
09-07
Spring-Boot WebSocket 可以实现向日葵远程...综上所述，通过Spring-Boot WebSocket，我们可以便捷地实现向日葵远程控制的功能。使用WebSocket协议进行通信，同时结合向日葵的API，可以让我们更加灵活地远程控制设备。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值