java WebSocket的实现以及Spring WebSocket示例代码

发布时间 - 2026-01-10 22:28:53    点击率:

开始学习WebSocket,准备用它来实现一个在页面实时输出log4j的日志以及控制台的日志。

首先知道一些基础信息:

1.java7 开始支持WebSocket,并且只是做了定义,并未实现

2.tomcat7及以上,jetty 9.1及以上实现了WebSocket,其他容器没有研究

3.spring 4.0及以上增加了WebSocket的支持

4.spring 支持STOMP协议的WebSocket通信

5.WebSocket 作为java的一个扩展,它属于javax包目录下,通常需要手工引入该jar,以tomcat为例,可以在 tomcat/lib 目录下找到 websocket-api.jar

开始实现

先写一个普通的WebSocket客户端,直接引入tomcat目录下的jar,主要的jar有:websocket-api.jar、tomcat7-websocket.jar

public static void f1() {
    try {
      WebSocketContainer container = ContainerProvider.getWebSocketContainer(); // 获取WebSocket连接器,其中具体实现可以参照websocket-api.jar的源码,Class.forName("org.apache.tomcat.websocket.WsWebSocketContainer");
      String uri = "ws://localhost:8081/log/log";
      Session session = container.connectToServer(Client.class, new URI(uri)); // 连接会话
      session.getBasicRemote().sendText("123132132131"); // 发送文本消息
      session.getBasicRemote().sendText("4564546");
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

其中的URL格式必须是ws开头,后面接注册的WebSocket地址

Client.java 是用于收发消息

@ClientEndpoint
public class Client {

  @OnOpen
  public void onOpen(Session session) {
    System.out.println("Connected to endpoint: " + session.getBasicRemote());
  }

  @OnMessage
  public void onMessage(String message) {
    System.out.println(message);
  }

  @OnError
  public void onError(Throwable t) {
    t.printStackTrace();
  }
}

到这一步,客户端的收发消息已经完成,现在开始编写服务端代码,用Spring 4.0,其中pom.xml太长就不贴出来了,会用到jackson,spring-websocket,spring-message

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Lazy;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.socket.WebSocketHandler;
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 com.gionee.log.client.LogWebSocketHandler;

/**
 * 注册普通WebScoket
 * @author PengBin
 * @date 2016年6月21日 下午5:29:00
 */
@Configuration
@EnableWebMvc
@EnableWebSocket
public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {

  @Autowired
  @Lazy
  private SimpMessagingTemplate template;

  /** {@inheritDoc} */
  @Override
  public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
    registry.addHandler(logWebSocketHandler(), "/log"); // 此处与客户端的 URL 相对应
  }

  @Bean
  public WebSocketHandler logWebSocketHandler() {
    return new LogWebSocketHandler(template);
  }

}

import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

/**
 * 
 * @author PengBin
 * @date 2016年6月24日 下午6:04:39
 */
public class LogWebSocketHandler extends TextWebSocketHandler {

  private SimpMessagingTemplate template;

  public LogWebSocketHandler(SimpMessagingTemplate template) {
    this.template = template;
    System.out.println("初始化 handler");
  }

  @Override
  protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
    String text = message.getPayload(); // 获取提交过来的消息
    System.out.println("handMessage:" + text);
    // template.convertAndSend("/topic/getLog", text); // 这里用于广播
    session.sendMessage(message);
  }
}

这样,一个普通的WebSocket就完成了,自己还可以集成安全控制等等

Spring还支持一种注解的方式,可以实现订阅和广播,采用STOMP格式协议,类似MQ,其实应该就是用的MQ的消息格式,下面是实现

同样客户端:

public static void main(String[] args) {
    try {
      WebSocketContainer container = ContainerProvider.getWebSocketContainer();
      String uri = "ws://localhost:8081/log/hello/hello/websocket";
      Session session = container.connectToServer(Client.class, new URI(uri));
      char lf = 10; // 这个是换行
      char nl = 0; // 这个是消息结尾的标记,一定要
      StringBuilder sb = new StringBuilder();
      sb.append("SEND").append(lf); // 请求的命令策略
      sb.append("destination:/app/hello").append(lf); // 请求的资源
      sb.append("content-length:14").append(lf).append(lf); // 消息体的长度
      sb.append("{\"name\":\"123\"}").append(nl); // 消息体

      session.getBasicRemote().sendText(sb.toString()); // 发送消息
      Thread.sleep(50000); // 等待一小会
      session.close(); // 关闭连接

    } catch (Exception e) {
      e.printStackTrace();
    }
  }

这里一定要注意,换行符和结束符号,这个是STOMP协议规定的符号,错了就不能解析到

服务端配置

/**
 * 启用STOMP协议WebSocket配置
 * @author PengBin
 * @date 2016年6月24日 下午5:59:42
 */
@Configuration
@EnableWebMvc
@EnableWebSocketMessageBroker
public class WebSocketBrokerConfig extends AbstractWebSocketMessageBrokerConfigurer {

  /** {@inheritDoc} */
  @Override
  public void registerStompEndpoints(StompEndpointRegistry registry) {
    System.out.println("注册");
    registry.addEndpoint("/hello").withSockJS(); // 注册端点,和普通服务端的/log一样的
    // withSockJS()表示支持socktJS访问,在浏览器中使用
  }

  /** {@inheritDoc} */
  @Override
  public void configureMessageBroker(MessageBrokerRegistry config) {
    System.out.println("启动");
    config.enableSimpleBroker("/topic"); // 
    config.setApplicationDestinationPrefixes("/app"); // 格式前缀
  }

}

Controller

@Controller
public class LogController {

  private SimpMessagingTemplate template;

  @Autowired
  public LogController(SimpMessagingTemplate template) {
    System.out.println("init");
    this.template = template;
  }

  @MessageMapping("/hello") 
  @SendTo("/topic/greetings") // 订阅
  public Greeting greeting(HelloMessage message) throws Exception {
    System.out.println(message.getName());
    Thread.sleep(3000); // simulated delay
    return new Greeting("Hello, " + message.getName() + "!");
  }

}

到这里就已经全部完成。

template.convertAndSend("/topic/greetings", "通知"); // 这个的意思就是向订阅了/topic/greetings进行广播

对于用socktJS连接的时候会有一个访问 /info 地址的请求

如果在浏览器连接收发送消息,则用sockt.js和stomp.js

 function connect() {
   var socket = new SockJS('/log/hello/hello');
   stompClient = Stomp.over(socket);
   stompClient.connect({}, function(frame) {
     setConnected(true);
     console.log('Connected: ' + frame);
     stompClient.subscribe('/topic/greetings', function(greeting) {
       showGreeting(JSON.parse(greeting.body).content);
     });
   });
 }

 function disconnect() {
   if (stompClient != null) {
     stompClient.disconnect();
   }
   setConnected(false);
   console.log("Disconnected");
 }

 function sendName() {
   var name = document.getElementById('name').value;
   stompClient.send("/app/hello", {}, JSON.stringify({
     'name' : name
   }));
 }

在浏览器中可以看到请求返回101状态码,意思就是切换协议

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


# spring实现websocket  # java实现websocket  # spring  # websocket  # 使用Spring Boot搭建Java web项目及开发过程图文详解  # springboot+webmagic实现java爬虫jdbc及mysql的方法  # Java中Spring WebSocket详解  # webuploader在springMVC+jquery+Java开发环境下的大文件分片上传的实例代  # java web SpringMVC后端传json数据到前端页面实例代码  # C程序函数调用&系统调用  # JavaWeb项目中springmvc和tomcat对静态文件的处理  # Java Spring WEB应用实例化如何实现  # 客户端  # 服务端  # 下午  # 目录下  # 一个普通  # 发送消息  # 器中  # 来了  # 会有  # 还可以  # 就不  # 错了  # 可以看到  # 就不能  # 为例  # 可以实现  # 来实现  # 用它  # 太长  # 贴出 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: 学生网站制作软件,一个12岁的学生写小说,应该去什么样的网站?  Windows驱动无法加载错误解决方法_驱动签名验证失败处理步骤  如何确保西部建站助手FTP传输的安全性?  如何在宝塔面板中修改默认建站目录?  Laravel如何监控和管理失败的队列任务_Laravel失败任务处理与监控  Laravel如何实现邮件验证激活账户_Laravel内置MustVerifyEmail接口配置【步骤】  高端建站三要素:定制模板、企业官网与响应式设计优化  如何用AWS免费套餐快速搭建高效网站?  南京网站制作费用,南京远驱官方网站?  Laravel如何将应用部署到生产服务器_Laravel生产环境部署流程  如何为不同团队 ID 动态生成多个非值班状态按钮  Laravel如何集成微信支付SDK_Laravel使用yansongda-pay实现扫码支付【实战】  Laravel的.env文件有什么用_Laravel环境变量配置与管理详解  小视频制作网站有哪些,有什么看国内小视频的网站,求推荐?  悟空识字如何进行跟读录音_悟空识字开启麦克风权限与录音  如何实现javascript表单验证_正则表达式有哪些实用技巧  laravel怎么配置Redis作为缓存驱动_laravel Redis缓存配置教程  通义万相免费版怎么用_通义万相免费版使用方法详细指南【教程】  如何快速搭建安全的FTP站点?  javascript读取文本节点方法小结  如何在景安云服务器上绑定域名并配置虚拟主机?  关于BootStrap modal 在IOS9中不能弹出的解决方法(IOS 9 bootstrap modal ios 9 noticework)  移动端脚本框架Hammer.js  网页制作模板网站推荐,网页设计海报之类的素材哪里好?  今日头条AI怎样推荐抢票工具_今日头条AI抢票工具推荐算法与筛选【技巧】  Laravel如何处理跨站请求伪造(CSRF)保护_Laravel表单安全机制与令牌校验  北京的网站制作公司有哪些,哪个视频网站最好?  魔毅自助建站系统:模板定制与SEO优化一键生成指南  Laravel怎么使用artisan命令缓存配置和视图  Win11怎么设置虚拟桌面 Win11新建多桌面切换操作【技巧】  电视网站制作tvbox接口,云海电视怎样自定义添加电视源?  如何快速搭建高效WAP手机网站?  长沙企业网站制作哪家好,长沙水业集团官方网站?  EditPlus 正则表达式 实战(3)  网站设计制作书签怎么做,怎样将网页添加到书签/主页书签/桌面?  夸克浏览器网页跳转延迟怎么办 夸克浏览器跳转优化  Laravel如何发送系统通知_Laravel Notifications实现多渠道消息通知  如何快速生成ASP一键建站模板并优化安全性?  Laravel DB事务怎么使用_Laravel数据库事务回滚操作  Laravel如何使用Gate和Policy进行权限控制_Laravel权限判定与策略规则配置  如何在阿里云完成域名注册与建站?  详解免费开源的DotNet二维码操作组件ThoughtWorks.QRCode(.NET组件介绍之四)  Laravel怎么进行数据库事务处理_Laravel DB Facade事务操作确保数据一致性  如何选择PHP开源工具快速搭建网站?  Windows家庭版如何开启组策略(gpedit.msc)?(安装方法)  如何彻底删除建站之星生成的Banner?  智能起名网站制作软件有哪些,制作logo的软件?  Laravel如何从数据库删除数据_Laravel destroy和delete方法区别  Laravel如何实现文件上传和存储?(本地与S3配置)  如何在建站宝盒中设置产品搜索功能?