springboot集成websocket(springboot集成websocket原理)

发布网友发布时间：2024-09-29 10:51

我来回答

共1个回答

热心网友时间：2024-09-29 12:45

SpringBoot-WebSocket

websocket是一种网络通信协议，类似http协议

Http协议有一个缺陷：通信只能由客户端发起

在某种场景下，例如，在外卖场景下，骑手位置更新时，服务器端向客户端发送骑手位置。如果使用http协议，那么就只能轮询了，由客户端不停地向服务器端发送请求，获取骑手的位置。

轮询的效率低下，有一定的延迟性，并且频繁的发送请求也会造成资源的浪费。

使用WebSocket协议可以实现由服务器端主动向客户端推送消息，当然客户端也可以向服务器端发送消息。

这里仅介绍利用Spring框架使用WebSocket的方式，原因：Spring使用WebSocket简便且易于扩展。

SpringBoot使用WebSocket非常方便，依赖上仅需要添加相应的Starter即可。

先给出概要的开发步骤：

其实到这里，基础的websocket服务已经搭建好了，剩下的可以自己在handler与interceptor中写自己的业务逻辑了

前端页面：

先启动服务器端SpringBoot应用，再使用前端页面点击测试一下就ok了

SpringBoot整合Websocket实现即时聊天功能

近期，公司需要新增即时聊天的业务，于是用websocket整合到Springboot完成业务的实现。

一、我们来简单的介绍下websocket的交互原理：

1.客户端先服务端发起websocket请求；

2.服务端接收到请求之后，把请求响应返回给客户端；

3.客户端与服务端只需要一次握手即可完成交互通道；

?二、webscoket支持的协议：基于TCP协议下，http协议和https协议；

?http协议springboot不需要做任何的配置?

?https协议则需要配置nignx代理，注意证书有效的问题?---在这不做详细说明

?三、开始我们的实现java后端的实现

?1.添加依赖

?!--websocket--

????dependency

??????groupIdorg.springframework.boot/groupId

??????artifactIdspring-boot-starter-websocket/artifactId

????/dependency

????dependency

??????groupIdorg.springframework/groupId

??????artifactIdspring-websocket/artifactId

??????version${spring.version}/version

????/dependency

????dependency

??????groupIdorg.springframework/groupId

??????artifactIdspring-messaging/artifactId

??????version${spring.version}/version

????/dependency

????!--WebSocket--

?2.配置config

@ConditionalOnWebApplication

@Configuration

@EnableWebSocketMessageBroker

publicclassWebSocketConfigextendsAbstractSessionWebSocketMessageBrokerConfigurer{

??@Bean

??publicServerEndpointExporterserverEndpointExporter(){

????return?newServerEndpointExporter();

??}

??@Bean

??publicCustomSpringConfiguratorcustomSpringConfigurator(){

????returnnewCustomSpringConfigurator();

??}

??@Override

??protectedvoidconfigureStompEndpoints(StompEndpointRegistryregistry){

????registry.addEndpoint("/websocket").setAllowedOrigins("*")

????????.addInterceptors(newHttpSessionHandshakeInterceptor()).withSockJS();

??}

publicclassCustomSpringConfiguratorextendsServerEndpointConfig.ConfiguratorimplementsApplicationContextAware{

??privatestaticvolatileBeanFactorycontext;

??@Override

??publicTTgetEndpointInstance(ClassTclazz)throwsInstantiationException{

????returncontext.getBean(clazz);

??}

??@Override

??publicvoidsetApplicationContext(ApplicationContextapplicationContext)throwsBeansException{

????CustomSpringConfigurator.context=applicationContext;

??}

??@Override

??publicvoidmodifyHandshake(ServerEndpointConfigsec,

????????????????HandshakeRequestrequest,HandshakeResponseresponse){

????super.modifyHandshake(sec,request,response);

????HttpSessionhttpSession=(HttpSession)request.getHttpSession();

????if(httpSession!=null){

??????sec.getUserProperties().put(HttpSession.class.getName(),httpSession);

????}

??}

}

@SpringBootApplication

@EnableCaching

@ComponentScan("com")

@EnableWebSocket

publicclassApplicationextendsSpringBootServletInitializer{

staticfinalLoggerlogger=LoggerFactory.getLogger(Application.class);

??@Override

??protectedSpringApplicationBuilderconfigure(SpringApplicationBuilderapplication){

????returnapplication.sources(Application.class);

??}

需要注意的是:@EnableWebSocket?一定要加在启动类上，不然springboot无法对其扫描进行管理;

@SeverEndpoint--将目标类定义成一个websocket服务端，注解对应的值将用于监听用户连接的终端访问地址，客户端可以通过URL来连接到websocket服务端。

四、设计思路：用map房间id，用户set来保存房间对应的用户连接列表，当有用户进入一个房间的时候，就会先检测房间是否存在，如果不存在那就新建一个空的用户set，再加入本身到这个set中，确保不同房间号里的用户session不串通！

/**

*Createbywushuyu

*on2020/4/3013:24

@ServerEndpoint(value="/websocket/{roomName}",configurator=CustomSpringConfigurator.class)

@Component

publicclassWebSocketRoom{

??//连接超时--一天

??privatestaticfinallongMAX_TIME_OUT=24*60*60*1000;

??//key为房间号，value为该房间号的用户session

??privatestaticfinalMapString,SetSessionrooms=newConcurrentHashMap();

??//将用户的信息存储在一个map集合里

??privatestaticfinalMapString,Objectusers=newConcurrentHashMap();

/**

*{roomName}使用通用跳转，实现动态获取房间号和用户信息?格式：roomId|xx|xx

??@OnOpen?

??publicvoidconnect(@PathParam("roomName")StringroomName,Sessionsession){

????StringroomId=roomName.split("[|]")[0];

????Stringnickname=roomName.split("[|]")[1];

????StringloginId=roomName.split("[|]")[2];

????//设置连接超时时间

??????session.setMaxIdleTimeout(MAX_TIME_OUT);

????try{

?????//可实现业务逻辑

??????}

??????//将session按照房间名来存储，将各个房间的用户隔离

??????if(!rooms.containsKey(roomId)){

????????//创建房间不存在时，创建房间

????????SetSessionroom=newHashSet();

????????//添加用户

????????room.add(session);

????????rooms.put(roomId,room);

??????}else{//房间已存在，直接添加用户到相应的房间???????

????????if(rooms.values().contains(session)){//如果房间里有此session直接不做操作

????????}else{//不存在则添加

??????????rooms.get(roomId).add(session);

????????}

??????}

??????JSONObjectjsonObject=newJSONObject();

??????-----

??????//根据自身业务情况实现业务

??????-----

??????users.put(session.getId(),jsonObject);

??????//向在线的人发送当前在线的人的列表??-------------可有可无，看业务需求

??????ListChatMessageuserList=newLinkedList();

??????rooms.get(roomId)

??????????.stream()

??????????.map(Session::getId)

??????????.forEach(s-{

????????????ChatMessagechatMessage=newChatMessage();

????????????chatMessage.setDate(newDate());

????????????chatMessage.setStatus(1);

????????????chatMessage.setChatContent(users.get(s));

????????????chatMessage.setMessage("");

????????????userList.add(chatMessage);

??????????});

//????session.getBasicRemote().sendText(JSON.toJSONString(userList));

??????//向房间的所有人群发谁上线了

??????ChatMessagechatMessage=newChatMessage();?----将聊天信息封装起来。

??????chatMessage.setDate(newDate());

??????chatMessage.setStatus(1);

??????chatMessage.setChatContent(users.get(session.getId()));

??????chatMessage.setMessage("");

??????broadcast(roomId,JSON.toJSONString(chatMessage));

??????broadcast(roomId,JSON.toJSONString(userList));

????}catch(Exceptione){

??????e.printStackTrace();

????}

??}

??@OnClose

??publicvoiddisConnect(@PathParam("roomName")StringroomName,Sessionsession){

????StringroomId=roomName.split("[|]")[0];

????StringloginId=roomName.split("[|]")[2];

????try{

??????rooms.get(roomId).remove(session);

??????ChatMessagechatMessage=newChatMessage();

??????chatMessage.setDate(newDate());

??????chatMessage.setUserName(user.getRealname());

??????chatMessage.setStatus(0);

??????chatMessage.setChatContent(users.get(session.getId()));

??????chatMessage.setMessage("");

??????users.remove(session.getId());

??????//向在线的人发送当前在线的人的列表?----可有可无，根据业务要求

??????ListChatMessageuserList=newLinkedList();

??????rooms.get(roomId)

??????????.stream()

??????????.map(Session::getId)

??????????.forEach(s-{

????????????ChatMessagechatMessage1=newChatMessage();

????????????chatMessage1.setDate(newDate());

????????????chatMessage1.setUserName(user.getRealname());

????????????chatMessage1.setStatus(1);

????????????chatMessage1.setChatContent(users.get(s));

????????????chatMessage1.setMessage("");

????????????userList.add(chatMessage1);

??????????});

??????broadcast(roomId,JSON.toJSONString(chatMessage));

??????broadcast(roomId,JSON.toJSONString(userList));

????}catch(Exceptione){

??????e.printStackTrace();

????}

??}

??@OnMessage

??publicvoidreceiveMsg(Stringmsg,Sessionsession){

????try{

????????ChatMessagechatMessage=newChatMessage();

????????chatMessage.setUserName(user.getRealname());

????????chatMessage.setStatus(2);

????????chatMessage.setChatContent(users.get(session.getId()));

????????chatMessage.setMessage(msg);

????????//按房间群发消息

????????broadcast(roomId,JSON.toJSONString(chatMessage));

??????}

????}catch(IOExceptione){

??????e.printStackTrace();

????}

??}

??//按照房间名进行群发消息

??privatevoidbroadcast(StringroomId,Stringmsg){

????rooms.get(roomId).forEach(s-{

??????try{

????????s.getBasicRemote().sendText(msg);?-----此还有一个getAsyncRemote()?

??????}catch(IOExceptione){

????????e.printStackTrace();

??????}

????});

??}

??@OnError

??publicvoidonError(Throwableerror){

????error.printStackTrace();

??}

}

友情提示：此session是websocket里的session，并非httpsession；

SpringBoot+Vue+Websocket实现服务器端向客户端主动发送消息

本文通过一个实际的场景来介绍在前后端分离的项目中通过WebSocket来实现服务器端主动向客户端发送消息的应用。主要内容如下

Websocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket连接成功后，服务端与客户端可以双向通信。在需要消息推送的场景，Websocket相对于轮询能更好的节省服务器资源和带宽，并且能够更实时地进行通讯。

具体如下特点

在客户端的列表数据中有个status字段，服务器端需要花费较长的时间进行处理，处理完成后才会更新对应数据的status字段值，通过Websocket的处理流程如下：

通过注入ServerEndpointExporter类，用于在项目启动的时候自动将使用了@ServerEndpoint注解声明的Websocketendpoint注册到WebSocketContainer中。

为什么增加一个ServerEndpointExporterBean，并通过在一个类上增加@ServerEndpoint和@Component注解就可以实现服务器端Websocket功能，这里简单解析一下。

java定义了一套javax.servlet-api,一个HttpServlet就是一个HTTP服务。javawebsocket并非基于servlet-api简单扩展,而是新定义了一套javax.websocket-api。

一个websocket服务对应一个Endpoint。与ServletContext对应,websocket-api也定义了WebSocketContainer,而编程方式注册websocket的接口是继承自WebSocketContainer的ServerContainer。

一个websocket可以接受并管理多个连接,因此可被视作一个server。主流servlet容器都支持websocket,如tomcat,jetty等。看ServerContainerapi文档,可从ServletContextattribute找到ServerContainer。