Spring4.0 + websocket简单应用

Spring 4.0的一个最大更新是增加了websocket的支持。websocket提供了一个在web应用中的高效、双向的通讯，需要考虑到客户端（浏览器）和服务器之间的高频和低延时消息交换。一般的应用场景有：在线交易、游戏、协作、数据可视化等。

使用websocket需要考虑的浏览器的支持（IE<10不支持），目前主流的浏览器都能很好的支持websocket。

websocket协议中有一些子协议，可以从更高的层次实现编程模型，就像我们使用HTTP而不是TCP一样。这些子协议有STOMP,WAMP等。

本教程只考虑websocket的简单实用，包含Spring对JSR-356的支持及Spring WebSocket API。

1、Java API for WebSocket(JSR-356)

Java API for WebSocket已经是Java EE 7的一部分。它定义了两类endpoit（都是EndPoint类的子类），使用注解标识@ClientEndpoint和@ServerEndpoint。

1.1 Servlet容器扫描初始化

通过Spring初始化一个endpoint，只需配置一个SpringConfigurator在类上的@ServerEndpoint注解上。

import javax.websocket.server.ServerEndpoint;
import org.springframework.web.socket.server.endpoint.SpringConfigurator;

@ServerEndpoint(value = "/echo", configurator = SpringConfigurator.class)；
public class EchoEndpoint {

private final EchoService echoService;

@Autowired
public EchoEndpoint(EchoService echoService) {
this.echoService = echoService;
}

@OnMessage
public void handleMessage(Session session, String message) {
// ...
}

}

上例假设SpringContextLoaderListener用来加载配置，这是个典型的web应用。Servlet容器将通过扫描@ServerEndpoint和SpringConfigurator初始化一个新的websocket会话。

1.2 Spring 初始化

如果你想使用一个单独的实例而不使用Servlet容器扫描，将EchoEndpoint类声明称一个bean，并增加一个ServerEndpointExporter的bean：

import org.springframework.web.socket.server.endpoint.ServerEndpointExporter;

@Configuration
public class EndpointConfig {

@Bean
public EchoEndpoint echoEndpoint() {
return new EchoEndpoint(echoService());
}

@Bean
public EchoService echoService() {
// ...
}

@Bean
public ServerEndpointExporter endpointExporter() {
return new ServerEndpointExporter();
}

}

EchoEndpoint 可以通过EndPointRegistration发布：

import org.springframework.web.socket.server.endpoint.ServerEndpointExporter;
import org.springframework.web.socket.server.endpoint.ServerEndpointRegistration;

@Configuration
public class EndpointConfig {

@Bean
public EndpointRegistration echoEndpoint() {
return new EndpointRegistration("/echo", EchoEndpoint.class);
}

@Bean
public ServerEndpointExporter endpointExporter() {
return new ServerEndpointExporter();
}

// ..

}

本例源码：spring-websocket-test-endpoint.zip

2、Spring WebSocket API

Spring WebSocket API提供了SockJS的支持，且有些容器如Jetty 9目前还没有对JSR-356的支持，所以有Spring WebSocket API是必要的。

Spring WebSocket API的核心接口是WebSocketHandler。下面是一个处理文本消息的handler的实现：

import org.springframework.web.socket.adapter.TextWebSocketHandlerAdapter;

public class EchoHandler extends TextWebSocketHandlerAdapter {

@Override
public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
session.sendMessage(message);
}

}

WebSocketHandler可以通过WebSocketHttpRequestHandler插入到Spring MVC里：

import org.springframework.web.socket.server.support.WebSocketHttpRequestHandler;

@Configuration
public class WebConfig {

@Bean
public SimpleUrlHandlerMapping handlerMapping() {

Map<String, Object> urlMap = new HashMap<String, Object>();
urlMap.put("/echo", new WebSocketHttpRequestHandler(new EchoHandler()));

SimpleUrlHandlerMapping hm = new SimpleUrlHandlerMapping();
hm.setUrlMap(urlMap);
return hm;
}

}

SockJS服务器端的支持

SockJs是一个脚本框架，它提供类似于websocket的编程模式但是可以适应不同的浏览器（包括不支持websocket的浏览器）。

开启SockJS的支持，声明一个SockJsService，和一个url映射，然后提供一个WebSocketHandler来处理消息。虽然我们是哟个SockJS我们开发的方式是一样的，但是随着浏览器的不同传输的协议可以是Http Streaming，long polling等。

import org.springframework.web.socket.sockjs.SockJsService;
// ...

@Configuration
public class WebConfig {

@Bean
public SimpleUrlHandlerMapping handlerMapping() {

SockJsService sockJsService = new DefaultSockJsService(taskScheduler());

Map<String, Object> urlMap = new HashMap<String, Object>();
urlMap.put("/echo/**", new SockJsHttpRequestHandler(sockJsService, new EchoHandler()));

SimpleUrlHandlerMapping hm = new SimpleUrlHandlerMapping();
hm.setUrlMap(urlMap);
return hm;
}

@Bean
public ThreadPoolTaskScheduler taskScheduler() {
ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
taskScheduler.setThreadNamePrefix("SockJS-");
return taskScheduler;
}

}

在我们实际使用中我们会使用WebSocketConfigurer集中注册WebSocket服务：

@Configuration
@EnableWebMvc
@EnableWebSocket//开启websocket
public class WebConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {

@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {

registry.addHandler(echoWebSocketHandler(), "/echo"); //提供符合W3C标准的Websocket数据
registry.addHandler(snakeWebSocketHandler(), "/snake");

registry.addHandler(echoWebSocketHandler(), "/sockjs/echo").withSockJS();//提供符合SockJS的数据
registry.addHandler(snakeWebSocketHandler(), "/sockjs/snake").withSockJS();
}

@Bean
public WebSocketHandler echoWebSocketHandler() {
return new EchoWebSocketHandler(echoService());
}

@Bean
public WebSocketHandler snakeWebSocketHandler() {
return new PerConnectionWebSocketHandler(SnakeWebSocketHandler.class);
}

@Bean
public DefaultEchoService echoService() {
return new DefaultEchoService("Did you say \"%s\"?");
}

// Allow serving HTML files through the default Servlet

@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}

}

SockJS客户端代码：

ws = new SockJS(url, undefined, {protocols_whitelist: transports}) ；   //初始化 websocket

ws.onopen = function () {
setConnected(true);
log('Info: connection opened.');
};

ws.onmessage = function (event) {
log('Received: ' + event.data); //处理服务端返回消息
};

ws.onclose = function (event) {
setConnected(false);
log('Info: connection closed.');
log(event);
};

ws.send(message);//向服务端发送消息

程序用maven打成war后用tomcat 8发布查看效果。

本例源码：spring-websocket-test-master.zip

原文章地址：http://wiselyman.iteye.com/blog/2003336