Netty源码分析(一) 服务端 Channel 创建原理
1. 唠叨
既然您点开此文,那您在工作或学习中一定使用过 Netty。Netty 不仅使用起来十分方便,而且,它的设计也非常优雅,值得我们学习研究。出于这点,我开始了对 Netty 源码的学习,同时也将学习所得及时分享。希望与您共勉,一起学习共同进步。
2. 使用 Netty
我们先从一段启动服务端的源码开始(下文会多次引用序号源码位置进行说明)
源码 1
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
EventLoopGroup workerGroup = new NioEventLoopGroup();
try {
ServerBootstrap b = new ServerBootstrap(); // 1
b.group(bossGroup, workerGroup) // 2
.channel(NioServerSocketChannel.class) // 3
.childOption(ChannelOption.TCP_NODELAY, true) // 4
.childAttr(AttributeKey.newInstance("key"), "val") // 5
.handler(new ServerHandler()) // 6
.childHandler(new ChannelInitializer<SocketChannel>() { // 7
@Override
public void initChannel(SocketChannel ch) {
ChannelPipeline p = ch.pipeline();
if (sslCtx != null) {
p.addLast(sslCtx.newHandler(ch.alloc()));
}
p.addLast(new LoggingHandler(LogLevel.INFO));
p.addLast(serverHandler);
}
});
// Start the server.
ChannelFuture f = b.bind(8888).sync(); // 8
// Wait until the server socket is closed.
f.channel().closeFuture().sync(); // 9
} finally {
// Shut down all event loops to terminate all threads.
bossGroup.shutdownGracefully(); // 10
workerGroup.shutdownGracefully(); // 11
}
3. 服务端 Channel 创建
(重点)在一头扎进细节(源码)之前,我们应该把握住大局(主线流程)。以便在细致的学习中不迷失。下面是 Netty 创建服务端 Channel 的主线,请牢记。
1. ServerBootstrap.bind(int inetPort)
2. bind(SocketAddress localAddress)
3. oBind
4. initAndRegister
5. ReflectiveChannelFactory.newChannel
3.1 一起看源码
现在最好打开您的 IDE 我们一起走一遍上面的流程。您发现 ReflectiveChannelFactory 的 newChannel 最终通过如下源码为我们创建了服务端 Channel。
源码 2
public T newChannel() {
try {
return clazz.newInstance();
} catch (Throwable t) {
throw new ChannelException("Unable to create Channel from class " + clazz, t);
}
}
恭喜您,您已经掌握了服务端 Channel 的创建原理。等等... 这 clazz 是什么?
你(作者)来看看我的 IDE,newChannel 有那么多实现类,为什么就是 ReflectiveChannelFactory 的实现?
ReflectiveChannelFactory.newChannel
以上这些问题还没解决呢,你在忽悠我吧!
先别急,您也不用怀疑,流程就是这么简单。返回的结果就是这个 clazz 的默认构造函数。
还有为什么是 ReflectiveChannelFactory 的实现?想知道吗?那我们继续?(网络真好,我卖关子,你能怎样)
3.2 为什么是 ReflectiveChannelFactory
我们先来看下 initAndRegister 的源码,channelFactory 是否是 ReflectiveChannelFactory 的实例?channelFactory 是何时初始化的?
源码 3
final ChannelFuture initAndRegister() {
// 省略...
channel = channelFactory.newChannel();
// 省略...
}
(唠叨)等等... initAndRegister 是什么?看来您已经把我前面画的重点忘了。还是老实回到前面打开 IDE 一起走一遍流程吧,一定吃透主流程,吃透主流程,吃透主流程。
以上都理解后,我们来看看 channelFactory 的初始化
源码 4
public B channel(Class<? extends C> channelClass) {
// 省略
return channelFactory(new ReflectiveChannelFactory<C>(channelClass));
}
public B channelFactory(ChannelFactory<? extends C> channelFactory) {
// 省略
this.channelFactory = channelFactory;
return (B) this;
}
以上代码,是在 源码 1 ,标注 3 处,调用的 .channel(NioServerSocketChannel.class)方法,并传入了 NioServerSocketChannel.class。最终,我们实例化了 ReflectiveChannelFactory 并将它保存在 channelFactory 中。至此,我们知道了为什么是 ReflectiveChannelFactory。
3.3 clazz 是什么
我们一起来看 ReflectiveChannelFactory 的构造函数。clazz 是在构造 ReflectiveChannelFactory 时传入的。
源码 5
public ReflectiveChannelFactory(Class<? extends T> clazz) {
if (clazz == null) {
throw new NullPointerException("clazz");
}
this.clazz = clazz;
}
那 ReflectiveChannelFactory 又是如何构造的呢?需要我们回到 源码 4 我们在构造 ReflectiveChannelFactory 时传入了 channelClass,而 channelClass 就是 NioServerSocketChannel.class。所以 clazz 是 NioServerSocketChannel。
3.4 NioServerSocketChannel
至此,我们知道服务端 Channel 就是通过 NioServerSocketChannel 的默认构造器创建的。那我们一起看看 NioServerSocketChannel 的默认构造器做了什么。
源码 6
public NioServerSocketChannel() {
this(newSocket(DEFAULT_SELECTOR_PROVIDER));
}
首先调用 newSocket 方法,并处传入 DEFAULT_SELECTOR_PROVIDER,而 DEFAULT_SELECTOR_PROVIDER 就是 JDK 自带的 java.nio.channels.spi.SelectorProvider
private static final SelectorProvider DEFAULT_SELECTOR_PROVIDER = SelectorProvider.provider();
我们继续看 newSocket 方法。
源码 7
private static ServerSocketChannel newSocket(SelectorProvider provider) {
try {
/**
* Use the {@link SelectorProvider} to open {@link SocketChannel} and so remove condition in
* {@link SelectorProvider#provider()} which is called by each ServerSocketChannel.open() otherwise.
*
* See <a href="https://github.com/netty/netty/issues/2308">#2308</a>.
*/
return provider.openServerSocketChannel();
} catch (IOException e) {
throw new ChannelException(
"Failed to open a server socket.", e);
}
}
newSocket 方法很简单,通过 provider.openServerSocketChannel() 返回了 ServerSocketChannel。最后,源码 6 将 ServerSocketChannel 传给包含一个参数的构造器。该方法有继续调用父类构造函数,最终将 ServerSocketChannel 保存在 AbstractNioChannel 的 ch 实例变量中。
源码 8
public NioServerSocketChannel(ServerSocketChannel channel) {
super(null, channel, SelectionKey.OP_ACCEPT);
config = new NioServerSocketChannelConfig(this, javaChannel().socket());
}
注:这里还创建了 NioServerSocketChannelConfig 对象,服务端的配置信息会存在 config 中,我们之后的学习中会遇到。
通过以上分析,相信您已经掌握了服务端 Channel 的创建原理。
最后,感谢您的阅读,希望以上内容对您有所帮助。如果有疑问,欢迎留言与我讨论。