SpringBoot搭建netty-socketio教程
⾸先按照搭建项⽬
序⾔：因⼯作项⽬需要使⽤到推送功能，且与前端Socket.IO框架对接，因此使⽤了Netty-SocketIO。Netty-SocketIO顾名思义是基于Netty的SocketIO，底层是基于Netty。有关SocketIO的相关API与官⽹提供的NodeJS版本API相似，相关配置与Netty相关配置相似。以下代码在SpringBoot项⽬中书写，解释都在代码⾥，直接看代码吧。
netty-socketio maven依赖
<dependency>
<groupId&undumstudio.socketio</groupId>
<artifactId>netty-socketio</artifactId>
<version>1.7.7</version>
</dependency>
application.properties相关配置
#============================================================================
# netty socket io setting
#============================================================================
# host在本地测试可以设置为localhost或者本机IP，在Linux服务器跑可换成服务器IP
socketio.host=localhost
socketio.port=9099
# 设置最⼤每帧处理数据的长度，防⽌他⼈利⽤⼤数据来攻击服务器
socketio.maxFramePayloadLength=1048576
# 设置http交互最⼤内容长度
socketio.maxHttpContentLength=1048576
# socket连接数⼤⼩（如只监听⼀个端⼝boss线程组为1即可）
socketio.bossCount=1
socketio.workCount=100
socketio.allowCustomRequests=true
# 协议升级超时时间（毫秒），默认10秒。HTTP握⼿升级为ws协议超时时间
socketio.upgradeTimeout=10000
# Ping消息超时时间（毫秒），默认60秒，这个时间间隔内没有接收到⼼跳消息就会发送超时事件
socketio.pingTimeout=60000
# Ping消息间隔（毫秒），默认25秒。客户端向服务器发送⼀条⼼跳消息间隔
socketio.pingInterval=25000
SocketIOConfig.java配置⽂件相关配置
undumstudio.socketio.SocketConfig;
import org.springframework.beans.factory.annotation.Value;
import t.annotation.Bean;
import t.annotation.Configuration;
undumstudio.socketio.SocketIOServer;
@Configuration
public 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
*/
@Bean
public SocketIOServer socketIOServer(){
SocketConfig socketConfig =new SocketConfig();
socketConfig.setTcpNoDelay(true);
socketConfig.setSoLinger(0);
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接⼝，供其他地⽅需要使⽤时调⽤。
public interface SocketIOService {
//推送的事件
public static final String PUSH_EVENT ="push_event";
// 启动服务
void start()throws Exception;
// 停⽌服务
void stop();
// 推送信息
void pushMessageToUser(PushMessage pushMessage);
}
SocketIOServiceImpl.java接⼝实现类
import java.util.List;
import java.util.Map;
import urrent.ConcurrentHashMap;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import org.apachemons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
undumstudio.socketio.SocketIOClient;
undumstudio.socketio.SocketIOServer;
@Service(value ="socketIOService")
public class SocketIOServiceImpl implements SocketIOService {
// ⽤来存已连接的客户端
private static Map<String, SocketIOClient> clientMap =new ConcurrentHashMap<>();
@Autowired
private SocketIOServer socketIOServer;
/**
* Spring IoC容器创建之后，在加载SocketIOServiceImpl Bean之后启动
* @throws Exception
*/
@PostConstruct
private void autoStartup()throws Exception {
start();
}
/**
* Spring IoC容器在销毁SocketIOServiceImpl Bean之前关闭，避免重启项⽬服务端⼝占⽤问题 * @throws Exception
*/
@PreDestroy
private void autoStop()throws Exception {
stop();
}
@Override
public void start(){
// 监听客户端连接
socketIOServer.addConnectListener(client ->{
String loginUserNum =getParamsByClient(client);
if(loginUserNum != null){
clientMap.put(loginUserNum, client);
}
});
});
// 监听客户端断开连接
socketIOServer.addDisconnectListener(client ->{
String loginUserNum =getParamsByClient(client);
if(loginUserNum != null){
client.disconnect();
}
});
// 处理⾃定义的事件，与连接监听类似
socketIOServer.addEventListener(PUSH_EVENT, PushMessage.class,(client, data, ackSender)->{ // TODO do something
});
socketIOServer.start();
}
@Override
public void stop(){
if(socketIOServer != null){
socketIOServer.stop();
socketIOServer = null;
}
}
@Override
public void pushMessageToUser(PushMessage pushMessage){
String loginUserNum = LoginUserNum();
if(StringUtils.isNotBlank(loginUserNum)){
SocketIOClient client = (loginUserNum);
if(client != null)
client.sendEvent(PUSH_EVENT, pushMessage);
}
}
/**
* 此⽅法为获取client连接中的参数，可根据需求更改
* @param client
* @return
*/
private String getParamsByClient(SocketIOClient client){jquery框架搭建
/
/ 从请求的连接中拿出参数（这⾥的loginUserNum必须是唯⼀标识）
Map<String, List<String>> params = HandshakeData().getUrlParams();
List<String> list = ("loginUserNum");
if(list != null && list.size()>0){
(0);
}
return null;
}
}
PushMessage 实体类：推送到客户端的消息体
@Data
@ToString
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class PushMessage {
@ApiModelProperty(value ="登录⽤户编号")
private Integer loginUserNum;
@ApiModelProperty(value ="推送内容")
private String content;
// Other
}
前端相关测试页⾯编写
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> <title>NETTY SOCKET.IO DEMO</title>
<base>
<script src="../static/js/jquery-1.11.1.min.js"></script>
<script src="../static/js/socket.io.js"></script>
<style>
body {
padding:20px;
}
#console {
height:450px;
overflow: auto;
}
.username-msg {
color: orange;
}
.connect-msg {
color: green;
}
.
disconnect-msg {
color: red;
}
</style>
</head>
<body>
<div id="console"class="well"></div>
</body>
<script type="text/javascript">
var socket;
connect();
function connect(){
var loginUserNum ='88';
var opts ={
query:'loginUserNum='+ loginUserNum
};
socket = io.connect('localhost:9099', opts);
<('connect', function (){
console.log("连接成功");
serverOutput('<span class="connect-msg">连接成功</span>');
});
<('push_event', function (data){
output('<span class="username-msg">'+ data +' </span>');
console.log(data);
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论