欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解java WebSocket的实现以及Spring WebSocket

程序员文章站 2024-03-08 16:43:17
开始学习websocket,准备用它来实现一个在页面实时输出log4j的日志以及控制台的日志。 首先知道一些基础信息: 1.java7 开始支持websocket,...

开始学习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

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