详解java WebSocket的实现以及Spring WebSocket

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

开始学习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状态码,意思就是切换协议

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


# java实现websocket  # spring实现websocket  # spring  # websocket  # java与微信小程序实现websocket长连接  # java 实现websocket的两种方式实例详解  # java WebSocket实现聊天消息推送功能  # Java后端WebSocket的Tomcat实现  # Java中使用websocket实现在线聊天功能  # Java中Spring WebSocket详解  # java使用websocket  # 并且获取HttpSession 源码分析(推荐)  # Java中websocket消息推送的实现代码  # java WebSocket的实现以及Spring WebSocket示例代码  # 基于Tomcat7、Java、WebSocket的服务器推送聊天室实例  # 使用Java和WebSocket实现网页聊天室实例代码  # Java开发中常用的 Websocket 技术参考  # 客户端  # 服务端  # 下午  # 目录下  # 一个普通  # 发送消息  # 器中  # 来了  # 会有  # 还可以  # 就不  # 错了  # 可以看到  # 就不能  # 为例  # 可以实现  # 来实现  # 用它  # 太长  # 贴出 


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


相关推荐: Laravel观察者模式如何使用_Laravel Model Observer配置  高防服务器租用指南:配置选择与快速部署攻略  微信小程序 配置文件详细介绍  Laravel辅助函数有哪些_Laravel Helpers常用助手函数大全  韩国网站服务器搭建指南:VPS选购、域名解析与DNS配置推荐  如何在建站之星绑定自定义域名?  如何在云主机快速搭建网站站点?  iOS正则表达式验证手机号、邮箱、身份证号等  如何在Windows服务器上快速搭建网站?  UC浏览器如何设置启动页 UC浏览器启动页设置方法  HTML透明颜色代码在Angular里怎么设置_Angular透明颜色使用指南【详解】  python中快速进行多个字符替换的方法小结  弹幕视频网站制作教程下载,弹幕视频网站是什么意思?  如何在HTML表单中获取用户输入并用JavaScript动态控制复利计算循环  如何做网站制作流程,*游戏网站怎么搭建?  Laravel Eloquent访问器与修改器是什么_Laravel Accessors & Mutators数据处理技巧  东莞专业网站制作公司有哪些,东莞招聘网站哪个好?  免费网站制作appp,免费制作app哪个平台好?  猎豹浏览器开发者工具怎么打开 猎豹浏览器F12调试工具使用【前端必备】  Laravel Octane如何提升性能_使用Laravel Octane加速你的应用  Laravel模型事件有哪些_Laravel Model Event生命周期详解  如何在腾讯云免费申请建站?  详解Huffman编码算法之Java实现  免费制作统计图的网站有哪些,如何看待现如今年轻人买房难的情况?  MySQL查询结果复制到新表的方法(更新、插入)  android nfc常用标签读取总结  新三国志曹操传主线渭水交兵攻略  惠州网站建设制作推广,惠州市华视达文化传媒有限公司怎么样?  Laravel如何发送邮件和通知_Laravel邮件与通知系统发送步骤  美食网站链接制作教程视频,哪个教做美食的网站比较专业点?  Laravel如何升级到最新的版本_Laravel版本升级流程与兼容性处理  在Oracle关闭情况下如何修改spfile的参数  如何正确选择百度移动适配建站域名?  1688铺货到淘宝怎么操作 1688一键铺货到自己店铺详细步骤  活动邀请函制作网站有哪些,活动邀请函文案?  Laravel怎么进行数据库事务处理_Laravel DB Facade事务操作确保数据一致性  LinuxShell函数封装方法_脚本复用设计思路【教程】  Laravel模型关联查询教程_Laravel Eloquent一对多关联写法  Laravel如何实现全文搜索_Laravel Scout集成Algolia或Meilisearch教程  Laravel怎么配置自定义表前缀_Laravel数据库迁移与Eloquent表名映射【步骤】  Laravel如何使用Scope本地作用域_Laravel模型常用查询逻辑封装技巧【手册】  php打包exe后无法访问网络共享_共享权限设置方法【教程】  Laravel如何使用Sanctum进行API认证?(SPA实战)  Laravel如何实现文件上传和存储?(本地与S3配置)  JavaScript如何操作视频_媒体API怎么控制播放  EditPlus中的正则表达式实战(5)  如何快速搭建高效香港服务器网站?  简单实现Android验证码  Laravel Pest测试框架怎么用_从PHPUnit转向Pest的Laravel测试教程  如何快速生成高效建站系统源代码?