WebSocket(后台代码)
一、WebSocket简单介绍
传统的HTTP协议是无状态的,每次请求(request)都要由客户端(如 浏览器)主动发起,服务端进行处理后返回response结果,而服务端很难主动向客户端发送数据;这种客户端是主动方,服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小,而对于涉及实时信息的Web应用却带来了很大的不便,如带有即时通信、实时数据、订阅推送等功能的应 用。在WebSocket规范提出之前,开发人员若要实现这些实时性较强的功能,经常会使用折衷的解决方法:轮询(polling)和Comet技术。其实后者本质上也是一种轮询,只不过有所改进。
轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求,频繁地查询是否有新的数据改动。明显地,这种方法会导致过多不必要的请求,浪费流量和服务器资源。
Comet技术又可以分为长轮询和流技术。长轮询改进了上述的轮询技术,减小了无用的请求。它会为某些数据设定过期时间,当数据过期后才会向服务端发送请求;这种机制适合数据的改动不是特别频繁的情况。流技术通常是指客户端使用一个隐藏的窗口与服务端建立一个HTTP长连接,服务端会不断更新连接状态以保持HTTP长连接存活;这样的话,服务端就可以通过这条长连接主动将数据发送给客户端;流技术在大并发环境下,可能会考验到服务端的性能。
这两种技术都是基于请求-应答模式,都不算是真正意义上的实时技术;它们的每一次请求、应答,都浪费了一定流量在相同的头部信息上,并且开发复杂度也较大。
JavaEE 7中出了JSR-356:Java API for WebSocket规范。Tomcat,Nginx,Jetty等都支持WebSocket。Tomcat从7.0.27开始支持 WebSocket,从7.0.47开始支持JSR-356。
二、代码
依赖
<!-- 这里我用的Spring Boot 1.5.9 里面集成了WebSocket -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<!-- 如果版本太低没有集成 就需要单独添加 WebSocket 的依赖 -->
<!-- <dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<version>7.0</version>
<scope>provided</scope>
</dependency> -->
<!-- GSON 依赖 List 转 String 用到了(不用可不添加) -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.2</version>
</dependency>
代码
@Component
@ServerEndpoint(value = "/websocket")
public class WebSocket {
private static final Logger log = LoggerFactory.getLogger(WebSocket.class);
//静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet<WebSocket> webSocketSet = new CopyOnWriteArraySet<WebSocket>();
//与某个客户端的连接会话,需要通过它来给客户端发送数据
private Session session;
//全局变量的返回值(这个是我DAO的返回类型(自定义的 List ,可自己定义或者去掉))
private static List<TerminalStateDTO> terminalStateDTOS;
//注解调用DAO 不起效 需要用工具类调用DAO
/*@Autowired
private LifeboatEquipmentMapper lifeboatEquipmentMapper;*/
//WebSocket调用DAO(WebSocket只能通过工具类获取DAO)
private LifeboatEquipmentMapper lifeboatEquipmentMapper = ApplicationContextRegister.getApplicationContext().getBean(LifeboatEquipmentMapper.class);
/**
* 连接建立成功调用的方法
*/
@OnOpen
public void onOpen(Session session) {
log.info("有新连接加入!当前在线人数为" + getOnlineCount());
try {
//连接上之后如果是空的就查询一次
if (terminalStateDTOS == null) {
terminalStateDTOS = lifeboatEquipmentMapper.lifeboatDNR();
}
this.session = session;
webSocketSet.add(this); //加入set中
addOnlineCount(); //在线数加1
sendMessage(objToJson(terminalStateDTOS));//群发方法
} catch (IOException e) {
log.error("websocket里面onOpen异常", e);
}
}
// //连接打开时执行
// @OnOpen
// public void onOpen(@PathParam("user") String user, Session session) {
// currentUser = user;
// System.out.println("Connected ... " + session.getId());
// }
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
try {
webSocketSet.remove(this); //从set中删除
subOnlineCount(); //在线数减1
log.info("有一连接关闭!当前在线人数为" + getOnlineCount());
} catch (Exception e) {
e.printStackTrace();
log.error("websocket里面onClose异常", e);
}
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息
*/
@OnMessage
public void onMessage(String message, Session session) {
try {
log.info("来自客户端的消息:" + message);
//返回值为空的时候 查询一次
if (terminalStateDTOS == null) {
//通过工具类调用DAO
terminalStateDTOS = lifeboatEquipmentMapper.lifeboatDNR();
}
//群发消息
for (WebSocket item : webSocketSet) {
//群发接收的是 String 需要将List转换成String(如果是字符串 就不需要转换)
item.sendMessage(objToJson(terminalStateDTOS));
}
} catch (IOException e) {
e.printStackTrace();
log.error("websocket里面onMessage异常", e);
}
}
/**
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
try {
log.error("发生错误");
error.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
log.error("websocket里面onError异常", e);
}
}
/**
* 收到客户端消息后调用的方法
* @param message 客户端发送过来的消息
*/
// @param session 可选的参数
public void sendMessage(String message) throws IOException {
try {
this.session.getBasicRemote().sendText(message);
} catch (IOException e) {
e.printStackTrace();
log.error("websocket里面sendMessage异常", e);
}
}
/**
* 群发自定义消息(暂时未用到)
*/
public static void sendInfo(String message) throws IOException {
try {
for (WebSocket item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
continue;
}
}
} catch (Exception e) {
e.printStackTrace();
log.error("websocket里面sendInfo异常", e);
}
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocket.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocket.onlineCount--;
}
/**
* 对象转json
*
* @param obj 对象
* @return json字符串
*/
public static String objToJson(Object obj) {
return new GsonBuilder().serializeNulls().create().toJson(obj);
}
}
配置(在本地运行的时候需要添加 打成WAR包时需要注释掉)
//在本地运行的时候需要添加配置(打成WAR包时需要注释掉)
@Configuration
public class WebSocketConfig {
/**
* ServerEndpointExporter 作用
*
* 这个Bean会自动注册使用@ServerEndpoint注解声明的websocket endpoint
*
* @return
*/
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
WebSocket 调用DAO工具类代码
/**
* WebSocket 调用DAO的工具
*/
@Component
@Lazy(false)
public class ApplicationContextRegister implements ApplicationContextAware {
private static ApplicationContext APPLICATION_CONTEXT;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
APPLICATION_CONTEXT = applicationContext;
}
public static ApplicationContext getApplicationContext() {
return APPLICATION_CONTEXT;
}
}
测试
http://www.jsons.cn/websocket/