socket.io文档链接: https://socket.io/docs/v4/
netty-socketio maven依赖
application.properties相关配置
netty socket io setting
socketio:# 内网ip# host: localhostport: 8084# 设置最大每帧处理数据的长度,防止他人利用大数据来攻击服务器maxFramePayloadLength: 1048576# 设置http交互最大内容长度maxHttpContentLength: 1048576# socket连接数大小(如只监听一个端口boss线程组为1即可)bossCount: 1workCount: 100allowCustomRequests: true# 协议升级超时时间(毫秒),默认10秒。HTTP握手升级为ws协议超时时间upgradeTimeout: 1000000# Ping消息超时时间(毫秒),默认60秒,这个时间间隔内没有接收到心跳消息就会发送超时事件pingTimeout: 6000000# Ping消息间隔(毫秒),默认25秒。客户端向服务器发送一条心跳消息间隔pingInterval: 25000
SocketIOConfig.java配置文件相关配置
package com.jiuli.api.config;import com.corundumstudio.socketio.SocketConfig;import com.corundumstudio.socketio.SocketIOServer;import org.springframework.beans.factory.annotation.Value;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class SocketIOConfig {@Value("${socketio.host}")private String host;@Value("${socketio.port}")private Integer port;@Value("${socketio.bossCount}")private int bossCount;@Value("${socketio.workCount}")private int workCount;@Value("${socketio.allowCustomRequests}")private boolean allowCustomRequests;@Value("${socketio.upgradeTimeout}")private int upgradeTimeout;@Value("${socketio.pingTimeout}")private int pingTimeout;@Value("${socketio.pingInterval}")private int pingInterval;/*** 以下配置在上面的application.properties中已经注明* @return*/@Beanpublic SocketIOServer socketIOServer() {SocketConfig socketConfig = new SocketConfig();socketConfig.setTcpNoDelay(true);socketConfig.setSoLinger(0);com.corundumstudio.socketio.Configuration config = new com.corundumstudio.socketio.Configuration();config.setSocketConfig(socketConfig);config.setHostname(host);config.setPort(port);config.setBossThreads(bossCount);config.setWorkerThreads(workCount);config.setAllowCustomRequests(allowCustomRequests);config.setUpgradeTimeout(upgradeTimeout);config.setPingTimeout(pingTimeout);config.setPingInterval(pingInterval);return new SocketIOServer(config);}}
以下就是提供一个SocketIOService接口,供其他地方需要使用时调用。
package com.jiuli.websocket.service;import com.jiuli.websocket.domian.PushMessage;/*** 功能描述** @author: zyu* @description:* @date: 2019/4/23 10:41*/public interface SocketIOService {//推送的事件public static final String PUSH_EVENT = "push_event";// 启动服务void start() throws Exception;// 停止服务void stop();// 推送信息void pushMessageToUser(PushMessage pushMessage);}
SocketIOServiceImpl.java接口实现类
import com.corundumstudio.socketio.SocketIOClient;import com.corundumstudio.socketio.SocketIOServer;import com.jiuli.api.util.JwtUtil;import com.jiuli.websocket.domian.PushMessage;import com.jiuli.websocket.service.SocketIOService;import org.apache.commons.lang3.StringUtils;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Service;import javax.annotation.PostConstruct;import javax.annotation.PreDestroy;import java.util.List;import java.util.Map;import java.util.concurrent.ConcurrentHashMap;@Servicepublic class SocketIOServiceImpl implements SocketIOService {// 用来存已连接的客户端private static Map<String, SocketIOClient> clientMap = new ConcurrentHashMap<>();@Autowiredprivate SocketIOServer socketIOServer;/*** Spring IoC容器创建之后,在加载SocketIOServiceImpl Bean之后启动** @throws Exception*/@PostConstructprivate void autoStartup() throws Exception {start();}/*** Spring IoC容器在销毁SocketIOServiceImpl Bean之前关闭,避免重启项目服务端口占用问题** @throws Exception*/@PreDestroyprivate void autoStop() throws Exception {stop();}@Overridepublic void start() throws Exception {// 监听客户端连接socketIOServer.addConnectListener(client -> {String auth = getParamsByClient(client);String token = auth.replace("Bearer ", "");String username = JwtUtil.getUsername(token);if (StringUtils.isNotEmpty(username)) {clientMap.put(username, client);}});// 监听客户端断开连接socketIOServer.addDisconnectListener(client -> {String loginUserNum = getParamsByClient(client);if (loginUserNum != null) {clientMap.remove(loginUserNum);System.out.println("断开连接: " + loginUserNum);System.out.println("断开连接: " + client.getSessionId());client.disconnect();}});// 处理自定义的事件,与连接监听类似socketIOServer.addEventListener("text", Object.class, (client, data, ackSender) -> {// TODO do somethingclient.getHandshakeData();System.out.println( " 客户端:************ " + data);});socketIOServer.start();}@Overridepublic void stop() {if (socketIOServer != null) {socketIOServer.stop();socketIOServer = null;}}@Overridepublic void pushMessageToUser(PushMessage pushMessage) {String loginUserNum = pushMessage.getLoginUserNum();if (StringUtils.isNotBlank(loginUserNum)) {SocketIOClient client = clientMap.get(loginUserNum);if (client != null) {client.sendEvent(PUSH_EVENT, pushMessage);}}}/*** 此方法为获取client连接中的参数,可根据需求更改* @param client* @return*/private String getParamsByClient(SocketIOClient client) {// 从请求的连接中拿出参数(这里的loginUserNum必须是唯一标识)Map<String, List<String>> params = client.getHandshakeData().getUrlParams();List<String> list = params.get("auth");if (list != null && list.size() > 0) {return list.get(0);}return null;}public static Map<String, SocketIOClient> getClientMap() {return clientMap;}public static void setClientMap(Map<String, SocketIOClient> clientMap) {SocketIOServiceImpl.clientMap = clientMap;}}
