1. Netty源码研究笔记(1)——开篇
1.1. Netty介绍
Netty是一个老牌的高性能网络框架。在众多开源框架中都有它的身影,比如:grpc、dubbo、seata等。
里面有着非常多值得学的东西:
-
I/O模型
-
内存管理
-
各种网络协议的实现:http、redis、websocket等等
-
各种各样有趣的技巧的实现:异步、时间轮、池化、内存泄露探测等等。
-
代码风格、设计思想、设计原则等。
1.2. 源码分析方法
我一般是这样进行源码分析的:
-
首先是纵向,通过官方提供的demo,进行debug,并记录在一个完整的生命周期下的调用链上,会涉及到哪些组件。
-
然后对涉及到的组件拿出来,找出它们的顶层定义(接口、抽象类)。通过其模块/包的划分、类注释、定义的方法及其注释,来大致知晓每个组件是做什么的,以及它们在整个框架中的位置是怎样的。
-
第二步完成后,就可以对第一步的调用链流程、步骤、涉及到的组件,进行归纳、划分,从而做到心中有数,知道东南西北了。
-
之后就是横向,对这些归纳出来的组件体系,逐个进行分析。
-
在分析每个组件体系的时候,也是按照先纵向,再横向的步骤:
-
首先是纵向:找出该组件体系中的核心顶层接口、类,然后结合其的所有实现类,捋出继承树,然后弄清楚每个类做的是啥,它是怎么定义的,同一层级的不同实现类之间的区别大致是什么,必要的话,可以将这个继承树记下来,在心中推算几遍。
-
然后是横向:将各个类有选择性地拿出来分析。
-
当然,所谓的纵向,横向,这两个过程实际是互相交织的,也就是说整个流程不一定就分为前后两半:前面一半都是纵向,后面一半都是横向。
通过纵向的分析,我们能发现整个框架可以分成大致哪几个部分,以及有
1.3. 分析前的准备
- 首先在本地建一个对应的分析学习用的项目,比如:learn_netty,用maven管理依赖
- 然后在maven仓库,中找到我们需要的依赖,比如这里我用的是最新的:
<!-- https://mvnrepository.com/artifact/io.netty/netty-all -->
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
<version>4.1.77.Final</version>
</dependency>
- 将官方提供的demo代码,导入到项目中。
- 学习项目搭建好之后,就尝试编译、运行,没问题后,就命令行
mvn dependency:sources
命令(或者通过IDE)来下载依赖的源代码。 - 可选:在github上,将项目同时clone到本地,如果分析中发现问题或者自己有些优化建议,可以尝试为分析的项目贡献代码。
1.4. 分析示例的代码
以一个简单的EchoServer、EchoClient来研究。
public class EchoServer {
private final int port;
public EchoServer(int port) {
this.port = port;
}
public static void main(String[] args) throws Exception {
new EchoServer(8083).start();
}
public void start() throws Exception {
final EchoServerHandler serverHandler = new EchoServerHandler();
EventLoopGroup group = new NioEventLoopGroup();
try {
ServerBootstrap b = new ServerBootstrap();
b.group(group)
.channel(NioServerSocketChannel.class)
.localAddress(new InetSocketAddress(port))
.childHandler(new ChannelInitializer<SocketChannel>() {
@Override
public void initChannel(SocketChannel ch) {
ch.pipeline().addLast(serverHandler);
}
});
ChannelFuture f = b.bind().sync();
f.channel().closeFuture().sync();
} finally {
group.shutdownGracefully().sync();
}
}
public class EchoServerHandler extends ChannelInboundHandlerAdapter {
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
ByteBuf in = (ByteBuf) msg;
System.out.println("Server received: " + in.toString(CharsetUtil.UTF_8));
ctx.write(in);
}
@Override
public void channelReadComplete(Chan