SpringBoot+websocket+定时任务

SpringBoot+websocket+定时任务

SpringBoot+websocket

概念

websocket:由于http协议时基于 请求-响应模型 服务端的每次响应都必须有客户端发起（浏览器）的请求。如果服务端想主动推送消息到客户端是很难满足的。
如果一定想使用http来做服务端主动推动，只能客户端不停的发起轮询请求，如果访问量很很大，这种模式会拖垮服务器。造成很大的通信开销和服务端流量压力。

使用websocket可以完成要求实时性的应用：股票的变动、天气、彩票、即时通讯、通知。

WebSocket 是web客户端和服务器之间新的通讯方式， 依然架构在HTTP协议之上。使用WebSocket连接， web应用程序可以执行实时的交互， 而不是以前的poll方式。

WebSocket是HTML5开始提供的一种在单个 TCP 连接上进行全双工通讯的协议，可以用来创建快速的更大规模的健壮的高性能实时的web应用程序。WebSocket通信协议于2011年被IETF定为标准RFC 6455，WebSocketAPI被W3C定为标准。
在WebSocket API中，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

现在大概了解了websocket的概念和应用，现在我们来看看如何在springBoot中集成websocket。

配置类

创建一个配置类：
使用@Configuration注解 声明这个类为配置类。
使用@EnableWebSocket注解表明这是一个websocket配置类，我们会在这个类配置一些websocket的参数和地址。
我们的配置类实现WebSocketConfigurer接口。

重写registerWebSocketHandlers方法，

	//配置指定地址：/demo的处理器，及通信允许的域名，这里使用*，表示匹配所有。
	webSocketHandlerRegistry.addHandler(new WebSocketDemoHanlder(),"/demo").setAllowedOrigins("*");
	
	
	/**
	 * @author xuelongjiang
	 */
	@Configuration
	@EnableWebSocket
	public class WebsocketConfig  implements WebSocketConfigurer{

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        webSocketHandlerRegistry.addHandler(new WebSocketDemoHanlder(),"/demo").setAllowedOrigins("*");
    }
	}

处理器

这里我们主要绑定WebSocketSession和我们的推送目标。

如果是聊天室，则根据约定的规则，进行用户与用户，用户与聊天室的绑定。

如果是彩票，推送消息到所有的WebSocketSession。

	package com.xuelongjiang.websocketdemo.websocket;

	import com.alibaba.fastjson.JSONObject;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;
	import org.springframework.web.socket.CloseStatus;
	import org.springframework.web.socket.TextMessage;
	import org.springframework.web.socket.WebSocketSession;
	import org.springframework.web.socket.handler.TextWebSocketHandler;

	import java.util.Map;
	import java.util.concurrent.ConcurrentHashMap;

	/**
	* @author xuelongjiang
 	*/
	
	public class WebSocketDemoHanlder extends TextWebSocketHandler {

    private Logger logger = LoggerFactory.getLogger(WebSocketDemoHanlder.class);

    private static Map<String,WebSocketSession> userIdSessionMap = new ConcurrentHashMap();
    private static Map<WebSocketSession,String> sessionUserIdMap = new ConcurrentHashMap<>();


    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {

            String  payload = message.getPayload();
            logger.info("websocket请求参数payload:{}",payload);
            JSONObject jsonObject = JSONObject.parseObject(payload);
            String action = jsonObject.getString("action");

            if("register".equals(action)){
                logger.info("注册websocket连接");
                String userId = jsonObject.getString("userId");
                logger.info("userId:{}注册session:{}",userId,session.getId());
                userIdSessionMap.put(userId,session);
                sessionUserIdMap.put(session,userId);
            }
    }

    //定时任务获取session
    public  static Map<String,WebSocketSession> getUserIdSessionMap(){
        return userIdSessionMap;
    }

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        super.afterConnectionEstablished(session);
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {

        //连接关闭后移除
        String userId = sessionUserIdMap.get(session);
        userIdSessionMap.remove(userId);
        logger.info("websocket session:{}关闭原因:{}",session,status);
    }
	}

到这里我们测试一下是否可以连接。

从上面可以看到我们已经和服务端建立了连接。

websocketSession：可以理解为http的一个会话。会话记录了这一次的通讯对象，我们可以使用seesion发送消息给客户端。

定时任务

在上面我们用一个线程安全的map,存储了userId和websocketSession的关系。现在我们用定时任务来发送消息给连接。

在springboot启动类增加注解@EnableScheduling
由于websocket和定时任务启动的时候会报错。的时候会报错。增加taskScheduler()方法。

	@SpringBootApplication
	@EnableScheduling
	public class WebsocketdemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(WebsocketdemoApplication.class, args);
	}


	/**
	 * 使用 websockt注解的时候，使用@EnableScheduling注解
	 * 启动的时候一直报错，增加这个bean 则报错解决。
	 * 报错信息：  Unexpected use of scheduler.
	 *https://stackoverflow.com/questions/49343692/websocketconfigurer-and-scheduled-are-not-work-well-in-an-application
	 *
	 * @return
	 */
	@Bean
	public TaskScheduler taskScheduler(){

		ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
		taskScheduler.setPoolSize(10);
		taskScheduler.initialize();
		return taskScheduler;
		}
	}

定时任务

 	package com.xuelongjiang.websocketdemo.schedule;

	import com.xuelongjiang.websocketdemo.websocket.WebSocketDemoHanlder;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;
	import org.springframework.scheduling.annotation.Scheduled;
	import org.springframework.stereotype.Service;
	import org.springframework.web.socket.TextMessage;
	import org.springframework.web.socket.WebSocketSession;

	import java.util.Map;

	/**
	 * 定时任务
	 * @author xuelongjiang
	 */
	@Service
	public class ScheduleTask {

    private Logger logger = LoggerFactory.getLogger(ScheduleTask.class);

    @Scheduled(cron = "* * 0/1 * * ?")
    public void sendMessage(){

        String message = "你好";

        Map<String,WebSocketSession> map = WebSocketDemoHanlder.getUserIdSessionMap();

        WebSocketSession session = map.get("xuelongjiang");//这里用户ID的获取可以根据具体业务，这里为了更简单的演示。
        if(session != null){
            try {
                session.sendMessage(new TextMessage(message));
            }catch (Exception e){
                logger.error("定时任务异常:{}",e);
            }
        }
    }
	}

websocket测试地址：http://www.blue-zero.com/WebSocket/
源码地址：https://github.com/longjiangxue/websocketDemo