Spring WebSocket教程(一)

学习背景

很久以前就知道WebSocket,但那时不论是浏览器还是开发技术对它的支持都还很少。但是,Spring4突然发布,让我眼前一亮,Spring4直接支持WebSocket。

对于Spring我还是很喜欢的,它让Java Web开发相当的有艺术感,这次支持的WebSocket又特别的和我的胃口,所以马上就去学习了。

前提

本文的内容,是建立在懂J2EE编程,使用过Spring,听说过WebSocket上的,如果前面的3点大家不太明白,可以先去补补知识。

WebSocket还不是很普遍,对服务器和浏览器都有要求,不过使用了下面的一些技术,可以将浏览器的要求降低,但是服务器容器的要求还是比较高的,具体哪些服务器容易支持了WebSocket可以百度一下。

第一步:配置Spring

如果你跟我一样采用的Maven,那么只需要将下面的几个依赖,加入到pom.xml文件就可以了:

[html] view plain copy

  1.   

  2.     <spring.version>4.0.0.RELEASE</spring.version>  

  3.   

  4.   

  5.       

  6.       

  7.         org.springframework  

  8.         spring-core  

  9.         ${spring.version}  

  10.       

  11.       

  12.         org.springframework  

  13.         spring-web  

  14.         ${spring.version}  

  15.       

  16.       

  17.         org.springframework  

  18.         spring-webmvc  

  19.         ${spring.version}  

  20.       

  21.       

  22.       

  23.         jstl  

  24.         jstl  

  25.         1.2  

  26.       

  27.       

  28.       

  29.         org.springframework  

  30.         spring-test  

  31.         ${spring.version}  

  32.         test  

  33.       

  34.       

  35.       

  36.         org.springframework  

  37.         spring-jdbc  

  38.         ${spring.version}  

  39.       

  40.       

  41.         junit  

  42.         junit  

  43.         4.8.2  

  44.         test  

  45.       

  46.       

  47.       

  48.         org.springframework  

  49.         spring-websocket  

  50.         ${spring.version}  

  51.       

  52.       

  53.         org.springframework  

  54.         spring-messaging  

  55.         ${spring.version}  

  56.       

  57.       

  58.       

  59.         com.fasterxml.jackson.core  

  60.         jackson-databind  

  61.         2.3.0  

  62.       

  63.       

  64.         commons-fileupload  

  65.         commons-fileupload  

  66.         1.2.2  

  67.       

  68.       

  69.         commons-io  

  70.         commons-io  

  71.         2.2  

  72.       

  73.       

  74.       

  75.         com.alibaba  

  76.         druid  

  77.         1.0.4  

  78.       

  79.       

  80.       

  81.         mysql  

  82.         mysql-connector-java  

  83.         5.1.29  

  84.       

  

Spring的配置我就不一一贴出来了,可以去github看,地址我会贴在下面。

第二步:配置WebSocket

我采用的是使用Configurer类和 Annotation来进行WebSocket配置。

首先要创建一个类,继承WebSocketMessageBrokerConfigurer,并且在类上加上annotation:@Configuration和@EnableWebSocketMessageBroker。这样,Spring就会将这个类当做配置类,并且打开WebSocket。

[java] view plain copy

  1. @Configuration  

  2. @EnableWebSocketMessageBroker  

  3. public class WebSocketConfig implements WebSocketMessageBrokerConfigurer{  

  4.     @Override  

  5.     public void registerStompEndpoints(StompEndpointRegistry registry) {  

  6.         //添加这个Endpoint,这样在网页中就可以通过websocket连接上服务了  

  7.         registry.addEndpoint("/coordination").withSockJS();  

  8.     }  

  9.     @Override  

  10.     public void configureMessageBroker(MessageBrokerRegistry config) {  

  11.         System.out.println("服务器启动成功");  

  12.         //这里设置的simple broker是指可以订阅的地址,也就是服务器可以发送的地址  

  13.         /** 

  14.          * userChat 用于用户聊天 

  15.          */  

  16.         config.enableSimpleBroker("/userChat");  

  17.         config.setApplicationDestinationPrefixes("/app");  

  18.     }  

  19.     @Override  

  20.     public void configureClientInboundChannel(ChannelRegistration channelRegistration) {  

  21.     }  

  22.     @Override  

  23.     public void configureClientOutboundChannel(ChannelRegistration channelRegistration) {  

  24.     }  

  25. }

  

可以看到,在类中必须实现这四个方法。暂且只需要用到前两个,所以我来介绍一下,前两个方法中代码的意义。

第一个方法,是registerStompEndpoints,大意就是注册消息连接点(我自己的理解),所以我们进行了连接点的注册:

[java] view plain copy

  1. registry.addEndpoint("/coordination").withSockJS();

  

我们加了一个叫coordination的连接点,在网页上我们就可以通过这个链接来和服务器的WebSocket连接了。但是后面还有一句withSockJs,这是什么呢?SockJs是一个WebSocket的通信js库,Spring对这个js库进行了后台的自动支持,也就是说,我们如果使用SockJs,那么我们就不需要对后台进行更多的配置,只需要加上这一句就可以了。

第二个方法,configureMessageBroker,大意是设置消息代理,也就是页面上用js来订阅的地址,也是我们服务器往WebSocket端接收js端发送消息的地址。

[java] view plain copy

  1. config.enableSimpleBroker("/userChat");  
  2. config.setApplicationDestinationPrefixes("/app");

  

首先,定义了一个连接点叫userChat,从名字可以看的出,最后我会做一个聊天的例子。然后,设置了一个应用程序访问地址的前缀,目的估计是为了和其他的普通请求区分开吧。也就是说,网页上要发送消息到服务器上的地址是/app/userChat。

说了这么多地址,估计大家都绕晕了,因为项目的整个雏形还没有出来,所以很混乱。所以接下来就配置js端。

第三步:配置Browser端

说了这么多地址,估计大家都绕晕了,因为项目的整个雏形还没有出来,所以很混乱。所以接下来就配置js端。

首先我们要使用两个js库,一个是之前说过的SockJs,一个是stomp,这是一种通信协议,暂时不介绍它,只需要知道是一种更方便更安全的发送消息的库就行了。

需要连接服务端的WebSocket:

[javascript] view plain copy

  1. var socket = new SockJS('/coordination');  
  2. var stompClient = Stomp.over(socket);  
  3. stompClient.connect('', '', function (frame) {});

  

没错,就只需要两句话。有了这三句话,我们就已经可以连接上了服务器。

使用SockJs还有一个好处,那就是对浏览器进行兼容,如果是IE11以下等对WebSocket支持不好的浏览器,SockJs会自动的将WebSocket降级到轮询(这个不知道的可以去百度一下),之前也说了,Spring对SockJs也进行了支持,也就是说,如果之前加了withSockJs那句代码,那么服务器也会自动的降级为轮询。(怎么样,是不是很兴奋,Spring这个特性太让人舒服了)

但是连接上了服务器,却没有进行任何的操作,所以下一步,我们要在服务器端撰写响应和数据处理代码,在Browser端撰写消息发送和接收代码。当然,这是下一篇的内容了。

结语

这是我的毕业设计,我的毕业设计是一个在线协同备课系统,其中包含了聊天这个小功能,所以使用它来讲解一下Spring WebSocket的使用。

我将代码放到了github上,有兴趣的朋友可以去看看代码,因为涉及到了很多协同操作,所以代码比较复杂,如果仅仅想了解Spring WebSocket的朋友,还是等我的下一篇文章吧。大笑

github地址:https://github.com/xjyaikj/OnlinePreparation

评论

暂无评论