Netty基本使用(一)

水深无声 2022-11-17 14:47 271阅读 0赞

# Netty基本使用(一) #

## 1. 概述 ##

### Netty是什么 ###

Netty 是一个`异步的`、基于`事件驱动`的网络应用框架，用于快速开发可维护、高性能的网络服务器和客户端, 引用官网的自述:

> Netty is a NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients.

简单的说, Netty就是一个 `网络框架` ,可以用来开发`服务器`或者`客户端`,并且netty与普通的我们理解的`tomcat`,`springBoot`,`OKHttp`等不一样的地方在于,**它并不局限于HTTP协议**,他是基于socket的, 所以当我们有需要使用自定义应用层协议的开发需求的时候, 用netty就很合适了,比如*分布式*,*长连接*什么的, 当然我们也可以基于Netty开发Http的服务器和客户端

### Netty的优势 ###

Netty这个框架的好处,总结起来有以下几点

1.  API设计的较为合理切易用
2.  基于NIO进行构建, 所以在高并发环境下表现优异
3.  提供了一些工具类,对JDK原有API进行了一定程度的增强

## 2. HelloWorld ##

首先先写一个包含了`服务器端`和`客户端`的HelloWord程序:

*  客户端向服务器端发送HelloWorld
 *  服务器仅接收

### 添加依赖 ###

与其他的Java库一样, Netty可以通过Jar,Maven,Gradle等等的形式添加到项目中,值得注意的是, Netty是一个*单依赖*的框架, 没有乱七八糟的复杂依赖关系, 仅仅一个Jar就可以解决

如果使用Jar的话,可以从官网:[https://netty.io/][https_netty.io]进行下载:

#### Jar ####

如果想下载Jar的话, 可以直接点击如图的链接进行下载:  
![0c6fc1ba160035955fdcc92607ddff46.png][]

> 注意:  
> Netty之前发布过Netty5的版本, 不过目前已经废弃了, 所以目前的大版本是是Nett4, 如果在其他地方使用的话, 不要搞错了

#### maven ####

也可以进入Downloads页面, 里面有Maven的添加方式:  
![61aee110724d7a1bb3c9d077cdc1122d.png][]

<dependency\>
     <groupId\>io.netty</groupId\>
     <artifactId\>netty-all</artifactId\>
     <version\>4.1.63.Final</version\>
    </dependency\>

### 代码 ###

先上代码,看一下效果:

> 注意: 以下代码中的所有引包, 均需要引用netty下的, 不要引用jdk里面的,比如Channel什么的

#### Server端 ####

new ServerBootstrap()  
            .group(new NioEventLoopGroup())  
            .channel(NioServerSocketChannel.class)  
            .childHandler(new ChannelInitializer<NioSocketChannel>() {
          
                protected void initChannel(NioSocketChannel ch) {
          
                    ch.pipeline().addLast(new StringDecoder());  
                    ch.pipeline().addLast(new SimpleChannelInboundHandler<String>() {
          
                        @Override  
                        protected void channelRead0(ChannelHandlerContext ctx, String msg) {
          
                            System.out.println(msg);  
                        }  
                    });  
                }  
            })  
            .bind(8080);

#### Client端 ####

new Bootstrap()  
            .group(new NioEventLoopGroup())  
            .channel(NioSocketChannel.class)  
            .handler(new ChannelInitializer<>() {
          
                @Override  
                protected void initChannel(Channel ch) {
          
                    ch.pipeline().addLast(new StringEncoder());  
                }  
            })  
            .connect("127.0.0.1", 8080)  
            .sync()  
            .channel()  
            .writeAndFlush("hello Chenfy!");

运行效果:  
Server端可以收到Client端发送的hello Chenfy:  
![3eab6a7f971d952beed507c72d953dd9.png][]

### 简单说明 ###

#### 服务端代码 ####

1.  ServerBootstrap: 服务端的启动器, 配置参数并启动服务器的
2.  group: 创建 NioEventLoopGroup，可以简单理解为 线程池([线程池详解][Link 1]) + Selector
3.  chanel: 选择Socket实现类,其中`NioServerSocketChannel`表示基于NIO的服务器端实现,其他的实现还有:
    
     *  EpollServerSocketChannel
     *  KQueueServerSocketChanel
     *  NioServerSocketChannel
    
    如图所示:  
    ![cf5467e4535a1cc2f765bd6d32428433.png][]
4.  childHandler: 之所以叫**child**,是因为这个方法添加的Handler都是个SocketChannel用的, 而不是给ServerSocketChannel用, 就是说这些Handler都是处理数据使用的. ChannelInitializer 处理器（仅执行一次），它的作用是待客户端 SocketChannel 建立连接后，执行 initChannel 以便添加更多的处理器
5.  bind: 确定Server绑定的端口号
6.  addLast: 向pipeline(流水线)的末尾添加一个Handler,用来处理数据
    
    1.  StringDecoder: SocketChannel 的处理器，解码 ByteBuf => String
    2.  SimpleChannelInboundHandler: SocketChannel 的业务处理器，使用上一个处理器的处理结果,接受的msg就是StringDecoder处理后的String

#### 客户端代码 ####

1.  Bootstrap: 客户端的启动器
2.  group: 与服务的类似, 只不过创建的group没有`Server`,创建的是客户端Group
3.  channel: 客户端的Socket实现类, 与Server端类似, 也有多个实现类
4.  handler: 与服务端同样的作用
5.  connect: 指定要连接的服务器和端口
6.  sync: Netty 中很多方法都是异步的，如 connect，这时需要使用 sync 方法等待 connect 建立连接完毕
7.  channel: 获取 channel 对象，它即为通道抽象，可以进行数据读写操作
8.  writeAndFlush: 写入消息并清空缓冲区, 这里写入的是String类型, 它会经由添加的`StringEncoder`有String编码成ByteBuf然后发出

### 概念梳理 ###

*  channel 理解为数据的通道
 *  msg 理解为流动的数据，最开始输入是 ByteBuf，但经过 pipeline 的加工，会变成其它类型对象，最后输出又变成 ByteBuf
 *  handler 理解为数据的处理工序
    
     *  工序有多道，合在一起就是 pipeline，pipeline 负责发布事件（读、读取完成…）传播给每个 handler， handler 对自己感兴趣的事件进行处理（重写了相应事件处理方法）
     *  handler 分 Inbound 和 Outbound 两类
 *  eventLoop 理解为处理数据的工人
    
     *  工人可以管理多个 channel 的 io 操作，并且一旦工人负责了某个 channel，就要负责到底（绑定）
     *  工人既可以执行 io 操作，也可以进行任务处理，每位工人有任务队列，队列里可以堆放多个 channel 的待处理任务，任务分为普通任务、定时任务
     *  工人按照 pipeline 顺序，依次按照 handler 的规划（代码）处理数据，可以为每道工序指定不同的工人

[https_netty.io]: https://netty.io/
[0c6fc1ba160035955fdcc92607ddff46.png]: /images/20221022/842f5344e0dd4a64aaff308d3c59d84c.png
[61aee110724d7a1bb3c9d077cdc1122d.png]: /images/20221022/92a5e7575a6b470fac720ae30a21147e.png
[3eab6a7f971d952beed507c72d953dd9.png]: /images/20221022/75390a2a53894581a8201817addfe4a1.png
[Link 1]: https://blog.csdn.net/cfy137000/article/details/51422316?
[cf5467e4535a1cc2f765bd6d32428433.png]: /images/20221022/04ea2d3c96e849d498f5987b1b33674e.png