- 背景
- 依赖
- 包结构
- 实现 WebSocketServer
- 业务handler WebSocketServerHandler
- 测试
- xxl-job 源码中基于netty实现的http
- 总结
- 参考
- 源码
上次看了下xxl-job,发现他的通信机制就是自己基于Netty实现了一个http服务器,然后发现自己看的不是很懂,就打算自己来实现一个简单的支持http协议和webSocket协议的服务器来帮助自己理解
依赖com.alibaba fastjson 1.2.62 cn.hutool hutool-all 5.7.13 io.netty netty-all 5.0.0.Alpha1
包结构 实现 WebSocketServer主要这里我的netty版本用的5.x,推荐使用4.x版本的netty,因为netty 5.x好像是被netty作者废弃掉了。5.x版本和4.x版本部分api可能不同
- WebSocketServer.java
@Slf4j
public class WebSocketServer {
// /Users/weihu/Desktop/sofe/java/netty-student/netty-websocket/src/main/resources/WebSocketServer.html
public static void main(String[] args) throws Exception{
int port = args.length > 0 ? Integer.parseInt(args[0]) : 8080;
new WebSocketServer().run(port);
}
public void run(int port) throws Exception{
EventLoopGroup bossGroup = new NioEventLoopGroup();
EventLoopGroup workGroup = new NioEventLoopGroup();
try {
ServerBootstrap bootstrap = new ServerBootstrap();
bootstrap.group(bossGroup, workGroup)
.channel(NioServerSocketChannel.class).childHandler(new ChannelInitializer() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
ChannelPipeline pipeline = ch.pipeline();
pipeline.addLast("http-codec", new HttpServerCodec()) // http 编解码处理器
// http多个消息部分组合成一条完整http消息
.addLast("aggregator", new HttpObjectAggregator(65536))
// 支持向客户端发送html5消息,主要用于支持浏览器和服务端进行websocket 通信,如果仅是http服务不需要该处理器
.addLast("http-chunked", new ChunkedWriteHandler())
// 核心业务逻辑处理器
.addLast("handler", new WebSocketServerHandler());
}
});
Channel channel = bootstrap.bind(port).sync().channel();
log.info("Web socket or http server started at port: {}", port);
log.info("open your browser and navigate to http://localhost:{}/",port);
channel.closeFuture().sync();
} finally {
bossGroup.shutdownGracefully();
workGroup.shutdownGracefully();
}
}
}
业务handler WebSocketServerHandler这里的代码其实就是固定的一套模板,当然如果是要优化一些网络相关的参数另说,可以看到接收和处理,核心业务逻辑都在WebSocketServerHandler这个类中
- WebSocketServerHandler.java
@Slf4j public class WebSocketServerHandler extends SimpleChannelInboundHandler
这里为了方便测试websock,这里再写一个简单的html页面
- WebSocketServer.html
Netty WebSocket 时间服务器
测试
我们直接运行WebSocketServer的main方法,不传入端口号默认8080
我们先测试http请求的处理,直接访问
http://localhost:8080/index?query=1
可以看到处理成功了
然后我们试试WebSocket的测试
我们直接在浏览器输入我们WebSocketServer.html的绝对路径
可以看到WebSocket连接是正常的,接下来我们试试发送消息试试
可以看到客户端成功接收到了服务端返回的数据
我们看看服务端的log
可以看到也是接收成功到了客户端发来的消息
上面我们简单的实现一个http、WebSocket的demo,我们下面来简单看看在xxl-job源码中是如何实现的
核心入口在EmbedServer这个类中,我们简单的分析下
可以看到首先标准的两个EventLoopGroup
然后可以看到添加handler和我们上面实现的demo类似,不同的是因为他只是支持http所以没有
ChunkedWriteHandler这个handler,但是他多了一个IdleStateHandler,Netty的IdleStateHandler主要用于心跳机制,用来检测远端是否存活,如果不存活或活跃则对空闲Socket连接进行处理避免资源的浪费
这里他的http请求核心实现都放在了EmbedHttpServerHandler这个类,我们看看这个类吧
EmbedHttpServerHandler是EmbedServer的一个静态内部类。和我们实现的WebSocketServerHandler类似,不同的首先他在继承SimpleChannelInboundHandler指定了泛型为FullHttpRequest代表仅处理http,其次由于xxl-job使用的netty版本为4.x,所以它需要实现的抽象方法也变为了
protected void channelRead0(final ChannelHandlerContext ctx, FullHttpRequest msg) throws Exception {
}
我们看看 channelRead0方法的实现
可以看到和我们实现没啥区别,不同的是处理请求又开了一个线程池,核心处理逻辑在process中
可以看到也很简单,如果为post请求直接不支持,然后加了一些token验证,然后将请求数据转换为java类作一些业务逻辑处理然后返回
至此 xxl-job的通信源码大致就分析完了
总结可以看到如果我们不需要自定义协议,整体基于netty的开箱即用实现起来还是非常方便的,让我们更专注于业务逻辑的处理,如果要自定义消息体,加一些编解码,半包的处理等,还是比较麻烦的,实现简单的http请求还是比较容易的
参考- Netty权威指南
- xxl-job源码
源码下载



