Netty Review - ServerBootstrap源码解析

2024-02-13 10:04
文章标签 源码 解析 netty review serverbootstrap

本文主要是介绍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的设计通过提供一系列简洁而灵活的配置方法，以及可扩展的接口和回调机制，使得用户能够轻松地构建高性能、可定制的服务器应用程序。
在这里插入图片描述

这篇关于Netty Review - ServerBootstrap源码解析的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/705217。

相关文章

Java 正则表达式URL 匹配与源码全解析

Java 正则表达式URL 匹配与源码全解析

《Java正则表达式URL匹配与源码全解析》在Web应用开发中,我们经常需要对URL进行格式验证,今天我们结合Java的Pattern和Matcher类,深入理解正则表达式在实际应用中... 目录1.正则表达式分解：2. 添加域名匹配 (2)3. 添加路径和查询参数匹配 (3) 4. 最终优化版本5.设计思
阅读更多...
使用Java将DOCX文档解析为Markdown文档的代码实现

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown（MD）因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析
阅读更多...
Java字符串处理全解析(String、StringBuilder与StringBuffer)

Java字符串处理全解析(String、StringBuilder与StringBuffer)

《Java字符串处理全解析(String、StringBuilder与StringBuffer)》：本文主要介绍Java字符串处理全解析(String、StringBuilder与StringBu... 目录Java字符串处理全解析：String、StringBuilder与StringBuffer一、St
阅读更多...
Spring Boot循环依赖原理、解决方案与最佳实践(全解析)

Spring Boot循环依赖原理、解决方案与最佳实践(全解析)

《SpringBoot循环依赖原理、解决方案与最佳实践(全解析)》循环依赖指两个或多个Bean相互直接或间接引用,形成闭环依赖关系,：本文主要介绍SpringBoot循环依赖原理、解决方案与最... 目录一、循环依赖的本质与危害1.1 什么是循环依赖？1.2 核心危害二、Spring的三级缓存机制2.1 三
阅读更多...
C#中async await异步关键字用法和异步的底层原理全解析

C#中async await异步关键字用法和异步的底层原理全解析

《C#中asyncawait异步关键字用法和异步的底层原理全解析》：本文主要介绍C#中asyncawait异步关键字用法和异步的底层原理全解析,本文给大家介绍的非常详细,对大家的学习或工作具有一... 目录C#异步编程一、异步编程基础二、异步方法的工作原理三、代码示例四、编译后的底层实现五、总结C#异步编程
阅读更多...
MySQL中FIND_IN_SET函数与INSTR函数用法解析

MySQL中FIND_IN_SET函数与INSTR函数用法解析

《MySQL中FIND_IN_SET函数与INSTR函数用法解析》：本文主要介绍MySQL中FIND_IN_SET函数与INSTR函数用法解析,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一... 目录一、功能定义与语法1、FIND_IN_SET函数2、INSTR函数二、本质区别对比三、实际场景案例分
阅读更多...
Java图片压缩三种高效压缩方案详细解析

Java图片压缩三种高效压缩方案详细解析

《Java图片压缩三种高效压缩方案详细解析》图片压缩通常涉及减少图片的尺寸缩放、调整图片的质量(针对JPEG、PNG等)、使用特定的算法来减少图片的数据量等,：本文主要介绍Java图片压缩三种高效... 目录一、基于OpenCV的智能尺寸压缩技术亮点：适用场景：二、JPEG质量参数压缩关键技术：压缩效果对比
阅读更多...
Java调用C++动态库超详细步骤讲解(附源码)

Java调用C++动态库超详细步骤讲解(附源码)

《Java调用C++动态库超详细步骤讲解(附源码)》C语言因其高效和接近硬件的特性,时常会被用在性能要求较高或者需要直接操作硬件的场合,：本文主要介绍Java调用C++动态库的相关资料,文中通过代... 目录一、直接调用C++库第一步：动态库生成（vs2017+qt5.12.10）第二步：Java调用C++
阅读更多...
关于WebSocket协议状态码解析

关于WebSocket协议状态码解析

《关于WebSocket协议状态码解析》：本文主要介绍关于WebSocket协议状态码的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录WebSocket协议状态码解析1. 引言2. WebSocket协议状态码概述3. WebSocket协议状态码详解3
阅读更多...
CSS Padding 和 Margin 区别全解析

CSS Padding 和 Margin 区别全解析

《CSSPadding和Margin区别全解析》CSS中的padding和margin是两个非常基础且重要的属性，它们用于控制元素周围的空白区域，本文将详细介绍padding和... 目录css Padding 和 Margin 全解析1. Padding: 内边距2. Margin: 外边距3. Padd
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2