spring+springmvc实现websoket2

最新推荐文章于 2024-05-12 23:44:13 发布
原创 最新推荐文章于 2024-05-12 23:44:13 发布 · 492 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring #websocket-推送

本文介绍如何使用 Spring 框架实现 WebSocket 的配置与交互，包括依赖配置、WebSocketConfigurer 接口实现、WebSocketHandler 继承及自定义业务逻辑。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

用注解@ServerEndpoint(“/websocket”)

  1. 两种方法实现代码地址(包含相关jar包) :http://pan.baidu.com/s/1dF2ElVV 密码：8x6x
    方法1：用注解@ServerEndpoint(“/websocket”)
    方法2：spring-websocket-4.3.6.RELEASE.jar实现

  2. spring-websocket-4.3.6.RELEASE.jar实现websoket(登录式)
    配置文件applicationContext-java.xml

  3. 步骤
    3.1添加Spring WebSocket的依赖jar包
    spring-websocket-4.3.6.RELEASE.jar
    spring-messaging-4.1.3.RELEASE.jar
    3.2建立一个类实现WebSocketConfigurer接口 

package com.spring.websoket;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
import org.springframework.web.socket.handler.TextWebSocketHandler;


@Configuration
@EnableWebMvc
@EnableWebSocket
public class SpringWebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(webSocketHandler(),"/websocket/socketServer.action").addInterceptors(new SpringWebSocketHandlerInterceptor());
        registry.addHandler(webSocketHandler(), "/sockjs/socketServer.action").addInterceptors(new SpringWebSocketHandlerInterceptor()).withSockJS();
    }

    @Bean
    public TextWebSocketHandler webSocketHandler(){
        return new SpringWebSocketHandler();
    }

}

3.3继承WebSocketHandler对象：
该对象提供了客户端连接,关闭,错误,发送等方法,重写这几个方法即可实现自定义业务逻辑

package com.spring.websoket;

import java.io.IOException;
import java.util.ArrayList;

import org.apache.log4j.Logger;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

@Component
public class SpringWebSocketHandler extends TextWebSocketHandler {
    private static final ArrayList<WebSocketSession> users;
    //这个会出现性能问题，最好用Map来存储，key用userid
    private static Logger logger = Logger.getLogger(SpringWebSocketHandler.class);
    static {
        users = new ArrayList<WebSocketSession>();
    }

    public SpringWebSocketHandler() {
        // TODO Auto-generated constructor stub
        System.out.println("SpringWebSocketHandler");
    }

    /**
     * 连接成功时候，会触发页面上onopen方法
     */
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // TODO Auto-generated method stub
        users.add(session);
        System.out.println("connect to the websocket success......当前数量:"+users.size());

        //这块会实现自己业务，比如，当用户登录后，会把离线消息推送给用户
        TextMessage returnMessage = new TextMessage("你将收到的离线");
        session.sendMessage(returnMessage);
    }

    /**
     * 关闭连接时触发
     */
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        logger.debug("websocket connection closed......");
        String username= (String) session.getAttributes().get("WEBSOCKET_USERNAME");
        System.out.println("用户"+username+"已退出！");
        users.remove(session);
        System.out.println("剩余在线用户"+users.size());
    }

    /**
     * js调用websocket.send时候，会调用该方法
     */
    @Override    
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        super.handleTextMessage(session, message);
        sendMessageToUser((String) session.getAttributes().get("WEBSOCKET_USERNAME"), message);
    }

    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        if(session.isOpen()){session.close();}
        logger.debug("websocket connection closed......");
        users.remove(session);
    }

    public boolean supportsPartialMessages() {
        return false;
    }


    /**
     * 给某个用户发送消息
     *
     * @param userName
     * @param message
     */
    public void sendMessageToUser(String userName, TextMessage message) {
        for (WebSocketSession user : users) {
            if (user.getAttributes().get("WEBSOCKET_USERNAME").equals(userName)) {
                try {
                    if (user.isOpen()) {
                        user.sendMessage(message);
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
                break;
            }
        }
    }

    /**
     * 给所有在线用户发送消息
     *
     * @param message
     */
    public void sendMessageToUsers(TextMessage message) {
        for (WebSocketSession user : users) {
            try {
                if (user.isOpen()) {
                    user.sendMessage(message);
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

}

3.4继承HttpSessionHandshakeInterceptor对象：
该对象作为页面连接websocket服务的拦截器

package com.spring.websoket;

import java.util.Map;

import javax.servlet.http.HttpSession;

import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;

/**
 * WebSocket拦截器
 * @author WANG
 *
 */
public class SpringWebSocketHandlerInterceptor extends HttpSessionHandshakeInterceptor {
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
            Map<String, Object> attributes) throws Exception {
        // TODO Auto-generated method stub
        System.out.println("Before Handshake");
        if (request instanceof ServletServerHttpRequest) {
            ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
            HttpSession session = servletRequest.getServletRequest().getSession(false);
            if (session != null) {
                //使用userName区分WebSocketHandler，以便定向发送消息
                String userName = (String) session.getAttribute("SESSION_USERNAME");
                if (userName==null) {
                    userName="default-system";
                }
                attributes.put("WEBSOCKET_USERNAME",userName);
            }
        }
        return super.beforeHandshake(request, response, wsHandler, attributes);

    }

    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
            Exception ex) {
        // TODO Auto-generated method stub
        super.afterHandshake(request, response, wsHandler, ex);
    }
}

3.5让SpringWebSocketConfig配置类随spring容器启动 spring文件：applicationContext-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="
            http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context-3.1.xsd">


    <!-- websocket相关扫描，主要扫描：WebSocketConfig  如果前面配置能扫描到此类则可以不加 -->
    <context:component-scan base-package="com.spring.websoket"/>

</beans>

3.6准备测试类
WebsocketController类

package com.spring.websoket;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.socket.TextMessage;


@Controller
public class WebsocketController {
    //这个注解会从Spring容器拿出Bean
//  @Bean
//    public SpringWebSocketHandler infoHandler() {
//        return new SpringWebSocketHandler();
//    }

    @Autowired
    private SpringWebSocketHandler springWebSocketHandler;

    @RequestMapping("/websocket/login1")
    public ModelAndView login1(HttpServletRequest request, HttpServletResponse response) throws Exception {

        return new ModelAndView("spring-websoket/login");
    }

    @RequestMapping("/websocket/login")
    public ModelAndView login(HttpServletRequest request, HttpServletResponse response) throws Exception {
        String username = request.getParameter("username");
        System.out.println(username+"登录");
        HttpSession session = request.getSession(false);
        session.setAttribute("SESSION_USERNAME", username);
        //response.sendRedirect("/quicksand/jsp/websocket.jsp");
        return new ModelAndView("spring-websoket/index");
    }

    @RequestMapping(value = "/websocket/send", produces="text/html;charset=UTF-8")
    @ResponseBody
    public String send(HttpServletRequest request) {
        String username = request.getParameter("username");
        // 用注解发送内容
        //infoHandler().sendMessageToUser(username, new TextMessage("你好，测试！！！！"));

        TextMessage returnMessage = new TextMessage("你好，测试！！！！");
        //TextMessage t = new TextMessage("你好，测试！！！！");
        springWebSocketHandler.sendMessageToUser(username, returnMessage);
        return returnMessage.getPayload();
    }
}

index.jsp

<%@ page language="java" contentType="text/html; charset=utf-8"
    pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>spring-websoket</title>
</head>
<body>
<script type="text/javascript" src="http://cdn.bootcss.com/jquery/3.1.0/jquery.min.js"></script>
<script type="text/javascript" src="http://cdn.bootcss.com/sockjs-client/1.1.1/sockjs.js"></script>
<script type="text/javascript">
    var websocket = null;
    if ('WebSocket' in window) {
        websocket = new WebSocket("ws://localhost:8082/websoket_test/websocket/socketServer.action");
    } 
    else if ('MozWebSocket' in window) {
        websocket = new MozWebSocket("ws://localhost:8082/websoket_test/websocket/socketServer.action");
    } 
    else {
        websocket = new SockJS("http://localhost:8082/websoket_test/sockjs/socketServer.action");
    }


    websocket.onopen = onOpen;
    websocket.onmessage = onMessage;
    websocket.onerror = onError;
    websocket.onclose = onClose;

    function onOpen(openEvt) {
        alert(openEvt.data);
    }

    function onMessage(evt) {
        console.log(evt)
        alert(evt.data);
    }
    function onError() {}
    function onClose() {}

    function doSend() {
        if (websocket.readyState == websocket.OPEN) {          
            var msg = document.getElementById("inputMsg").value;  
            websocket.send(msg);//调用后台handleTextMessage方法
            alert("发送成功!");  
        } else {  
            alert("连接失败!");  
        }  
    }
　　window.close = function(){
　　　　websocket.onclose();
　　}
$.ajax({url:"/websoket_test/websocket/send.action",success:function(result){
    //console.log(result)
    /* var ws = null;
    if ('WebSocket' in window) {
        ws = new WebSocket("ws://localhost:8082/websoket_test/websocket/socketServer.action");
    } 
    ws.onopen = function () {
     console.log("onpen");
    ws.send("{}");
    }
    ws.onclose = function () {
     console.log("onclose");
    }
    ws.onmessage=function(evt){
        console.log(evt)
        alert(evt.data);

    }; */
    // 靠回传参数显示soket信息
    var data = {};
    data.data = result;
    websocket.onmessage(data)
}});

</script>
请输入：<textarea rows="5" cols="10" id="inputMsg" name="inputMsg"></textarea>
<button onclick="doSend();">发送</button>
</body>
</html>

login.jsp

<%@ page language="java" contentType="text/html; charset=utf-8"
    pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>spring-websoket</title>
</head>
<body>
<h2>Hello World!</h2>
<body>
    <!-- ship是我的项目名-->
    <form action="/websoket_test/websocket/login.action">
        登录名：<input type="text" name="username"/>
        <input type="submit" value="登录"/>
    </form>
</body>
</body>
</html>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
          http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
         version="2.5">

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <!-- jave websoket -->
        <!-- 
               测试地址:http://localhost:8082/websoket_test/index.jsp
        <param-value>classpath:applicationContext-java.xml</param-value>
         -->
         <!-- 测试地址:http://localhost:8082/websoket_test/websocket/login.action?username=ddd -->
         <param-value>classpath:applicationContext-spring.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <listener>
        <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
    </listener>
    <servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
  </servlet>
  <servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>*.action</url-pattern>
  </servlet-mapping>
    <filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
      <param-name>encoding</param-name>
      <param-value>utf-8</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>*.action</url-pattern>
  </filter-mapping>
</web-app>

4.访问地址：http://localhost:8082/websoket_test/websocket/login1.action
这里写图片描述
这里写图片描述

使用SpringBoot+SpringMVC+Mybatis+WebSocket实现云聊天项目并对项目进行自动化测试
薯条和番茄酱的博客
08-20 725
本项目是仿照微信实现网页版聊天程序，用户注册登录后可与在线好友实时聊天，下线好友上线后可以查看到好友发送的消息；用户可以在搜索框搜索用户添加好友；用户还可以查看好友申请列表，选择是否同意好友申请；用户可以删除与好友的聊天记录或者删除好友。
b spring mvc 之 Endpoints 服务端配置 & 异步请求
wanxiaoderen的博客
06-08 768
文章目录1.4 function Endpoints1.5 URI Links1.6 异步请求1.6.1 DeferredResult1.6.2 Callable1.6.3 ProcessingDeferredResultCallable processing works as followsException HandlingInterception1.6.4 HTTP StreamingObjectsSSERaw Data1.6.5 Reactive Types1.6.6 Disconnects1.6.
spring mvc集成websocket
08-16
spring mvc集成websocket，无需xml配置，使用@ServerEndpoint注册一个websocket服务器路径就可在html页面用js与websocket_server建立连接，压缩包里附带了html页面，可以作为参考
【Spring】@ServerEndpoint 与 Spring 是如何集成的
最新发布
chenghan_yang的博客
05-12 999
最近工作需要用到 Websocket 协议。好奇来自 Jdk 包的是如何与集成的，特此记录一下结论。
springmvc通过注解搭建websocket
qq_42569136的博客
08-21 1068
1.依赖： <properties> <spring.version>5.1.5.RELEASE</spring.version> </properties> <dependencies> <!--SpringMVC依赖包--> <dependency&...
spring+springmvc实现websoket1
sunshinegyan的专栏
09-15 484
用注解@ServerEndpoint(“/websocket”) 两种方法实现代码地址(包含相关jar包) :http://pan.baidu.com/s/1dF2ElVV 密码：8x6x 方法1：用注解@ServerEndpoint(“/websocket”) 方法2：spring-websocket-4.3.6.RELEASE.jar实现 注解@ServerEndpoint(“/webso
解决springmvc项目中使用websocket注解不能注入
chenyidong521的博客
10-25 1万+
首先是要在消息处理的类中使用注解@ServerEndpoint("/loginSocket") public class WebsocketEndPoint extends TextWebSocketHandler { @Autowired private ILoginService service=(ILoginService) ContextLoader.getCurrentWe
spring+springMVC+WebSocket 的学习笔记
10-15
2. **配置 WebSocket 容器**：Spring 提供了 Tomcat 或 Jetty 等服务器的 WebSocket 容器配置，以便处理 WebSocket 连接。 3. **配置消息处理器**：Spring 提供了 `WebSocketMessageBrokerConfigurer` 接口，用于...
spring + springmvc + mybatis +websocket实现聊天室
05-19
在这个项目"spring + springmvc + mybatis + websocket实现聊天室"中，我们将探讨如何利用这些技术栈构建一个功能完备的在线聊天平台。 首先，Spring框架是Java开发中的基石，提供了强大的依赖注入（DI）和面向切面...
spring+springmvc+mybatis+websocket
10-27
【标题】"spring+springmvc+mybatis+websocket"整合详解 在当今的Web开发领域，Spring、SpringMVC、MyBatis和WebSocket是四个重要的技术组件，它们各自扮演着关键角色并共同构建了一个强大的应用框架。让我们深入...
maven+springmvc+WebSocket
09-29
这个“maven+springmvc+WebSocket”项目是结合了三个关键技术来实现这样的功能：Maven作为构建工具，Spring MVC作为后端Web框架，以及WebSocket作为实时通信技术。 **Maven** 是Java项目管理工具，它简化了构建、...
SpringMVC结合WebSocket项目开发问题总结
ItStruggler的博客
03-29 8920
webScoket:基于 TCP 协议,协议名为”ws” “wss” ,建立连接需要握手，客户端（浏览器）首先向服务器（web server）发起一条特殊的http请求，web server解析后生成应答到浏览器，这样子一个websocket连接就建立了，直到某一方关闭连接. 客户端 建立 WebSocket 连接时要发送一个 header 标记了 Upgrade 的 HTTP 请求，表示请求协
spring+websocket整合（springMVC+spring+MyBatis即SSM框架和websocket技术的整合）
CSDNUP的专栏
08-08 1023
java-websocket的搭建非常之容易，没用框架的童鞋可以在这里下载撸主亲自调教好的java-websocket程序： Apach Tomcat 8.0.3+MyEclipse+maven+JDK1.7： http://download.csdn.net/detail/up19910522/7719087 spring4.0以后加入了对websocket技术
java websocket @ServerEndpoint注解说明
weixin_33913332的博客
04-27 7510
http://www.blogjava.net/qbna350816/archive/2016/07/24/431302.html https://segmentfault.com/q/1010000004955225 https://www.cnblogs.com/interdrp/p/4091056.html   框架是workermansocket.io 使用四种框架分别实现百万w...
websocket @ServerEndpoint注解形式开发 @OnOpen 如何获取httpSession
热门推荐
lyf_ldh的博客
10-22 2万+
通过Configurator获取httpsession，通过httpsession可获取service import javax.servlet.http.HttpSession; import javax.websocket.HandshakeResponse; import javax.websocket.server.HandshakeRequest; import javax.web...
SpringMVC整合webScoket总结
AbsenceOfTrace的博客
10-26 6990
运行环境tomcat7以上1.创建@ServerEndpoint注解类import java.io.IOException; import java.util.ArrayList; import java.util.List;import javax.servlet.http.HttpSession; import javax.websocket.CloseReason; import javax.
【Spring集成】-Spring配置WebSocket
fxkcsdn的博客
07-08 2698
一.WebSocket简介：    WebSocket协议提供了一个套接字实现全双工通信的功能。除了其他的功能之外，它能够实现web浏览器和服务器之间的异步通信。全双工意味着服务器可以发送消息给服务器，浏览器也可以发送消息给服务器。二.Spring配置WebSocket环境：    目前浏览器对于 WebSocket 的支持情况如下：IE：10.0（完整支持）；FireFox：4.0（部分支持），...
使用Spring WebSocket实现消息推送
零度的博客专栏
11-20 1万+
第一步： 添加Spring WebSocket的依赖jar包 （注：这里使用maven方式添加 手动添加的同学请自行下载相应jar包放到lib目录） 使用spring websocket依赖的jar包 --> dependency> groupId>org.springframeworkgroupId>
spring-boot webSocket解决内置容器和外置容器同时使用的问题
qq_31273099的博客
05-16 1429
用spring boot框架下的webSocket 1.使用内置容器tomcat需要配置 @Configuration public class WebConfig { @Bean public ServerEndpointExporter createServerEndExporter() { return new ServerEndpointExpor...
新手必读：spring+springMVC+WebSocket全解教程
它提供了一整套企业级应用开发解决方案，而SpringMVC和WebSocket作为Spring框架中的重要组成部分，对于构建高性能、可交互的Web应用至关重要。 Spring是一种开源的Java平台，它最初由Rod Johnson创建，其目的是为了...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值