Netty Review - ServerBootstrap源码解析

文章目录

  • 概述
  • 源码分析
  • 小结

在这里插入图片描述

在这里插入图片描述


概述

在这里插入图片描述

   ServerBootstrap bootstrap = new ServerBootstrap();bootstrap.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class).option(ChannelOption.SO_BACKLOG, 1024).childHandler(new ChannelInitializer<SocketChannel>() {@Overrideprotected void initChannel(SocketChannel ch) throws Exception {ChannelPipeline pipeline = ch.pipeline();//加入特殊分隔符分包解码器pipeline.addLast(new DelimiterBasedFrameDecoder(10240, Unpooled.copiedBuffer("_".getBytes())));//向pipeline加入解码器pipeline.addLast("decoder", new StringDecoder());//向pipeline加入编码器pipeline.addLast("encoder", new StringEncoder());//加入自己的业务处理handlerpipeline.addLast(new ChatServerHandler());}});

这段代码使用Netty构建了一个服务器。

  1. ServerBootstrap bootstrap = new ServerBootstrap(); - 创建一个ServerBootstrap实例,用于启动服务器。

  2. bootstrap.group(bossGroup, workerGroup) - 指定了服务器使用的两个EventLoopGroup,分别是bossGroup和workerGroup。其中,bossGroup用于接受传入的连接,而workerGroup用于处理已接受连接的流量。

  3. bootstrap.channel(NioServerSocketChannel.class) - 指定了服务器的Channel类型为NioServerSocketChannel,这表示使用NIO进行网络通信。

  4. bootstrap.option(ChannelOption.SO_BACKLOG, 1024) - 设置服务器的配置选项。在这里,设置了SO_BACKLOG,表示服务器套接字的连接队列大小为1024。

  5. bootstrap.childHandler(new ChannelInitializer<SocketChannel>() {...}) - 指定了当一个新的连接被接受时,所要执行的ChannelInitializer。这个匿名内部类用于配置新接受的Channel的ChannelPipeline,即为每个新接受的连接设置处理器。

  6. pipeline.addLast(new DelimiterBasedFrameDecoder(10240, Unpooled.copiedBuffer("_".getBytes()))) - 向ChannelPipeline中添加了一个DelimiterBasedFrameDecoder,用于根据特殊分隔符进行分包解码,这里的特殊分隔符是下划线"_”。

  7. pipeline.addLast("decoder", new StringDecoder()) - 向ChannelPipeline中添加了一个StringDecoder,用于将接收到的ByteBuf解码为字符串。

  8. pipeline.addLast("encoder", new StringEncoder()) - 向ChannelPipeline中添加了一个StringEncoder,用于将字符串编码为ByteBuf。

  9. pipeline.addLast(new ChatServerHandler()) - 向ChannelPipeline中添加了一个ChatServerHandler,这是自定义的业务处理Handler,用于处理接收到的消息。

总的来说,这段代码创建了一个基于Netty的服务器,配置了服务器的事件处理流程,包括接受连接、解码、编码和业务处理。


源码分析

ServerBootstrap bootstrap = new ServerBootstrap();

ServerBootstrap类的构造函数。在这个构造函数中,没有参数,它是一个默认构造函数。

bootstrap.group(bossGroup, workerGroup)

这段代码是ServerBootstrap类中的group方法的实现。

/*** Set the {@link EventLoopGroup} for the parent (acceptor) and the child (client). These* {@link EventLoopGroup}'s are used to handle all the events and IO for {@link ServerChannel} and* {@link Channel}'s.*/
public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup) {// 调用父类的group方法,设置父EventLoopGroupsuper.group(parentGroup);// 检查子EventLoopGroup是否为空,如果为空则抛出NullPointerExceptionif (childGroup == null) {throw new NullPointerException("childGroup");}// 检查是否已经设置了子EventLoopGroup,如果已经设置了则抛出IllegalStateExceptionif (this.childGroup != null) {throw new IllegalStateException("childGroup set already");}// 将传入的子EventLoopGroup赋值给成员变量childGroupthis.childGroup = childGroup;// 返回ServerBootstrap实例,用于链式调用return this;
}

这段代码的作用是设置ServerBootstrap的父(acceptor)和子(client)EventLoopGroup。这两个EventLoopGroup分别用于处理服务器端(acceptor)和客户端(client)的事件和IO操作。具体来说,这个方法会将传入的父EventLoopGroup设置给父类AbstractBootstrap,并将传入的子EventLoopGroup赋值给ServerBootstrap的成员变量childGroup。

在方法的实现中,

  • 首先调用了父类的group方法来设置父EventLoopGroup。
  • 然后,检查传入的子EventLoopGroup是否为空,如果为空则抛出NullPointerException。接着,检查是否已经设置了子EventLoopGroup,如果已经设置了则抛出IllegalStateException。
  • -最后,将传入的子EventLoopGroup赋值给成员变量childGroup,并返回ServerBootstrap实例,以支持链式调用。

总的来说,这段代码的目的是为ServerBootstrap设置父和子EventLoopGroup,以便于处理服务器和客户端的事件和IO操作,并提供了异常处理机制以确保参数的有效性。


我们看下 调用父类的group方法,设置父EventLoopGroup

super.group(parentGroup);

这段代码是一个泛型方法,通常用于在Netty的Bootstrap或ServerBootstrap中设置用于处理事件的EventLoopGroup。

/*** The {@link EventLoopGroup} which is used to handle all the events for the to-be-created* {@link Channel}*/
public B group(EventLoopGroup group) {// 检查传入的EventLoopGroup是否为空,如果为空则抛出NullPointerExceptionif (group == null) {throw new NullPointerException("group");}// 检查是否已经设置了EventLoopGroup,如果已经设置了则抛出IllegalStateExceptionif (this.group != null) {throw new IllegalStateException("group set already");}// 将传入的EventLoopGroup赋值给成员变量groupthis.group = group;// 返回调用该方法的实例,以支持链式调用return self();
}

这个方法主要用于设置用于处理事件的EventLoopGroup,它会将传入的EventLoopGroup赋值给成员变量group。

在方法的实现中,

  • 首先检查传入的EventLoopGroup是否为空,如果为空则抛出NullPointerException。
  • 然后,检查是否已经设置了EventLoopGroup,如果已经设置了则抛出IllegalStateException。
  • 最后,将传入的EventLoopGroup赋值给成员变量group,并返回调用该方法的实例,以支持链式调用。

总的来说,这段代码的作用是为Netty的Bootstrap或ServerBootstrap设置EventLoopGroup,以便于处理事件,并提供了异常处理机制以确保参数的有效性。


channel(NioServerSocketChannel.class)

这段代码是一个泛型方法,用于设置用于创建Channel实例的Class对象。

/*** The {@link Class} which is used to create {@link Channel} instances from.* You either use this or {@link #channelFactory(io.netty.channel.ChannelFactory)} if your* {@link Channel} implementation has no no-args constructor.*/
public B channel(Class<? extends C> channelClass) {// 检查传入的channelClass是否为空,如果为空则抛出NullPointerExceptionif (channelClass == null) {throw new NullPointerException("channelClass");}// 调用channelFactory方法,传入一个ReflectiveChannelFactory实例,该实例用于通过反射创建Channel实例return channelFactory(new ReflectiveChannelFactory<C>(channelClass));
}

这个方法主要用于设置用于创建Channel实例的Class对象。它接受一个Class对象作为参数,并将其传递给channelFactory方法。

在这个方法内部,会创建一个ReflectiveChannelFactory实例,并将传入的Class对象作为参数传递给它。

在方法的实现中,

  • 首先检查传入的channelClass是否为空,如果为空则抛出NullPointerException。
  • 然后,创建一个ReflectiveChannelFactory实例,并将传入的Class对象作为参数传递给它。
  • 最后,调用channelFactory方法,将ReflectiveChannelFactory实例传递给它,并返回调用该方法的实例,以支持链式调用。

总的来说,这段代码的作用是为Netty的Bootstrap或ServerBootstrap设置用于创建Channel实例的Class对象,并提供了异常处理机制以确保参数的有效性。


new ReflectiveChannelFactory<C>(channelClass)

这段代码是ReflectiveChannelFactory类的构造函数实现。它接受一个Class对象作为参数,并使用反射机制获取该类的公共无参数构造方法。让我们逐步解释它:

public ReflectiveChannelFactory(Class<? extends T> clazz) {// 检查传入的clazz是否为空,如果为空则抛出NullPointerExceptionObjectUtil.checkNotNull(clazz, "clazz");try {// 使用反射获取传入的类的公共无参数构造方法this.constructor = clazz.getConstructor();} catch (NoSuchMethodException e) {// 如果获取构造方法失败,则抛出IllegalArgumentException异常throw new IllegalArgumentException("Class " + StringUtil.simpleClassName(clazz) +" does not have a public non-arg constructor", e);}
}

这个构造函数的作用是初始化ReflectiveChannelFactory实例。

它接受一个Class对象作为参数,该Class对象表示要实例化的Channel类。在构造函数内部,

  • 首先检查传入的Class对象是否为空,如果为空则抛出NullPointerException。
  • 然后,使用反射机制尝试获取传入类的公共无参数构造方法。如果获取构造方法失败,则抛出IllegalArgumentException异常,指示传入的类没有公共无参数构造方法。

总的来说,这段代码的作用是为ReflectiveChannelFactory类创建一个实例,并在构造函数中使用反射机制获取要实例化的Channel类的构造方法。

在这里插入图片描述

@Override
public T newChannel() {try {// 使用之前获取的构造方法实例化新的Channel对象return constructor.newInstance();} catch (Throwable t) {// 如果实例化过程中出现异常,则抛出ChannelException异常throw new ChannelException("Unable to create Channel from class " + constructor.getDeclaringClass(), t);}
}

/*** @deprecated Use {@link #channelFactory(io.netty.channel.ChannelFactory)} instead.*/
@Deprecated
public B channelFactory(ChannelFactory<? extends C> channelFactory) {// 检查传入的channelFactory是否为空,如果为空则抛出NullPointerExceptionif (channelFactory == null) {throw new NullPointerException("channelFactory");}// 检查是否已经设置了channelFactory,如果已经设置了则抛出IllegalStateExceptionif (this.channelFactory != null) {throw new IllegalStateException("channelFactory set already");}// 将传入的channelFactory赋值给成员变量channelFactorythis.channelFactory = channelFactory;return self();
}

在这里插入图片描述


option(ChannelOption.SO_BACKLOG, 1024)

这段代码定义了一个方法,用于为创建的Channel实例设置ChannelOption。

/*** Allow to specify a {@link ChannelOption} which is used for the {@link Channel} instances once they got* created. Use a value of {@code null} to remove a previous set {@link ChannelOption}.*/
public <T> B option(ChannelOption<T> option, T value) {// 检查传入的option是否为空,如果为空则抛出NullPointerExceptionif (option == null) {throw new NullPointerException("option");}// 如果value为空,则从options中移除之前设置的optionif (value == null) {synchronized (options) {options.remove(option);}} else {// 否则,将option和对应的value放入options中synchronized (options) {options.put(option, value);}}// 返回调用该方法的实例,以支持链式调用return self();
}

这个方法的作用是允许指定一个ChannelOption,该选项在创建Channel实例后使用。如果value为null,则表示要移除之前设置的ChannelOption。否则,将option和对应的value放入options中。

在方法的实现中,

  • 首先检查传入的option是否为空,如果为空则抛出NullPointerException。
  • 然后,如果value为null,则从options中移除之前设置的option;否则,将option和对应的value放入options中。
  • 最后,返回调用该方法的实例,以支持链式调用。

这个方法的灵活性在于它允许用户根据需要设置或删除特定的ChannelOption,以满足不同场景的需求。

在这里插入图片描述


childHandler()

这段代码定义了一个方法,用于设置用于处理连接到ServerBootstrap的每个子Channel的ChannelHandler。

/*** Set the {@link ChannelHandler} which is used to serve the request for the {@link Channel}'s.*/
public ServerBootstrap childHandler(ChannelHandler childHandler) {// 检查传入的childHandler是否为空,如果为空则抛出NullPointerExceptionif (childHandler == null) {throw new NullPointerException("childHandler");}// 将传入的childHandler赋值给成员变量childHandlerthis.childHandler = childHandler;// 返回ServerBootstrap实例,以支持链式调用return this;
}

这个方法的作用是设置用于处理连接到ServerBootstrap的每个子Channel的ChannelHandler。传入的ChannelHandler将会被添加到每个新创建的子Channel的ChannelPipeline中,用于处理该子Channel的所有事件。

在方法的实现中,

  • 首先检查传入的childHandler是否为空,如果为空则抛出NullPointerException。
  • 然后,将传入的childHandler赋值给成员变量childHandler。
  • 最后,返回ServerBootstrap实例,以支持链式调用。

这种设计模式允许用户通过链式调用一系列方法来配置ServerBootstrap的参数,从而更加简洁和灵活地构建Netty服务器。


小结

ServerBootstrap是Netty中用于创建服务器端应用程序的引导类。它的设计目的是提供一种简洁、灵活的方式来配置和启动服务器,并处理与客户端的连接。

以下是ServerBootstrap的设计要点总结:

  1. 引导配置链式调用:ServerBootstrap类提供了一系列方法,允许用户通过链式调用来配置服务器的各种参数,如设置EventLoopGroup、Channel类型、Channel选项、ChannelHandler等。这种设计模式使得配置过程更加简洁和灵活。

  2. EventLoopGroup的配置:通过group方法,用户可以设置用于处理服务器端连接和客户端连接的EventLoopGroup。通常,一个用于接受连接的bossGroup和一个用于处理连接请求的workerGroup会被设置。

  3. Channel类型的设置:用户可以通过channel方法设置用于创建Channel实例的类型,例如NioServerSocketChannel.class。这决定了服务器将使用的底层传输协议。

  4. Channel选项的设置:option/childOption方法允许用户为创建的Channel实例设置各种选项,如SO_BACKLOG、TCP_NODELAY等。

  5. ChannelHandler的配置:通过childHandler方法,用户可以设置用于处理连接到服务器的每个子Channel的ChannelHandler。这些ChannelHandler将被添加到每个新创建的子Channel的ChannelPipeline中,用于处理子Channel的所有事件。

  6. 灵活性和可扩展性:ServerBootstrap的设计允许用户根据具体需求灵活地配置服务器的各种参数,同时也提供了可扩展的接口和回调机制,使得用户可以根据需要自定义处理逻辑。

总的来说,ServerBootstrap的设计通过提供一系列简洁而灵活的配置方法,以及可扩展的接口和回调机制,使得用户能够轻松地构建高性能、可定制的服务器应用程序。
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/468170.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

全球夜间灯光(1992-2021 年)更新(1km空间分辨率)

统一的全球夜间灯光&#xff08;1992-2021 年&#xff09; 在这项研究中&#xff0c;作者通过协调来自 DMSP 数据的相互校准的 NTL 观测数据和来自 VIIRS 数据的模拟 DMSP 类 NTL 观测数据&#xff0c;生成了全球尺度的综合一致的 NTL 数据集。生成的全球 DMSP NTL 时间序列数据…

【运维测试】移动测试自动化知识总结第1篇:移动端测试介绍(md文档已分享)

本系列文章md笔记&#xff08;已分享&#xff09;主要讨论移动测试相关知识。主要知识点包括&#xff1a;移动测试分类及android环境搭建&#xff0c;adb常用命令&#xff0c;appium环境搭建及使用&#xff0c;pytest框架学习&#xff0c;PO模式&#xff0c;数据驱动&#xff0…

【十六】【C++】stack的常见用法和练习

stack的常见用法 C标准库中的stack是一种容器适配器&#xff0c;它提供了后进先出&#xff08;Last In First Out, LIFO&#xff09;的数据结构。stack使用一个底层容器进行封装&#xff0c;如deque、vector或list&#xff0c;但只允许从一端&#xff08;顶部&#xff09;进行…

Excel模板2:进度条甘特图

Excel模板2&#xff1a;进度条甘特图 ‍ 今天复刻B站up【名字叫麦兜的狗狗】的甘特图&#xff1a;还在买Excel模板吗&#xff1f;自己做漂亮简洁的甘特图吧&#xff01;_哔哩哔哩_bilibili 阿里网盘永久分享&#xff1a;https://www.alipan.com/s/cXhq1PNJfdm 当前效果&…

幻兽帕鲁Palworld专用服务器CPU内存配置怎么选择?

腾讯云幻兽帕鲁服务器配置怎么选&#xff1f;根据玩家数量选择CPU内存配置&#xff0c;4到8人选择4核16G、10到20人玩家选择8核32G、2到4人选择4核8G、32人选择16核64G配置&#xff0c;腾讯云百科txybk.com来详细说下腾讯云幻兽帕鲁专用服务器CPU内存带宽配置选择方法&#xff…

ClickHouse--04--数据库引擎、Log 系列表引擎、 Special 系列表引擎

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 1.数据库引擎1.1 Ordinary 默认数据库引擎1.2 MySQL 数据库引擎MySQL 引擎语法字段类型的映射 2.ClickHouse 表引擎3.Log 系列表引擎几种 Log 表引擎的共性是&#…

分享87个CSS3特效,总有一款适合您

分享87个CSS3特效&#xff0c;总有一款适合您 87个CSS3特效下载链接&#xff1a;https://pan.baidu.com/s/1CAxe8nPBzXvH7Nr6B_U72Q?pwd8888 提取码&#xff1a;8888 Python采集代码下载链接&#xff1a;采集代码.zip - 蓝奏云 学习知识费力气&#xff0c;收集整理更不…

机械革命混合模式和独显直连互相切换

原文&#xff1a;https://blog.iyatt.com/?p13773 默认状态是混合输出&#xff0c;在任务管理器中可以看到两个 GPU&#xff0c;分别是核显和独显 从混合模式切换到独显直连可以通过机械革命电竞控制台&#xff08;重装过系统的需要去官网下载安装驱动&#xff09; 打开后…

如何流畅进入Github

前言 以下软件是免费的&#xff0c;放心用 一、进入右边的下载链接https://steampp.net/ 二、点击下载 三、点击接受并下载 四、随便选一个下载链接进行下载 五、软件安装好打开后&#xff0c;找到Github 六、点击全部启用 七、再点击左上角的一键加速 八、这个时候你再进Git…

向量搜索查询faiss、annoy

首先介绍annoy : 转发空间&#xff1a;https://download.csdn.net/blog/column/10872374/114665212 Annoy是高维空间求近似最近邻的一个开源库。 Annoy构建一棵二叉树&#xff0c;查询时间为O(logn)。 Annoy通过随机挑选两个点&#xff0c;并使用垂直于这个点的等距离超平面…

Unity下使用Sqlite

sqlite和access类似是文件形式的数据库&#xff0c;不需要安装任何服务&#xff0c;可以存储数据&#xff0c;使用起来还是挺方便的。 首先需要安装DLL 需要的DLL 我们找到下面两个文件放入Plugins目录 Mono.Data.Sqlite.dll System.Data.dll DLL文件位于Unity的安装目录下的…

人工智能ai写作系统,ai智能写作机器人

人工智能AI大数据深度&#xff1a;基于伪原创算法&#xff0c;采用神经网络算法&#xff0c;在超过1535000篇文章中进行自动学习、聚合算法进行人工智能的创建&#xff0c;内容语义不变&#xff0c;媒体阿里、腾讯、百度均于日前在百家号内容创作者盛典上推出人工智能创作支撑平…