netty

一、Netty介绍和应用场景

1、本课程学习要求

1)、本课程不适用于 0 基础的学员

2)、要求已经掌握了 Java 编程, 主要技术构成: Java OOP 编程、 Java 多线程编程、 Java IO 编程 、 Java 网

​ 络编程、 常用的 Java 设计模式(比如 观察者模式 , 命令模式, 职责链模式 )、 常用的数据结构(比如 链表)

3)、本课程的 <<Netty 核心源码剖析章节>> 要求学员最好有项目开发和阅读源码的经历

2、Netty 的介绍

1)、Netty 是由 JBOSS 提供的一个 Java 开源框架, 现为 Github 上的独立项目

  1. 、Netty 是一个异步的、 基于事件驱动的网络应用框架, 用以快速开发高性能、 高可靠性的网络 IO 程序

3)、Netty 主要针对在 TCP 协议下, 面向 Clients 端的高并发应用, 或者 Peer-to-Peer 场景下的大量数据持续传

​ 输的应用

4)、Netty 本质是一个 NIO 框架, 适用于服务器通讯相关的多种应用场景

在这里插入图片描述

5)、要透彻理解 Netty ,需要先学习 NIO ,这样我们才能阅读 Netty 的源码

二、Java BIO 编程

1、I/O 模型

①、I/O 模型基本说明

​ 1)、I/O 模型简单的理解: 就是用什么样的通道进行数据的发送和接收, 很大程度上决定了程序通信的性能

​ 2)、Java 共支持 3 种网络编程模型/IO 模式: BIO、 NIO、 AIO

​ 3)、Java BIO : 同步并阻塞(传统阻塞型), 服务器实现模式为一个连接一个线程, 即客户端有连接请求时服务

​ 器端就需要启动一个线程进行处理, 如果这个连接不做任何事情会造成不必要的线程开销 【简单示意图】

在这里插入图片描述

​ 4)、Java NIO : 同步非阻塞, 服务器实现模式为一个线程处理多个请求(连接), 即客户端发送的连接请求都会

​ 注册到多路复用器上, 多路复用器轮询到连接有 I/O 请求就进行处理 【简单示意图】

在这里插入图片描述

​ 5)、Java AIO(NIO.2) : 异步非阻塞, AIO 引入异步通道的概念, 采用了 Proactor 模式, 简化了程序编写, 有

​ 效的请求才启动线程, 它的特点是先由操作系统完成后才通知服务端程序启动线程去处理, 一般适用于连

​ 接数较多且连接时间较长的应用

2、BIO/NIO/AIO适用场景分析

1)、BIO 方式适用于连接数目比较小且固定的架构, 这种方式对服务器资源要求比较高, 并发局限于应用中,

​ JDK1.4以前的唯一选择, 但程序简单易理解。

2)、NIO 方式适用于连接数目多且连接比较短(轻操作)的架构,比如聊天服务器,弹幕系统,服务器间通讯等。

​ 编程比较复杂, JDK1.4 开始支持。

3)、AIO 方式使用于连接数目多且连接比较长(重操作) 的架构, 比如相册服务器, 充分调用 OS 参与并发操

​ 作,编程比较复杂, JDK7 开始支持

3、Java BIO 基本介绍

1)、Java BIO 就是传统的 java io 编程, 其相关的类和接口在 java.io

2)、BIO(blocking I/O) : 同步阻塞, 服务器实现模式为一个连接一个线程, 即客户端有连接请求时服务器端就需

​ 要启动一个线程进行处理, 如果这个连接不做任何事情会造成不必要的线程开销, 可以通过线程池机制改善

​ (实现多个客户连接服务器)。 【后有应用实例】

3)、BIO 方式适用于连接数目比较小且固定的架构, 这种方式对服务器资源要求比较高, 并发局限于应用中,

​ JDK1.4以前的唯一选择, 程序简单易理解

4、Java BIO 工作机制

在这里插入图片描述

对 BIO 编程流程的梳理

​ 1)、服务器端启动一个 ServerSocket

​ 2)、客户端启动 Socket 对服务器进行通信, 默认情况下服务器端需要对每个客户 建立一个线程与之通讯

​ 3)、客户端发出请求后, 先咨询服务器是否有线程响应, 如果没有则会等待, 或者被拒绝

​ 4)、如果有响应, 客户端线程会等待请求结束后, 再继续执行

5、Java BIO 应用实例

实例说明:

​ 1)、使用 BIO 模型编写一个服务器端, 监听 6666 端口, 当有客户端连接时, 就启动一个线程与之通讯

​ 2)、要求使用线程池机制改善, 可以连接多个客户端

​ 3)、服务器端可以接收客户端发送的数据(telnet 方式即可)

​ ■ 将 cmd 命令窗口调出来,输入 telnet 127.0.0.1 6666

​ ■ 发送数据:send 数据

​ ■ 若数据发送不了,可以按 ctrl + ] 进行发送

在这里插入图片描述

​ 4)、代码演示

package com.pengtxyl.netty.bio;

import java.io.IOException;
import java.io.InputStream;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

public class BIOServer {

    public static void main(String[] args) throws IOException {
        //线程池机制

        //思路
        //1.创建一个线程池
        //2.如果有客户端连接,就创建一个线程,与之通讯(单独写一个方法)

        ExecutorService newCachedThreadPool = Executors.newCachedThreadPool();

        //创建 ServerSocket
        ServerSocket serverSocket = new ServerSocket(6666);

        System.out.println("服务器启动了");

        while(true){

            System.out.println("线程信息 id = " + Thread.currentThread().getId() +
                    "名字 = " + Thread.currentThread().getName());
            
            //监听,等待客户端连接
            System.out.println("等待连接");
            final Socket socket = serverSocket.accept(); //这个方法是一个阻塞式的方法,没有客户端连接过来时会一直阻塞
            System.out.println("连接到一个客户端");

            //创建一个线程,与之通讯(单独写一个方法)
            newCachedThreadPool.execute(new Runnable() {
                @Override
                public void run() { //我们重写
                    //可以和客户端通信
                    handler(socket);
                }
            });
        }
    }

    //编写一个handler方法,和客户端通讯
    public static void handler(Socket socket){
        try {
            System.out.println("线程信息 id = " + Thread.currentThread().getId() +
                    "名字 = " + Thread.currentThread().getName());
            byte[] bytes = new byte[1024];
            //通过Socket 获取输入流
            InputStream inputStream = socket.getInputStream();

            //循环地获取客户端发送的数据
            while(true){
                System.out.println("线程信息 id = " + Thread.currentThread().getId() +
                        "名字 = " + Thread.currentThread().getName());

                System.out.println("read......");
                int read = inputStream.read(bytes); //这个方法也是一个阻塞方法,没有数据传入时会一直等待
                if(read != -1){
                    //输出客户端发送的数据
                    System.out.println(new String(bytes, 0, read));
                } else {
                    break;
                }
            }
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            System.out.println("关闭和client的连接");
            try {
                socket.close();
            } catch (Exception e){
                e.printStackTrace();
            }
        }
    }

}

6、Java BIO 问题分析

1)、每个请求都需要创建独立的线程, 与对应的客户端进行数据 Read, 业务处理, 数据 Write

2)、当并发数较大时, 需要创建大量线程来处理连接, 系统资源占用较大

3)、连接建立后, 如果当前线程暂时没有数据可读, 则线程就阻塞在 Read 操作上, 造成线程资源浪费

三、Java NIO 编程

1、Java NIO 基本介绍

1)、Java NIO 全称 java non-blocking IO, 是指 JDK 提供的新 API。 从 JDK1.4 开始, Java 提供了一系列改进的

​ 输入/输出的新特性, 被统称为 NIO(即 New IO), 是同步非阻塞的

2)、NIO 相关类都被放在 java.nio 包及子包下, 并且对原 java.io 包中的很多类进行改写。 【基本案例】

3)、NIO 有三大核心部分: Channel(通道), Buffer(缓冲区), Selector(选择器)

4)、NIO 是 面向缓冲区 , 或者面向 块 编程的。 数据读取到一个它稍后处理的缓冲区, 需要时可在缓冲区中前后

​ 移动, 这就增加了处理过程中的灵活性, 使用它可以提供非阻塞式的高伸缩性网络

5)、Java NIO 的非阻塞模式, 使一个线程从某通道发送请求或者读取数据, 但是它仅能得到目前可用的数据, 如

​ 果目前没有数据可用时, 就什么都不会获取, 而不是保持线程阻塞, 所以直至数据变的可以读取之前, 该

​ 线程可以继续做其他的事情。 非阻塞写也是如此, 一个线程请求写入一些数据到某通道, 但不需要等待它完

​ 全写入,这个线程同时可以去做别的事情。 【后面有案例说明】

6)、通俗理解: NIO 是可以做到用一个线程来处理多个操作的。 假设有 10000 个请求过来,根据实际情况, 可以

​ 分配50 或者 100 个线程来处理。 不像之前的阻塞 IO 那样, 非得分配 10000 个。

7)、HTTP2.0 使用了多路复用的技术, 做到同一个连接并发处理多个请求, 而且并发请求的数量比 HTTP1.1 大了

​ 好几个数量级

8)、案例说明 NIO 的 Buffer

package com.pengtxyl.netty.nio;

import java.nio.IntBuffer;

public class BasicBuffer {

    public static void main(String[] args) {

        //举例说明Buffer 的使用(简单说明)
        //创建一个 Buffer,大小为5,即可以存放5个int
        IntBuffer intBuffer = IntBuffer.allocate(5);

        //向 Buffer 存放数据
//        intBuffer.put(10);
//        intBuffer.put(11);
//        intBuffer.put(12);
//        intBuffer.put(13);
//        intBuffer.put(14);

        for(int i = 0 ; i < intBuffer.capacity() ; i++){
            intBuffer.put(i * 2);
        }

        //如何从 Buffer 读取数据
        //将 Buffer 转换,读写切换
        intBuffer.flip();

        while(intBuffer.hasRemaining()){
            System.out.println(intBuffer.get());
        }
    }

}

2、NIO 和 BIO 的比较

1)、BIO 以流的方式处理数据,而 NIO 以块的方式处理数据,块 I/O 的效率比流 I/O 高很多

2)、BIO 是阻塞的, NIO 则是非阻塞的

3)、BIO 基于字节流和字符流进行操作, 而 NIO 基于 Channel(通道)和 Buffer(缓冲区)进行操作, 数据总是从通

​ 道读取到缓冲区中, 或者从缓冲区写入到通道中。 Selector(选择器)用于监听多个通道的事件(比如: 连接

​ 请求,数据到达等) , 因此使用单个线程就可以监听多个客户端通道

3、NIO 三大核心原理示意图

​ 一张图描述 NIO 的 Selector 、 Channel 和 Buffer 的关系

Selector 、 Channel 和 Buffer 的关系图(简单版)

在这里插入图片描述

​ 关系图的说明:

​ 1)、每个 channel 都会对应一个 Buffer

​ 2)、Selector 对应一个线程, 一个线程对应多个 channel(连接)

​ 3)、该图反应了有三个 channel 注册到 该 selector //程序

​ 4)、程序切换到哪个 channel 是有事件决定的, Event 就是一个重要的概念

​ 5)、Selector 会根据不同的事件, 在各个通道上切换

​ 6)、Buffer 就是一个内存块 , 底层是有一个数组

​ 7)、数据的读取写入是通过 Buffer, 这个和 BIO , BIO 中要么是输入流,或者是输出流,不能双向,但是 NIO 的

​ Buffer 是可以读也可以写, 需要 flip 方法切换

​ 8)、channel 是双向的, 可以返回底层操作系统的情况, 比如 Linux 底层的操作系统通道就是双向的

4、缓冲区(Buffer)

①、基本介绍

​ 缓冲区(Buffer):缓冲区本质上是一个可以读写数据的内存块,可以理解成是一个容器对象(含数组),该对象提

​ 供了一组方法,可以更轻松地使用内存块,缓冲区对象内置了一些机制, 能够跟踪和记录缓冲区的状态变化情

​ 况。 Channel 提供从文件、 网络读取数据的渠道, 但是读取或写入的数据都必须经由 Buffer, 如图: 【后面举

​ 例说明】

在这里插入图片描述

②、Buffer 类及其子类

​ 1)、在 NIO 中,Buffer 是一个顶层父类,它是一个抽象类,类的层级关系图

在这里插入图片描述

​ 2)、Buffer 类定义了所有的缓冲区都具有的四个属性来提供关于其所包含的数据元素的信息

在这里插入图片描述

​ 3)、Buffer 类相关方法一览

在这里插入图片描述

③、ByteBuffer

​ 从前面可以看出对于 Java 中的基本数据类型(boolean 除外), 都有一个 Buffer 类型与之相对应, 最常用的自

​ 然是 ByteBuffer 类(二进制数据) , 该类的主要方法如下:

在这里插入图片描述

5、通道(Channel)

①、基本介绍

​ 1)、NIO 的通道类似于流, 但有些区别如下:

​ ■ 通道可以同时进行读写, 而流只能读或者只能写

​ ■ 通道可以实现异步读写数据

​ ■ 通道可以从缓冲读数据, 也可以写数据到缓冲

​ 2)、BIO 中的 stream 是单向的, 例如 FileInputStream 对象只能进行读取数据的操作, 而 NIO 中的通道

​ (Channel)是双向的, 可以读操作, 也可以写操作

​ 3)、Channel 在 NIO 中是一个接口

​ public interface Channel extends Closeable{}

​ 4)、常用的Channel类有:FileChannel、DatagramChannel、ServerSocketChannel 和 SocketChannel

​ 【ServerSocketChanne 类似 ServerSocket , SocketChannel 类似 Socket】

​ 5)、FileChannel 用于文件的数据读写, DatagramChannel 用于 UDP 的数据读写, ServerSocketChannel 和

​ SocketChannel 用于 TCP 的数据读写。

​ 6)、图示

在这里插入图片描述

②、FileChannel 类

​ FileChannel 主要用来对本地文件进行 IO 操作, 常见的方法有

​ ■ public int read(ByteBuffer dst) , 从通道读取数据并放到缓冲区中

​ ■ public int write(ByteBuffer src) , 把缓冲区的数据写到通道中

​ ■ public long transferFrom(ReadableByteChannel src, long position, long count), 从目标通道中复制数

​ 据到当前通道

​ ■ public long transferTo(long position, long count, WritableByteChannel target), 把数据从当前通道复制

​ 给目标通道

③、应用实例 1-本地文件写数据

​ 1)、使用前面学习后的 ByteBuffer(缓冲) 和 FileChannel(通道), 将 “hello,尚硅谷” 写入到 file01.txt 中

​ 2)、文件不存在就创建

​ 3)、代码演示

package com.pengtxyl.netty.nio;

import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;

public class NIOFileChannel01 {

    public static void main(String[] args) throws Exception {
        String str = "hello, 中国";
        //创建一个输出流 -> channel
        FileOutputStream fileOutputStream = new FileOutputStream("file01.txt");

        //通过 fileOutputStream 获取对应的 FileChannel
        //这个 fileChannel 真实类型是 FileChannelImpl
        FileChannel fileChannel = fileOutputStream.getChannel();

        //创建一个缓冲区 ByteBuffer
        ByteBuffer byteBuffer = ByteBuffer.allocate(1024);

        //将 str 放入 byteBuffer
        byteBuffer.put(str.getBytes());
        //对 byteBuffer 进行 flip
        byteBuffer.flip();

        //将 byteBuffer 输入写入到 fileChannel
        fileChannel.write(byteBuffer);
        fileOutputStream.close();
    }

}

④、应用实例2 - 本地文件读数据

​ 实例要求:

​ 1)、使用前面学习后的 ByteBuffer(缓冲) 和 FileChannel(通道), 将 file01.txt 中的数据读入到程序, 并显示在

​ 控制台屏幕

​ 2)、假定文件已经存在

​ 3)、代码演示

package com.pengtxyl.netty.nio;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;

public class NIOFileChannel02 {

    public static void main(String[] args) throws Exception {
        //创建文件的输入流
        File file = new File("file01.txt");
        FileInputStream fileInputStream = new FileInputStream(file);

        //通过 fileInputStream 获取对应的 FileChannel -> 实际类型 FileChannelImpl
        FileChannel fileChannel = fileInputStream.getChannel();

        //创建缓冲区
        ByteBuffer byteBuffer = ByteBuffer.allocate((int) file.length());
        
        //将通道的数据读入到 Buffer
        fileChannel.read(byteBuffer);

        //将byteBuffer的字节数据转成 String
        System.out.println(new String(byteBuffer.array()));
        fileInputStream.close();
    }

}

⑤、应用实例3 - 使用一个 Buffer 完成文件读取、写入

​ 实例要求:

​ 1)、使用 FileChannel(通道) 和 方法 read , write, 完成文件的拷贝

​ 2)、拷贝一个文本文件 1.txt , 放在项目下即可

​ 3)、代码演示

在这里插入图片描述

package com.pengtxyl.netty.nio;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;

public class NIOFileChannel03 {

    public static void main(String[] args) throws Exception {
        FileInputStream fileInputStream = new FileInputStream("file01.txt");
        FileChannel fileChannel01 = fileInputStream.getChannel();

        FileOutputStream fileOutputStream = new FileOutputStream("file02.txt");
        FileChannel fileChannel02 = fileOutputStream.getChannel();

        ByteBuffer byteBuffer = ByteBuffer.allocate(512);

        while(true){    //循环读取
            //这里有一个重要的操作,一定不要忘了
            /*
                public final Buffer clear() {
                    position = 0;
                    limit = capacity;
                    mark = -1;
                    return this;
                }
            * */
            //如果不加 byteBuffer.clear(); 那么 byteBuffer 将会一直读取 file01.txt 中的内容
            //因为在 flip() 方法后最终 byteBuffer 的 position 会等于 limit
            /*
            	具体原因是这样的,因为 file01.txt 文件中的内容长度是 40,第一次读取的时候,因为缓存区的长度是 512,所以就会把所有的数据读取出来,这时候,下面打印的 read = 40,而且此时position=40,因为已经读到了最后的位置,且limit=512,capacity=512。然后执行 flip 的操作,flip 操作后,position=0,limit=40,即limit的值会等于内容的长度。然后执行完write()方法后,position也会等于40,因为将内容全部写到另外一个文件了。那么第二次循环的时候,如果不加clear()方法,就会存在 position=limit 都等于40,那么 read就会等于0,一直这样循环下去,导致程序不能退出,所有加上 clear() 方法后就能解决问题
            */
            byteBuffer.clear();
            int read = fileChannel01.read(byteBuffer); 
            System.out.println("read = " + read); 
            if(read == -1){ //表示读完
                break;
            }
            //将 buffer 中的数据写入到 fileChannel02
            byteBuffer.flip();
            fileChannel02.write(byteBuffer);
        }
    }

}

⑥、应用实例 4-拷贝文件 transferFrom 方法

​ 实例要求

​ 1)、使用 FileChannel(通道) 和 方法 transferFrom , 完成文件的拷贝

​ 3)、拷贝一张图片

​ 4)、代码演示

package com.pengtxyl.netty.nio;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.nio.channels.FileChannel;

public class NIOFileChannel04 {

    public static void main(String[] args) throws Exception {
        //创建相关流
        FileInputStream fileInputStream = new FileInputStream("pic01.jpg");
        FileOutputStream fileOutputStream = new FileOutputStream("pic02.jpg");

        //获取各个流对应的 fileChannel
        FileChannel sourceCh = fileInputStream.getChannel();
        FileChannel destCh = fileOutputStream.getChannel();

        //使用 transferForm 完成拷贝
        destCh.transferFrom(sourceCh, 0, sourceCh.size());

        //关闭相关通道和流
        sourceCh.close();
        destCh.close();
        fileInputStream.close();
        fileOutputStream.close();

    }

}

⑦、关于 Buffer 和 Channel 的注意事项和细节

​ 1)、ByteBuffer 支持类型化的 put 和 get, put 放入的是什么数据类型, get 就应该使用相应的数据类型来取

​ 出,否则可能有 BufferUnderflowException 异常。【举例说明】

package com.pengtxyl.netty.nio;

import java.nio.ByteBuffer;

public class NIOByteBufferPutGet{

    public static void main(String[] args) {
        //创建一个 Buffer
        ByteBuffer buffer = ByteBuffer.allocate(64);

        //类型化方式放入数据
        buffer.putInt(100);
        buffer.putLong(9L);
        buffer.putChar('中');
        buffer.putShort((short) 4);

        //取出
        buffer.flip();

        System.out.println();

        System.out.println(buffer.getInt());
        System.out.println(buffer.getLong());
        System.out.println(buffer.getChar());
        System.out.println(buffer.getLong());   //抛出 java.nio.BufferUnderflowException 异常
    }

}

​ 2)、可以将一个普通 Buffer 转成只读 Buffer 【举例说明】

package com.pengtxyl.netty.nio;

import java.nio.ByteBuffer;

public class ReadOnlyBuffer {

    public static void main(String[] args) {
        //创建一个 buffer
        ByteBuffer buffer = ByteBuffer.allocate(64);

        for(int i = 0 ; i < 64 ; i++){
            buffer.put((byte) i);
        }

        //转换为读取模式
        buffer.flip();

        //得到一个只读的 Buffer
        ByteBuffer readOnlyBuffer = buffer.asReadOnlyBuffer();

        //读取
        while(readOnlyBuffer.hasRemaining()){
            System.out.println(readOnlyBuffer.get());
        }

        readOnlyBuffer.put((byte) 100); //抛出 ReadOnlyBufferException 异常

    }

}

​ 3)、NIO 还提供了 MappedByteBuffer, 可以让文件直接在内存(堆外的内存) 中进行修改, 而如何同步到文

​ 件由 NIO 来完成【举例说明】

package com.pengtxyl.netty.nio;

import java.io.FileNotFoundException;
import java.io.RandomAccessFile;
import java.nio.MappedByteBuffer;
import java.nio.channels.FileChannel;

/*
* 说明:MappedByteBuffer 可以让文件直接在内存(堆外内存) 修改,操作系统不需要拷贝一次
* */
public class MappedByteBufferTest {

    public static void main(String[] args) throws Exception {
        RandomAccessFile randomAccessFile = new RandomAccessFile("file01.txt", "rw");
        //获取对应的通道
        FileChannel channel = randomAccessFile.getChannel();

        /*
        * 参数1:FileChannel.MapMode.READ_WRITE 使用的读写模式
        * 参数2: 0 表示可以直接修改的起始位置
        * 参数3:5 是映射到内存的大小(不是索引位置),即 将 file01.txt 的多少个字节映射到内存
        * 表示可以直接修改的范围就是 0 - 5
        * mappedByteBuffer 的实际类型是 DirectByteBuffer
        * */
        MappedByteBuffer mappedByteBuffer = channel.map(FileChannel.MapMode.READ_WRITE, 0, 5);

        mappedByteBuffer.put(0, (byte) 'H');
        mappedByteBuffer.put(3, (byte) '9');
        mappedByteBuffer.put(5, (byte) 'Y');    //会报错, 只能操作 0-5位置的数据,不包含5

        randomAccessFile.close();
    }

}

​ 4)、前面我们讲的读写操作,都是通过一个 Buffer 完成的, NIO 还支持通过多个 Buffer (即 Buffer 数组) 完成

​ 读写操作, 即 Scattering 和 Gathering 【举例说明】

package com.pengtxyl.netty.nio;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.ServerSocketChannel;
import java.nio.channels.SocketChannel;
import java.util.Arrays;

/*
* Scattering: 将数据写入到 Buffer 时, 可以采用 Buffer 数组, 依次写入 [分散]
* Gathering: 从 Buffer 读取数据时, 可以采用 Buffer 数组, 依次读
* */
public class ScatteringAndGatheringTest {

    public static void main(String[] args) throws Exception {
        //使用 ServerSocketChannel 和 SocketChannel 网络
        ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
        InetSocketAddress inetSocketAddress = new InetSocketAddress(7000);

        //绑定端口到 socket, 并启动
        serverSocketChannel.socket().bind(inetSocketAddress);

        //创建 Buffer 数组
        ByteBuffer[] byteBuffers = new ByteBuffer[2];
        byteBuffers[0] = ByteBuffer.allocate(5);
        byteBuffers[1] = ByteBuffer.allocate(3);

        //等客户端连接(telnet)
        SocketChannel socketChannel = serverSocketChannel.accept();
        int messageLength = 8; //假定从客户端接收8个字节
        //循环地读取
        while(true){
            int byteRead = 0;
            while(byteRead < messageLength){
                long l = socketChannel.read(byteBuffers);
                byteRead += l;  //累计读取的字节数
                System.out.println("byteRead = " + byteRead);
                Arrays.asList(byteBuffers).stream().map(buffer -> "postion= " +
                buffer.position() + ", limit= " + buffer.limit()).forEach(System.out::println);
            }

            //将所有的 buffer 进行 flip
            Arrays.asList(byteBuffers).forEach(buffer -> buffer.flip());

            //将数据读出显示到客户端
            long byteWrite = 0;
            while(byteWrite < messageLength){
                long l = socketChannel.write(byteBuffers);
                byteWrite += l;
            }

            //将所有的 buffer 进行 clear
            Arrays.asList(byteBuffers).forEach(buffer -> buffer.clear());

            System.out.println("byteRead= " + byteRead + ", byteWrite= " + byteWrite +
            ", messageLength= " + messageLength);
        }
    }

}

6、Selector(选择器)

①、基本介绍

​ 1)、Java 的 NIO,用非阻塞的 IO 方式。可以用一个线程,处理多个的客户端连接,就会使用到 Selector(选择

​ 器)

​ 2)、Selector 能够检测多个注册的通道上是否有事件发生(注意:多个 Channel 以事件的方式可以注册到同一个

​ Selector), 如果有事件发生, 便获取事件然后针对每个事件进行相应的处理。 这样就可以只用一个单线程

​ 去管理多个通道, 也就是管理多个连接和请求【示意图】

​ 3)、只有在 连接/通道 真正有读写事件发生时, 才会进行读写, 就大大地减少了系统开销, 并且不必为每个连

​ 接都创建一个线程, 不用去维护多个线程

​ 4)、避免了多线程之间的上下文切换导致的开销

②、Selector 示意图和特点说明

在这里插入图片描述

​ 说明如下:

​ 1)、Netty 的 IO 线程 NioEventLoop 聚合了 Selector(选择器, 也叫多路复用器), 可以同时并发处理成百上千

​ 个客户端连接。

​ 2)、当线程从某客户端 Socket 通道进行读写数据时, 若没有数据可用时, 该线程可以进行其他任务。

​ 3)、线程通常将非阻塞 IO 的空闲时间用于在其他通道上执行 IO 操作, 所以单独的线程可以管理多个输入和输

​ 出通道。

​ 4)、由于读写操作都是非阻塞的, 这就可以充分提升 IO 线程的运行效率, 避免由于频繁 I/O 阻塞导致的线程挂

​ 起。

​ 5)、一个 I/O 线程可以并发处理 N 个客户端连接和读写操作, 这从根本上解决了传统同步阻塞 I/O 一连接一线

​ 程模型, 架构的性能、 弹性伸缩能力和可靠性都得到了极大的提升。

③、Selector 类相关方法

​ Selector 类是一个抽象类, 常用方法和说明如下:

在这里插入图片描述

④、注意事项

​ 1)、NIO 中的 ServerSocketChannel 功能类似 ServerSocket, SocketChannel 功能类似 Socket

​ 2)、selector 相关方法说明

​ selector.select()//阻塞

​ selector.select(1000);//阻塞 1000 毫秒, 在 1000 毫秒后返回

​ selector.wakeup();//唤醒 selector

​ selector.selectNow();//不阻塞, 立马返还

7、NIO非阻塞网络编程原理分析图

​ NIO 非阻塞网络编程相关的(Selector、 SelectionKey、 ServerScoketChannel 和 SocketChannel) 关系梳理图

在这里插入图片描述

​ 对上图的说明:

​ 1)、当客户端连接时, 会通过 ServerSocketChannel 得到 SocketChannel

​ 2)、Selector 进行监听 select 方法, 返回有事件发生的通道的个数

​ 3)、将 socketChannel 注册到 Selector 上, register(Selector sel, int ops), 一个 selector 上可以注册多个

​ SocketChannel

​ 4)、注册后返回一个 SelectionKey, 会和该 Selector 关联(集合)

​ 5)、进一步得到各个 SelectionKey (有事件发生)

​ 6)、在通过 SelectionKey 反向获取 SocketChannel , 方法 channel()

​ 7)、可以通过 得到的 channel , 完成业务处理

​ 8)、代码撑腰。 。 。

8、NIO非阻塞 网络编程快速入门

​ 案例要求:

1)、编写一个 NIO 入门案例, 实现服务器端和客户端之间的数据简单通讯(非阻塞)

2)、目的:理解 NIO 非阻塞网络编程机制

3)、代码演示

​ 服务端代码:

package com.pengtxyl.netty.nio;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.*;
import java.util.Iterator;
import java.util.Set;

public class NIOServer {

    public static void main(String[] args) throws Exception {
        //创建 ServerSocketChannel -> ServerSocket
        ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
        //得到一个 Selector 对象
        Selector selector = Selector.open();
        //绑定一个端口 6666, 在服务器端监听
        serverSocketChannel.socket().bind(new InetSocketAddress(6666));
        //设置为非阻塞
        serverSocketChannel.configureBlocking(false);
        //把 ServerSocketChannel 注册到 selector, 关心的事件为 OP_ACCEPT
        serverSocketChannel.register(selector, SelectionKey.OP_ACCEPT);

        System.out.println("注册后的selectionKey 数量= " + selector.keys().size()); //1

        //循环等待客户端连接
        while(true){
            //这里我们等待1秒, 如果没有事件发生(连接事件)
            if(selector.select(1000) == 0){
                System.out.println("服务器等待了1秒, 无连接...");
                continue;
            }
            //如果返回的值>0, 就获取到相关的 selectionKey 集合
            //1. 如果返回值>0, 表示已经获取到关注的事件
            //2. selector.selectedKeys() 返回关注事件的集合
            //      通过 selectionKeys 反向获取通道
            Set<SelectionKey> selectionKeys = selector.selectedKeys();
            System.out.println("selectionKeys数量= " + selectionKeys.size());
            //遍历 Set<SelectionKey>, 使用迭代器遍历
            Iterator<SelectionKey> keyIterator = selectionKeys.iterator();
            while(keyIterator.hasNext()){
                //获取到 SelectionKey
                SelectionKey key = keyIterator.next();
                //根据 key 对应的通道发生的事件做相应处理
                if(key.isAcceptable()){ //如果是 OP_ACCEPT, 表示有新的客户端连接
                    //给该客户端生成一个 SocketChannel
                    SocketChannel socketChannel = serverSocketChannel.accept();
                    System.out.println("客户端连接成功, 生成了一个 socketChannel " + socketChannel.hashCode());
                    //将 SocketChannel 设置为非阻塞
                    socketChannel.configureBlocking(false);
                    //将 socketChannel 注册到 selector, 关注事件为 OP_READ, 同时给 socketChannel 关联一个 Buffer
                    socketChannel.register(selector, SelectionKey.OP_READ, ByteBuffer.allocate(1024));
                    System.out.println("注册后的selectionkey数量 = " + selector.keys().size());
                }
                if(key.isReadable()){   //发生 OP_READ
                    //通过 key 反向获取到对应的 channel
                    SocketChannel channel = (SocketChannel) key.channel();
                    //获取到该 channel 关联的 buffer
                    ByteBuffer buffer = (ByteBuffer) key.attachment();
                    channel.read(buffer);
                    System.out.println("from 客户端 " + new String(buffer.array()));
                }

                //手动从集合中移动当前的 selectionKey, 防止重复操作
                keyIterator.remove();
            }
        }
    }

}

​ 客户端代码:

package com.pengtxyl.netty.nio;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.SocketChannel;

public class NIOClient {

    public static void main(String[] args) throws Exception {
        //得到一个网络通道
        SocketChannel socketChannel = SocketChannel.open();
        //设置非阻塞
        socketChannel.configureBlocking(false);
        //提供服务器端的 IP 和 端口号
        InetSocketAddress inetSocketAddress = new InetSocketAddress("127.0.0.1", 6666);
        //连接服务器
        if(!socketChannel.connect(inetSocketAddress)){
            while(!socketChannel.finishConnect()){
                System.out.println("因为连接需要时间, 客户端不会阻塞, 可以做其他工作");
            }
        }
        //...如果连接成功,就发送数据
        String str = "hello, 中国";
        //包裹一个字节数组到 buffer 里面去,字符数组是多大,那么 buffer 就会包裹多大的字节,不会产生多余空间
        ByteBuffer buffer = ByteBuffer.wrap(str.getBytes());
        //发送数据,将buffer数据写入channel
        socketChannel.write(buffer);
        System.in.read();
    }

}

9、SelectionKey

1)、SelectionKey:表示 Selector 和网络通道的注册关系, 共四种:

​ int OP_ACCEPT: 有新的网络连接可以 accept, 值为 16

​ int OP_CONNECT: 代表连接已经建立, 值为 8

​ int OP_READ: 代表读操作, 值为 1

​ int OP_WRITE: 代表写操作, 值为 4

​ 源码中:

​ public static final int OP_READ = 1 << 0;

​ public static final int OP_WRITE = 1 << 2;

​ public static final int OP_CONNECT = 1 << 3;

​ public static final int OP_ACCEPT = 1 << 4;

2)、SelectionKey 相关方法

在这里插入图片描述

10、ServerSocketChannel

1)、ServerSocketChannel 在服务器端监听新的客户端 Socket 连接

2)、相关方法如下

在这里插入图片描述

11、SocketChannel

1)、SocketChannel, 网络 IO 通道, 具体负责进行读写操作。 NIO 把缓冲区的数据写入通道, 或者把通道里的

​ 数据读到缓冲区。

2)、相关方法如下

在这里插入图片描述

12、NIO 网络编程应用实例-群聊系统

​ 实例要求:

1)、编写一个 NIO 群聊系统, 实现服务器端和客户端之间的数据简单通讯(非阻塞)

2)、实现多人群聊

3)、服务器端: 可以监测用户上线, 离线, 并实现消息转发功能

4)、客户端: 通过 channel 可以无阻塞发送消息给其它所有用户, 同时可以接受其它用户发送的消息(有服务器转

​ 发得到)

5)、目的: 进一步理解 NIO 非阻塞网络编程机制

6)、示意图分析和代码

在这里插入图片描述

​ 服务端代码:

package com.pengtxyl.netty.nio.groupchat;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.*;
import java.util.Iterator;

public class GroupChatServer {

    //定义属性
    private Selector selector;
    private ServerSocketChannel listenChannel;
    private static final int PORT = 6667;

    //构造器
    //初始化工作
    public GroupChatServer(){
        try{
            //得到选择器
            selector = Selector.open();
            //ServerSocketChannel
            listenChannel = ServerSocketChannel.open();
            //绑定端口
            listenChannel.socket().bind(new InetSocketAddress(PORT));
            //设置非阻塞模式
            listenChannel.configureBlocking(false);
            //将该listenChannel注册到selector上
            listenChannel.register(selector, SelectionKey.OP_ACCEPT);
        } catch (IOException e){
            e.printStackTrace();
        }
    }

    //监听
    public void listen(){
        try{
            //循环处理
            while (true){
                int count = selector.select(2000);
                if(count > 0){
                    //遍历得到selectionKey集合
                    Iterator<SelectionKey> iterator = selector.selectedKeys().iterator();
                    while(iterator.hasNext()){
                        //取出selectionkey
                        SelectionKey key = iterator.next();
                        //监听到accept
                        if(key.isAcceptable()){
                            SocketChannel sc = listenChannel.accept();
                            sc.configureBlocking(false);
                            //将该sc注册到 selector
                            sc.register(selector, SelectionKey.OP_READ);
                            //提示
                            System.out.println(sc.getRemoteAddress() + "上线了");
                        }
                        if(key.isReadable()){   //通道发生read事件,即通道是可读的状态
                            //处理读(专门写方法)
                            readData(key);
                        }

                        //当前的key删除, 防止重复操作
                        iterator.remove();
                    }
                }
            }
        } catch (Exception e){
            e.printStackTrace();
        } finally {

        }
    }

    //读取客户端消息
    private void readData(SelectionKey key){
        //定义一个SocketChannel
        SocketChannel channel = null;
        try {
            //得到channel
            channel = (SocketChannel) key.channel();
            //创建buffer
            ByteBuffer buffer = ByteBuffer.allocate(1024);
            int count = channel.read(buffer);
            //根据count的值做处理
            if(count > 0){
                //把缓存区的数据转成字符串
                String msg = new String(buffer.array());
                //输出该消息
                System.out.println("form 客户端: " + msg);

                //向其他的客户端转发消息,专门写一个方法来处理
                sendInfoToOtherClients(msg, channel);
            }
        } catch (Exception e){
            try {
                System.out.println(channel.getRemoteAddress() + " 离线了...");
                //取消注册
                key.cancel();
                //关闭通道
                channel.close();
            } catch (IOException e1){
                e1.printStackTrace();
            }
        }
    }

    //转发消息给其他客户(通道)
    private void sendInfoToOtherClients(String msg, SocketChannel self) throws IOException{
        System.out.println("服务器转发消息中...");
        //遍历所有注册到selector 上的 SocketChannel,并排除self
        for(SelectionKey key : selector.keys()){
            //通过key 取出对应的 SocketChannel
            Channel targetChannel = key.channel();
            //排除自己
            if(targetChannel instanceof SocketChannel && targetChannel != self){
                //转型
                SocketChannel dest = (SocketChannel) targetChannel;
                //将msg 存储到 buffer
                ByteBuffer buffer = ByteBuffer.wrap(msg.getBytes());
                //将buffer 的数据写入通道
                dest.write(buffer);
            }
        }
    }

    public static void main(String[] args) {
        //创建服务器对象
        GroupChatServer groupChatServer = new GroupChatServer();
        groupChatServer.listen();
    }
}

​ 客户端代码:

package com.pengtxyl.netty.nio.groupchat;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.SelectableChannel;
import java.nio.channels.SelectionKey;
import java.nio.channels.Selector;
import java.nio.channels.SocketChannel;
import java.util.Iterator;
import java.util.Scanner;

public class GroupChatClient {

    //定义相关属性
    private final String HOST = "127.0.0.1";
    private final int PORT = 6667;
    private Selector selector;
    private SocketChannel socketChannel;
    private String username;

    //构造器,完成初始化工作
    public GroupChatClient() throws IOException{
        selector = Selector.open();
        //连接服务器
        socketChannel = socketChannel.open(new InetSocketAddress("127.0.0.1", PORT));
        //设置非阻塞
        socketChannel.configureBlocking(false);
        //将channel 注册到selector
        socketChannel.register(selector, SelectionKey.OP_READ);
        //得到username
        username = socketChannel.getLocalAddress().toString().substring(1);
        System.out.println(username + "is ok...");
    }

    //向服务器发送消息
    public void sendInfo(String info){
        info = username + " 说: " + info;
        try{
            socketChannel.write(ByteBuffer.wrap(info.getBytes()));
        } catch (Exception e){
            e.printStackTrace();
        }
    }

    //读取从服务器端回复的消息
    public void readInfo(){
        try{
            int readChannels = selector.select();
            if(readChannels > 0){   //有可以用的通道
                Iterator<SelectionKey> iterator = selector.selectedKeys().iterator();
                while(iterator.hasNext()){
                    SelectionKey key = iterator.next();
                    if(key.isReadable()){
                        //得到相关的通道
                        SocketChannel sc = (SocketChannel) key.channel();
                        //得到一个Buffer
                        ByteBuffer buffer = ByteBuffer.allocate(1024);
                        //读取
                        sc.read(buffer);
                        //把读到的缓存区的数据转成字符串
                        String msg = new String(buffer.array());
                        System.out.println(msg.trim());
                    }
                }
                iterator.remove(); //删除当前的selectionKey,防止重复操作
            } else {
//                System.out.println("没有可以用的通道...");
            }
        } catch (Exception e){
            e.printStackTrace();
        }
    }

    public static void main(String[] args) throws Exception{
        //启动客户端
        GroupChatClient chatClient = new GroupChatClient();

        //启动一个线程, 每个3秒,读取从服务器发送数据
        new Thread(){
            public void run(){
                while(true){
                    chatClient.readInfo();
                    try{
                        Thread.currentThread().sleep(3000);
                    } catch (Exception e){
                        e.printStackTrace();
                    }
                }
            }
        }.start();

        //发送数据给服务器端
        Scanner scanner = new Scanner(System.in);
        while(scanner.hasNextLine()){
            String s = scanner.nextLine();
            chatClient.sendInfo(s);
        }
    }

}

13、NIO 与零拷贝

①、零拷贝基本介绍

​ 1)、零拷贝是网络编程的关键, 很多性能优化都离不开

​ 2)、在 Java 程序中, 常用的零拷贝有 mmap(内存映射) 和 sendFile。那么,他们在 OS 里,到底是怎么样的一

​ 个的设计? 我们分析 mmap 和 sendFile 这两个零拷贝

​ 3)、另外我们看下 NIO 中如何使用零拷贝

②、传统 IO 数据读写

​ Java 传统 IO 和 网络编程的一段代码

在这里插入图片描述

③、传统 IO 模型

在这里插入图片描述

​ DMA: direct memory access 直接内存拷贝(不使用 CPU)

④、mmap 优化

​ 1)、mmap 通过内存映射,将文件映射到内核缓冲区, 同时,用户空间可以共享内核空间的数据。这样,在进

​ 行网络传输时, 就可以减少内核空间到用户空间的拷贝次数。 如下图

​ 2)、mmap 示意图

在这里插入图片描述

⑤、sendFile 优化

​ 1)、Linux 2.1 版本 提供了 sendFile 函数, 其基本原理如下: 数据根本不经过用户态, 直接从内核缓冲区进入

​ 到Socket Buffer, 同时, 由于和用户态完全无关, 就减少了一次上下文切换

​ 2)、示意图和小结

在这里插入图片描述

​ 3)、提示: 零拷贝从操作系统角度, 是没有 cpu 拷贝

​ 4)、Linux 在 2.4 版本中, 做了一些修改, 避免了从内核缓冲区拷贝到 Socket buffer 的操作, 直接拷贝到协

​ 议栈,从而再一次减少了数据拷贝。 具体如下图和小结:

在这里插入图片描述

​ 5)、这里其实有 一次 cpu 拷贝

​ kernel buffer -> socket buffer

​ 但是, 拷贝的信息很少, 比如 lenght , offset , 消耗低, 可以忽略

⑥、零拷贝的再次理解

​ 1)、我们说零拷贝, 是从操作系统的角度来说的。 因为内核缓冲区之间, 没有数据是重复的(只有 kernel

​ buffer 有一份数据)

​ 2)、零拷贝不仅仅带来更少的数据复制, 还能带来其他的性能优势, 例如更少的上下文切换, 更少的 CPU 缓

​ 存伪共享以及无 CPU 校验和计算。

⑦、mmap 和 sendFile 的区别

1)、mmap 适合小数据量读写, sendFile 适合大文件传输

2)、mmap 需要 4 次上下文切换, 3 次数据拷贝; sendFile 需要 3 次上下文切换, 最少 2 次数据拷贝

3)、sendFile 可以利用 DMA 方式, 减少 CPU 拷贝, mmap 则不能(必须从内核拷贝到 Socket 缓冲区)

⑧、NIO 零拷贝案例

​ 案例要求:
​ 1)、使用传统的 IO 方法传递一个大文件

​ 2)、使用 NIO 零拷贝方式传递(transferTo)一个大文件

​ 3)、看看两种传递方式耗时时间分别是多少

​ 从运行结果可以看到, NIO 零拷贝方式传递要比传统 IO 传递快

​ 传统 IO 服务端:

package com.pengtxyl.netty.nio.zerocopy;

import java.io.DataInputStream;
import java.io.IOException;
import java.net.ServerSocket;
import java.net.Socket;

//java IO 的服务器
public class OldIOServer {

    public static void main(String[] args) throws IOException {
        ServerSocket serverSocket = new ServerSocket(7001);

        while(true){
            Socket socket = serverSocket.accept();
            DataInputStream dataInputStream = new DataInputStream(socket.getInputStream());

            try {
                byte[] byteArray = new byte[4096];
                while (true){
                    int readCount = dataInputStream.read(byteArray, 0, byteArray.length);
                    if(-1 == readCount){
                        break;
                    }
                }
            } catch (Exception e){
                e.printStackTrace();
            }
        }
    }

}

​ 传统 IO 客户端:

package com.pengtxyl.netty.nio.zerocopy;

import java.io.*;
import java.net.Socket;

public class OldIOClient {

    public static void main(String[] args) throws Exception {
        Socket socket = new Socket("localhost", 7001);
        String fileName = "file01.txt";
        InputStream inputStream = new FileInputStream(fileName);
        DataOutputStream dataOutputStream = new DataOutputStream(socket.getOutputStream());

        byte[] buffer = new byte[4096];
        long readCount;
        long total = 0;

        long startTime = System.currentTimeMillis();

        while((readCount = inputStream.read(buffer)) >= 0){
            total += readCount;
            dataOutputStream.write(buffer);
        }

        System.out.println("发送总字节数: " + total + ", 耗时: " + (System.currentTimeMillis() - startTime));

        dataOutputStream.close();
        socket.close();
        inputStream.close();
    }

}

​ 新 IO 服务端:

package com.pengtxyl.netty.nio.zerocopy;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.nio.ByteBuffer;
import java.nio.channels.ServerSocketChannel;
import java.nio.channels.SocketChannel;

public class NewIOServer {
    public static void main(String[] args) throws Exception {
        InetSocketAddress address = new InetSocketAddress(7001);
        ServerSocketChannel serverSocketChannel = ServerSocketChannel.open();
        ServerSocket serverSocket = serverSocketChannel.socket();
        serverSocket.bind(address);
        //创建 buffer
        ByteBuffer byteBuffer = ByteBuffer.allocate(4096);
        while(true){
            SocketChannel socketChannel = serverSocketChannel.accept();
            int readcount = 0;
            while(-1 != readcount){
                try {
                    readcount = socketChannel.read(byteBuffer);
                } catch (Exception e){
//                    e.printStackTrace();
                    break;
                }
                byteBuffer.rewind(); //倒带 position = 0, mark 作废
            }
        }
    }
}

​ 新 IO 客户端:

package com.pengtxyl.netty.nio.zerocopy;

import java.io.FileInputStream;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.channels.FileChannel;
import java.nio.channels.SocketChannel;

public class NewIOClient {

    public static void main(String[] args) throws Exception {
        SocketChannel socketChannel = SocketChannel.open();
        socketChannel.connect(new InetSocketAddress("localhost", 7001));
        String filename = "file01.txt";
        //得到一个文件channel
        FileChannel fileChannel = new FileInputStream(filename).getChannel();
        //准备发送
        long startTime = System.currentTimeMillis();

        //在 linux 下,一个 transferTo 方法就可以完成传输
        //在 windows 下,一次调用 transferTo 只能发送 8M,所以如果文件大于8M,就需要分段传输文件,而且要注意传输时的位置
        long transferCount = fileChannel.transferTo(0, fileChannel.size(), socketChannel);

        System.out.println("发送的总的字节数: " + transferCount + ",耗时: " + (System.currentTimeMillis() - startTime));

        //关闭
        fileChannel.close();
    }

}

14、Java AIO 基本介绍

1)、JDK 7 引入了 Asynchronous I/O, 即 AIO。 在进行 I/O 编程中, 常用到两种模式: Reactor 和 Proactor。

​ Java 的NIO 就是 Reactor, 当有事件触发时, 服务器端得到通知, 进行相应的处理

2)、AIO 即 NIO2.0, 叫做异步不阻塞的 IO。 AIO 引入异步通道的概念, 采用了 Proactor 模式, 简化了程序编

​ 写,有效的请求才启动线程, 它的特点是先由操作系统完成后才通知服务端程序启动线程去处理, 一般适用

​ 于连接数较多且连接时间较长的应用

3)、目前 AIO 还没有广泛应用, Netty 也是基于 NIO, 而不是 AIO, 因此我们就不详解 AIO 了, 有兴趣的同学可

​ 以 参 考 <<Java 新 一 代 网 络 编 程 模 型 AIO 原 理 及 Linux 系 统 AIO 介 绍 >>

​ http://www.52im.net/thread-306-1-1.html

15、BIO、 NIO、 AIO 对比表

在这里插入图片描述

四、Netty 概述

1、原生 NIO 存在的问题

1)、NIO 的类库和 API 繁杂, 使用麻烦: 需要熟练掌握 Selector、 ServerSocketChannel、 SocketChannel、

​ ByteBuffer等

2)、需要具备其他的额外技能: 要熟悉 Java 多线程编程, 因为 NIO 编程涉及到 Reactor 模式, 你必须对多线程

​ 和网络编程非常熟悉, 才能编写出高质量的 NIO 程序

3)、开发工作量和难度都非常大: 例如客户端面临断连重连、 网络闪断、 半包读写、 失败缓存、 网络拥塞和异

​ 常流的处理等等

4)、JDK NIO 的 Bug: 例如臭名昭著的 Epoll Bug, 它会导致 Selector 空轮询, 最终导致 CPU 100%。 直到 JDK

​ 1.7 版本该问题仍旧存在, 没有被根本解决

2、Netty 官网说明

​ 官网: https://netty.io/

​ Netty is an asynchronous event-driven network application framework for rapid development of

​ maintainable high performance protocol servers & clients

在这里插入图片描述

3、Netty 的优点

​ Netty 对 JDK 自带的 NIO 的 API 进行了封装, 解决了上述问题

1)、设计优雅: 适用于各种传输类型的统一 API 阻塞和非阻塞 Socket; 基于灵活且可扩展的事件模型, 可以清晰

​ 地分离关注点; 高度可定制的线程模型 - 单线程, 一个或多个线程池

2)、使用方便:详细记录的 Javadoc,用户指南和示例;没有其他依赖项,JDK 5 (Netty 3.x) 或 6 (Netty 4.x) 就足

​ 够了

3)、高性能、 吞吐量更高: 延迟更低; 减少资源消耗; 最小化不必要的内存复制

4)、安全: 完整的 SSL/TLS 和 StartTLS 支持

5)、社区活跃、 不断更新: 社区活跃, 版本迭代周期短, 发现的 Bug 可以被及时修复, 同时, 更多的新功能会

​ 被加入

4、Netty 版本说明

1)、netty 版本分为 netty3.x 和 netty4.x、 netty5.x

2)、因为 Netty5 出现重大 bug, 已经被官网废弃了, 目前推荐使用的是 Netty4.x 的稳定版本

3)、目前在官网可下载的版本 netty3.x netty4.0.x 和 netty4.1.x

4)、在本套课程中, 我们讲解 Netty4.1.x 版本

5)、netty 下载地址: https://bintray.com/netty/downloads/netty/

五、Netty 高性能架构设计

1、线程模型基本介绍

1)、不同的线程模式,对程序的性能有很大影响,为了搞清 Netty 线程模式,我们来系统的讲解下 各个线程模

​ 式,最后看看 Netty 线程模型有什么优越性

2)、目前存在的线程模型有:

​ 传统阻塞 I/O 服务模型

​ Reactor 模式

3)、根据 Reactor 的数量和处理资源池线程的数量不同, 有 3 种典型的实现

​ 单 Reactor 单线程;

​ 单 Reactor 多线程;

​ 主从 Reactor 多线程

4)、Netty 线程模式(Netty 主要基于主从 Reactor 多线程模型做了一定的改进, 其中主从 Reactor 多线程模型有

​ 多个 Reactor)

2、传统阻塞 I/O 服务模型

在这里插入图片描述

①、工作原理图

1)、黄色的框表示对象,蓝色的框表示线程

2)、白色的框表示方法(API)

②、模型特点

1)、采用阻塞 IO 模式获取输入的数据

2)、每个连接都需要独立的线程完成数据的输入, 业务处理,数据返回

③、问题分析

1)、当并发数很大, 就会创建大量的线程, 占用很大系统资源

2)、连接创建后, 如果当前线程暂时没有数据可读, 该线程会阻塞在 read 操作, 造成线程资源浪费

3、Reactor 模式

①、针对传统阻塞 I/O 服务模型的 2 个缺点, 解决方案

1)、基于 I/O 复用模型: 多个连接共用一个阻塞对象, 应用程序只需要在一个阻塞对象等待, 无需阻塞等待所有

​ 连接。 当某个连接有新的数据可以处理时, 操作系统通知应用程序, 线程从阻塞状态返回, 开始进行业务

​ 处理 Reactor 对应的叫法:

​ 1、反应器模式

​ 2、分发者模式(Dispatcher)

​ 3、通知者模式(notifier)

2)、基于线程池复用线程资源: 不必再为每个连接创建线程, 将连接完成后的业务处理任务分配给线程进行处

​ 理,一个线程可以处理多个连接的业务

在这里插入图片描述

②、I/O 复用结合线程池, 就是 Reactor 模式基本设计思想, 如图

在这里插入图片描述

​ 对上图说明:

1)、Reactor 模式, 通过一个或多个输入同时传递给服务处理器的模式(基于事件驱动)

2)、服务器端程序处理传入的多个请求,并将它们同步分派到相应的处理线程, 因此 Reactor 模式也叫 Dispatcher

​ 模式

3)、Reactor 模式使用 IO 复用监听事件, 收到事件后,分发给某个线程(进程), 这点就是网络服务器高并发处理关键

③、Reactor 模式中 核心组成

1)、Reactor: Reactor 在一个单独的线程中运行, 负责监听和分发事件, 分发给适当的处理程序来对 IO 事件做

​ 出反应。 它就像公司的电话接线员, 它接听来自客户的电话并将线路转移到适当的联系人

2)、Handlers: 处理程序执行 I/O 事件要完成的实际事件, 类似于客户想要与之交谈的公司中的实际官员。

​ Reactor 通过调度适当的处理程序来响应 I/O 事件, 处理程序执行非阻塞操作

④、Reactor 模式分类

​ 根据 Reactor 的数量和处理资源池线程的数量不同, 有 3 种典型的实现

1)、单 Reactor 单线程

2)、单 Reactor 多线程

3)、主从 Reactor 多线程

4、单 Reactor 单线程

原理图, 并使用 NIO 群聊系统验证:

在这里插入图片描述

①、方案说明

1)、Select 是前面 I/O 复用模型介绍的标准网络编程 API, 可以实现应用程序通过一个阻塞对象监听多路连接请求

2)、Reactor 对象通过 Select 监控客户端请求事件, 收到事件后通过 Dispatch 进行分发

3)、如果是建立连接请求事件, 则由 Acceptor 通过 Accept 处理连接请求, 然后创建一个 Handler 对象处理连接

​ 完成后的后续业务处理

4)、如果不是建立连接事件, 则 Reactor 会分发调用连接对应的 Handler 来响应

5)、Handler 会完成 Read→业务处理→Send 的完整业务流程

结合实例:服务器端用一个线程通过多路复用搞定所有的 IO 操作(包括连接, 读、 写等),编码简单,清晰明了,

​ 但是如果客户端连接数量较多, 将无法支撑, 前面的 NIO 案例就属于这种模型。

②、方案优缺点分析

1)、优点: 模型简单, 没有多线程、 进程通信、 竞争的问题, 全部都在一个线程中完成

2)、缺点: 性能问题, 只有一个线程, 无法完全发挥多核 CPU 的性能。 Handler 在处理某个连接上的业务时,

​ 整个进程无法处理其他连接事件, 很容易导致性能瓶颈

3)、缺点: 可靠性问题, 线程意外终止, 或者进入死循环, 会导致整个系统通信模块不可用, 不能接收和处理

​ 外部消息, 造成节点故障

4)、使用场景: 客户端的数量有限, 业务处理非常快速, 比如 Redis 在业务处理的时间复杂度 O(1) 的情况

5、单 Reactor 多线程

①、原理图

在这里插入图片描述

②、对上图的小结

1)、Reactor 对象通过 select 监控客户端请求事件, 收到事件后, 通过 dispatch 进行分发

2)、如果建立连接请求, 则由 Acceptor 通过 accept 处理连接请求, 然后创建一个 Handler 对象处理完成连接后的

​ 各种事件

3)、如果不是连接请求, 则由 reactor 分发调用连接对应的 handler 来处理

4)、handler 只负责响应事件, 不做具体的业务处理, 通过 read 读取数据后, 会分发给后面的 worker 线程池的

​ 某个线程处理业务

5)、worker 线程池会分配独立线程完成真正的业务, 并将结果返回给 handler

6)、handler 收到响应后, 通过 send 将结果返回给 client

③、方案优缺点分析

1)、优点: 可以充分的利用多核 cpu 的处理能力

2)、缺点: 多线程数据共享和访问比较复杂, reactor 处理所有的事件的监听和响应, 在单线程运行, 在高并发

​ 场景容易出现性能瓶颈

6、主从 Reactor 多线程

①、工作原理图

​ 针对单 Reactor 多线程模型中, Reactor 在单线程中运行, 高并发场景下容易成为性能瓶颈, 可以让 Reactor

​ 在多线程中运行

在这里插入图片描述

②、上图的方案说明

1)、Reactor 主线程 MainReactor 对象通过 select 监听连接事件, 收到事件后, 通过 Acceptor 处理连接事件

2)、当 Acceptor 处理连接事件后, MainReactor 将连接分配给 SubReactor

3)、subreactor 将连接加入到连接队列进行监听,并创建 handler 进行各种事件处理

4)、当有新事件发生时, subreactor 就会调用对应的 handler 处理

5)、handler 通过 read 读取数据, 分发给后面的 worker 线程处理

6)、worker 线程池分配独立的 worker 线程进行业务处理, 并返回结果

7)、handler 收到响应的结果后, 再通过 send 将结果返回给 client

8)、Reactor 主线程可以对应多个 Reactor 子线程, 即 MainRecator 可以关联多个 SubReactor

③、Scalable IO in Java 对 Multiple Reactors 的原理图解

在这里插入图片描述

④、方案优缺点说明

1)、优点: 父线程与子线程的数据交互简单职责明确, 父线程只需要接收新连接, 子线程完成后续的业务处理

2)、优点:父线程与子线程的数据交互简单,Reactor 主线程只需要把新连接传给子线程,子线程无需返回数据

3)、缺点: 编程复杂度较高

4)、结合实例: 这种模型在许多项目中广泛使用, 包括 Nginx 主从 Reactor 多进程模型, Memcached 主从多线

​ 程,Netty 主从多线程模型的支持

7、Reactor 模式小结

①、种模式用生活案例来理解

1)、单 Reactor 单线程, 前台接待员和服务员是同一个人, 全程为顾客服务

2)、单 Reactor 多线程, 1 个前台接待员, 多个服务员, 接待员只负责接待

3)、主从 Reactor 多线程, 多个前台接待员, 多个服务生

②、Reactor 模式具有如下的优点

1)、响应快, 不必为单个同步时间所阻塞, 虽然 Reactor 本身依然是同步的

2)、可以最大程度的避免复杂的多线程及同步问题, 并且避免了多线程/进程的切换开销

3)、扩展性好, 可以方便的通过增加 Reactor 实例个数来充分利用 CPU 资源

4)、复用性好, Reactor 模型本身与具体事件处理逻辑无关, 具有很高的复用性

8、Netty 模型

①、工作原理示意图 1-简单版

​ Netty主要基于主从 Reactors 多线程模型 (如图) 做了一定的改进,其中主从 Reactor 多线程模型有多个Reactor

在这里插入图片描述

②、对上图说明

1)、BossGroup 线程维护 Selector , 只关注 Accecpt

2)、当接收到 Accept 事件, 获取到对应的 SocketChannel, 封装成 NIOScoketChannel 并注册到 Worker 线程(事

​ 件循环), 并进行维护

3)、当 Worker 线程监听到 selector 中通道发生自己感兴趣的事件后, 就进行处理(就由 handler), 注意 handler

​ 已经加入到通道

③、工作原理示意图 2-进阶版

在这里插入图片描述

④、工作原理示意图-详细版

在这里插入图片描述

⑤、对上图的说明小结

1)、Netty 抽象出两组线程池 BossGroup 专门负责接收客户端的连接, WorkerGroup 专门负责网络的读写

2)、BossGroup 和 WorkerGroup 类型都是 NioEventLoopGroup

3)、NioEventLoopGroup 相当于一个事件循环组, 这个组中含有多个事件循环 , 每一个事件循环是

​ NioEventLoop

4)、NioEventLoop 表示一个不断循环的执行处理任务的线程, 每个 NioEventLoop 都有一个 selector , 用于监听

​ 绑定在其上的 socket 的网络通讯

5)、NioEventLoopGroup 可以有多个线程, 即可以含有多个 NioEventLoop

6)、每个 Boss NioEventLoop 循环执行的步骤有 3 步

​ ■ 轮询 accept 事件
​ ■ 处理 accept 事件 , 与 client 建立连接 , 生成 NioScocketChannel , 并将其注册到某个 worker

​ NIOEventLoop 上的 selector

​ ■ 处理任务队列的任务 , 即 runAllTasks

7)、每个 Worker NIOEventLoop 循环执行的步骤

​ ■ 轮询 read, write 事件

​ ■ 处理 i/o 事件, 即 read , write 事件, 在对应 NioScocketChannel 处理

​ ■ 处理任务队列的任务 , 即 runAllTasks

8)、每个Worker NIOEventLoop 处理业务时, 会使用pipeline(管道), pipeline 中包含了 channel , 即通过

​ pipeline 可以获取到对应通道, 管道中维护了很多的 处理器

⑥、Netty 快速入门实例-TCP 服务

​ 实例要求: 使用 IDEA 创建 Netty 项目

1)、Netty 服务器在 6668 端口监听, 客户端能发送消息给服务器 “hello, 服务器~”

2)、服务器可以回复消息给客户端 “hello, 客户端~”

3)、目的: 对 Netty 线程模型 有一个初步认识, 便于理解 Netty 模型理论

4)、看代码演示

​ 说明: 创建 Maven 项目, 并引入 Netty 包

​ 导入 netty 依赖包:

    <dependencies>
        <dependency>
            <groupId>io.netty</groupId>
            <artifactId>netty-all</artifactId>
            <version>4.1.20.Final</version>
        </dependency>
    </dependencies>

​ 服务端代码:

package com.pengtxyl.netty.netty.simple;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelOption;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;

public class NettyServer {

    public static void main(String[] args) throws InterruptedException {

        //创建 BossGroup 和 WorkerGroup
        //说明:
        //1. 创建两个线程组 bossGroup 和 workerGroup
        //2. bossGroup 只是处理连接请求,真正的和客户端业务处理会交给 workerGroup 完成
        //3. 两个都是无限循环
        //4. bossGroup 和 workerGroup 默认大小是 cpu核数*2
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {

            //创建服务器端的启动对象,配置参数
            ServerBootstrap bootstrap = new ServerBootstrap();

            //使用链式编程来进行设置
            bootstrap.group(bossGroup, workerGroup) //设置两个线程组
                    .channel(NioServerSocketChannel.class)   //使用NioSocketChannel 作为服务器的通道实现
                    .option(ChannelOption.SO_BACKLOG, 128) //设置线程队列得到连接个数
                    .childOption(ChannelOption.SO_KEEPALIVE, true) //设置保持活动连接状态
                    .childHandler(new ChannelInitializer<SocketChannel>() {    //创建一个通道测试对象(匿名对象)
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ch.pipeline().addLast(new NettyServerHandler());
                        }
                    });     //给 workerGroup 的 EventLoop 对应的管道设置处理器

            System.out.println(".....服务器 is ready .....");

            //绑定一个端口并且同步,生成了一个 ChannelFuture 对象
            //启动服务器(并绑定端口)
            ChannelFuture cf = bootstrap.bind(6668).sync();

            //对关闭通道进行监听
            cf.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }

    }

}

​ 服务端 Handler,即 NettyServerHandler:

package com.pengtxyl.netty.netty.simple;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

/*
* 说明:
* 1. 我们自定义一个 Handler 需要继承 netty 规定好的某个 HandlerAdapter(规范)
* 2. 这时我们自定义一个 Handler,才能成为一个 handler
* */
public class NettyServerHandler extends ChannelInboundHandlerAdapter {

    //读取数据事件(这里我们可以读取客户端发送的消息)
    /*
    * 1. ChannelHandlerContext ctx: 上下文对象,含有管道 Pipeline, 通道 channel, 地址 等
    * 2. Object msg: 就是客户端发送的数据,默认 Object
    * */
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        System.out.println("server ctx = " + ctx);
        //将 msg 转成一个 ByteBuf
        //ByteBuf 是 Netty 提供的,不是 NIO 的 ByteBuffer
        ByteBuf buf = (ByteBuf) msg;
        System.out.println("客户端发送的消息是: " + buf.toString(CharsetUtil.UTF_8));
        System.out.println("客户端地址: " + ctx.channel().remoteAddress());
    }

    //数据读取完毕
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        //writeAndFlush 是 write + flush
        //将数据写入到缓存,并刷新
        //一般讲,我们对这个发送的数据进行编码
        ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端~", CharsetUtil.UTF_8));
    }

    //处理异常,一般是需要关闭通道

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }
}

​ 客户端代码:

package com.pengtxyl.netty.netty.simple;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;

public class NettyClient {

    public static void main(String[] args) throws InterruptedException {
        //客户端需要一个事件循环组
        EventLoopGroup group = new NioEventLoopGroup();

        try {
            //创建客户端启动对象
            //注意客户端使用的不是 ServerBootstrap, 而是 Bootstrap
            Bootstrap bootstrap = new Bootstrap();

            //设置相关参数
            bootstrap.group(group) //设置线程组
                    .channel(NioSocketChannel.class)   //设置客户端通道的实现类(反射)
                    .handler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ch.pipeline().addLast(new NettyClientHandler());   //加入自己的处理器
                        }
                    });

            System.out.println("客户端 ok ...");

            //启动客户端去连接服务器端
            //关于 ChannelFuture 要分析,涉及到 netty 的异步模型
            ChannelFuture channelFuture = bootstrap.connect("127.0.0.1", 6668).sync();

            //给关闭通道进行监听
            channelFuture.channel().closeFuture().sync();
        } finally {
            group.shutdownGracefully();
        }
    }

}

​ 客户端 Handler,即 NettyClientHandler:

package com.pengtxyl.netty.netty.simple;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

public class NettyClientHandler extends ChannelInboundHandlerAdapter{

    //当通道就绪就会触发该方法
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        System.out.println("client: " + ctx);
        ctx.writeAndFlush(Unpooled.copiedBuffer("hello, server: (>^ω^<)喵", CharsetUtil.UTF_8));
    }

    //当通道有读取事件时,会触发
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        ByteBuf buf = (ByteBuf) msg;
        System.out.println("服务器回复的消息: " + buf.toString(CharsetUtil.UTF_8));
        System.out.println("服务器的地址: " + ctx.channel().remoteAddress());
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}

⑦、任务队列中的 Task 有 3 种典型使用场景

1)、用户程序自定义的普通任务 [举例说明]

​ 说明:当客户端与服务端连接后,如果服务端在 Handler 中处理的业务是一个很耗时的操作,那么客户端会一

​ 直阻塞,要等服务端将业务逻辑处理完,这样就会影响效率。我看可以在服务端将业务逻辑异步处理,即将

​ 处理的业务逻辑放入 taskQueue中,如下:

​ 注意:如果有两个 ctx.channel().eventLoop().execute 执行业务,如下代码,那么第二个业务要等第一个业

​ 务执行完后再等20秒再执行,即第二个业务一共耗时30秒,因为这两个业务是在同一个线程中执行的,所以

​ 他们的耗时是相加的。

​ 可以看到客户端接收的消息分别为:

​ hello, 客户端~

​ hello, 客户端aa

​ hello, 客户端bb

​ 服务端的 System.out.println(“go on …”); 这个代码会立刻执行,不需要等前面的耗时任务执行完后再执行

package com.pengtxyl.netty.netty.simple;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

/*
* 说明:
* 1. 我们自定义一个 Handler 需要继承 netty 规定好的某个 HandlerAdapter(规范)
* 2. 这时我们自定义一个 Handler,才能成为一个 handler
* */
public class NettyServerHandler extends ChannelInboundHandlerAdapter {

    //读取数据事件(这里我们可以读取客户端发送的消息)
    /*
    * 1. ChannelHandlerContext ctx: 上下文对象,含有管道 Pipeline, 通道 channel, 地址 等
    * 2. Object msg: 就是客户端发送的数据,默认 Object
    * */
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        System.out.println("server ctx = " + ctx);
        //将 msg 转成一个 ByteBuf
        //ByteBuf 是 Netty 提供的,不是 NIO 的 ByteBuffer
//        ByteBuf buf = (ByteBuf) msg;
//        System.out.println("客户端发送的消息是: " + buf.toString(CharsetUtil.UTF_8));
//        System.out.println("客户端地址: " + ctx.channel().remoteAddress());

        ctx.channel().eventLoop().execute(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(10 * 1000);
                    ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端aa", CharsetUtil.UTF_8));
                } catch (Exception e){
                    System.out.println("发送异常, " + e.getMessage());
                }
            }
        });

        ctx.channel().eventLoop().execute(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(20 * 1000);
                    ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端bb", CharsetUtil.UTF_8));
                } catch (Exception e){
                    System.out.println("发送异常, " + e.getMessage());
                }
            }
        });
        
        System.out.println("go on ...");

    }

    //数据读取完毕
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        //writeAndFlush 是 write + flush
        //将数据写入到缓存,并刷新
        //一般讲,我们对这个发送的数据进行编码
        ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端~", CharsetUtil.UTF_8));
    }

    //处理异常,一般是需要关闭通道

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }
}

2)、用户自定义定时任务

​ 说明:前面我们是将任务存放在 taskQueue中,除了可以放在 taskQueue 中以外,还可以放在

​ scheduleTaskQueue 中。如下:

package com.pengtxyl.netty.netty.simple;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

import java.util.concurrent.TimeUnit;

/*
* 说明:
* 1. 我们自定义一个 Handler 需要继承 netty 规定好的某个 HandlerAdapter(规范)
* 2. 这时我们自定义一个 Handler,才能成为一个 handler
* */
public class NettyServerHandler extends ChannelInboundHandlerAdapter {

    //读取数据事件(这里我们可以读取客户端发送的消息)
    /*
    * 1. ChannelHandlerContext ctx: 上下文对象,含有管道 Pipeline, 通道 channel, 地址 等
    * 2. Object msg: 就是客户端发送的数据,默认 Object
    * */
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        System.out.println("server ctx = " + ctx);
        //将 msg 转成一个 ByteBuf
        //ByteBuf 是 Netty 提供的,不是 NIO 的 ByteBuffer
//        ByteBuf buf = (ByteBuf) msg;
//        System.out.println("客户端发送的消息是: " + buf.toString(CharsetUtil.UTF_8));
//        System.out.println("客户端地址: " + ctx.channel().remoteAddress());
        
        ctx.channel().eventLoop().schedule(new Runnable() {
            @Override
            public void run() {
                try {
                    Thread.sleep(5 * 1000);
                    ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端cc", CharsetUtil.UTF_8));
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        }, 5, TimeUnit.SECONDS);

        System.out.println("go on ...");

    }

    //数据读取完毕
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        //writeAndFlush 是 write + flush
        //将数据写入到缓存,并刷新
        //一般讲,我们对这个发送的数据进行编码
        ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端~", CharsetUtil.UTF_8));
    }

    //处理异常,一般是需要关闭通道

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }
}

3)、非当前 Reactor 线程调用 Channel 的各种方法

​ 例如在推送系统的业务线程里面,根据用户的标识,找到对应的 Channel 引用,然后调用 Write 类方法向该

​ 用户推送消息,就会进入到这种场景。最终的 Write 会提交到任务队列中后被异步消费

​ 说明:如果有3个客户端连接到服务端,某一个客户端发送消息后,其他客户端通过服务端要获取那一个客户端

​ 发送的消息,我们可以在 NettyServer 中 initChannel 方法下面使用一个集合接收所有客户端的

​ SocketChannel,然后通过前面的方式将消息推送出去

bootstrap.group(bossGroup, workerGroup) //设置两个线程组
                    .channel(NioServerSocketChannel.class)   //使用NioSocketChannel 作为服务器的通道实现
                    .option(ChannelOption.SO_BACKLOG, 128) //设置线程队列得到连接个数
                    .childOption(ChannelOption.SO_KEEPALIVE, true) //设置保持活动连接状态
                    .childHandler(new ChannelInitializer<SocketChannel>() {    //创建一个通道测试对象(匿名对象)
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            //这里可以获取所有连接到服务端的客户端通道
                            // List.add(SocketChannel);
                            ch.pipeline().addLast(new NettyServerHandler());
                        }
                    });     //给 workerGroup 的 EventLoop 对应的管道设置处理器

⑧、方案再说明

1)、Netty 抽象出两组线程池, BossGroup 专门负责接收客户端连接, WorkerGroup 专门负责网络读写操作

2)、NioEventLoop 表示一个不断循环执行处理任务的线程, 每个 NioEventLoop 都有一个 selector, 用于监听

​ 绑定在其上的 socket 网络通道

3)、NioEventLoop 内部采用串行化设计,从消息的读取->解码->处理->编码->发送,始终由 IO 线程

​ NioEventLoop 负责

​ NioEventLoopGroup 下包含多个 NioEventLoop

​ ■ 每个 NioEventLoop 中包含有一个 Selector, 一个 taskQueue

​ ■ 每个 NioEventLoop 的 Selector 上可以注册监听多个 NioChannel

​ ■ 每个 NioChannel 只会绑定在唯一的 NioEventLoop 上

​ ■ 每个 NioChannel 都绑定有一个自己的 ChannelPipeline

9、异步模型

①、基本介绍

1)、异步的概念和同步相对。 当一个异步过程调用发出后, 调用者不能立刻得到结果。 实际处理这个调用的组件

​ 在完成后, 通过状态、 通知和回调来通知调用者

2)、Netty 中的 I/O 操作是异步的, 包括 Bind、 Write、 Connect 等操作会简单的返回一个 ChannelFuture

3)、调用者并不能立刻获得结果, 而是通过 Future-Listener 机制, 用户可以方便的主动获取或者通过通知机制

​ 获得 IO 操作结果

4)、Netty 的异步模型是建立在 future 和 callback 的之上的。 callback 就是回调。 重点说 Future, 它的核心思

​ 想是: 假设一个方法 fun, 计算过程可能非常耗时, 等待 fun 返回显然不合适。 那么可以在调用 fun 的时

​ 候,立马返回一个 Future, 后续可以通过 Future 去监控方法 fun 的处理过程(即 : Future-Listener 机制)

②、Future 说明

1)、表示异步的执行结果, 可以通过它提供的方法来检测执行是否完成, 比如检索计算等等

2)、ChannelFuture 是一个接口 : public interface ChannelFuture extends Future

​ 我们可以添加监听器, 当监听的事件发生时, 就会通知到监听器. 案例说明

③、工作原理示意图

在这里插入图片描述

​ 说明:

​ 1)、在使用 Netty 进行编程时, 拦截操作和转换出入站数据只需要您提供 callback 或利用 future 即可。 这

​ 使得链式操作简单、 高效, 并有利于编写可重用的、 通用的代码

​ 2)、Netty 框架的目标就是让你的业务逻辑从网络基础应用编码中分离出来、 解脱出来

④、Future-Listener 机制

1)、当 Future 对象刚刚创建时, 处于非完成状态, 调用者可以通过返回的 ChannelFuture 来获取操作执行的状

​ 态,注册监听函数来执行完成后的操作

2)、常见有如下操作

​ ■ 通过 isDone 方法来判断当前操作是否完成;

​ ■ 通过 isSuccess 方法来判断已完成的当前操作是否成功;

​ ■ 通过 getCause 方法来获取已完成的当前操作失败的原因;

​ ■ 通过 isCancelled 方法来判断已完成的当前操作是否被取消;

​ ■ 通过 addListener 方法来注册监听器, 当操作已完成(isDone 方法返回完成), 将会通知指定的监听器; 如

​ 果 Future 对象已完成, 则通知指定的监听器

​ 举例说明:

​ 演示: 绑定端口是异步操作, 当绑定操作处理完, 将会调用相应的监听器处理逻辑

package com.pengtxyl.netty.netty.simple;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;

public class NettyServer {

    public static void main(String[] args) throws InterruptedException {

        //创建 BossGroup 和 WorkerGroup
        //说明:
        //1. 创建两个线程组 bossGroup 和 workerGroup
        //2. bossGroup 只是处理连接请求,真正的和客户端业务处理会交给 workerGroup 完成
        //3. 两个都是无限循环
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {

            //创建服务器端的启动对象,配置参数
            ServerBootstrap bootstrap = new ServerBootstrap();

            //使用链式编程来进行设置
            bootstrap.group(bossGroup, workerGroup) //设置两个线程组
                    .channel(NioServerSocketChannel.class)   //使用NioSocketChannel 作为服务器的通道实现
                    .option(ChannelOption.SO_BACKLOG, 128) //设置线程队列得到连接个数
                    .childOption(ChannelOption.SO_KEEPALIVE, true) //设置保持活动连接状态
                    .childHandler(new ChannelInitializer<SocketChannel>() {    //创建一个通道测试对象(匿名对象)
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ch.pipeline().addLast(new NettyServerHandler());
                        }
                    });     //给 workerGroup 的 EventLoop 对应的管道设置处理器

            System.out.println(".....服务器 is ready .....");

            //绑定一个端口并且同步,生成了一个 ChannelFuture 对象
            //启动服务器(并绑定端口)
            ChannelFuture cf = bootstrap.bind(6668).sync();
            
            //给 cf 注册监听器,监听我们关心的事件
            cf.addListener(new ChannelFutureListener() {
                @Override
                public void operationComplete(ChannelFuture future) throws Exception {
                    if(cf.isSuccess()){
                        System.out.println("监听端口 6668 成功");
                    } else {
                        System.out.println("监听端口 6668 失败");
                    }
                }
            });

            //对关闭通道进行监听
            cf.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }

    }

}

10、快速入门实例-HTTP 服务

1)、实例要求: 使用 IDEA 创建 Netty 项目

2)、Netty 服务器在 6668 端口监听, 浏览器发出请求 "http://localhost:6668/ "

3)、服务器可以回复消息给客户端 "Hello! 我是服务器 5 " , 并对特定请求资源进行过滤

4)、目的: Netty 可以做 Http 服务开发, 并且理解 Handler 实例和客户端及其请求的关系

5)、看代码演示

​ 服务端代码:

package com.pengtxyl.netty.netty.http;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;

public class HttpServer {

    public static void main(String[] args) throws Exception{
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            serverBootstrap.group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new HttpServerInitializer());
            ChannelFuture channelFuture = serverBootstrap.bind(6668).sync();

            channelFuture.channel().closeFuture().sync();

        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }

}

​ Handler 代码:

package com.pengtxyl.netty.netty.http;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.*;
import io.netty.util.CharsetUtil;

import java.net.URI;

/*
* 说明:
* 1. SimpleChannelInboundHandler 继承自 ChannelInboundHandlerAdapter
* 2. HttpObject 客户端和服务器端相互通讯的数据被封装成 HttpObject
* */
public class HttpServerHandler extends SimpleChannelInboundHandler<HttpObject> {

    //channelRead0 读取客户端数据
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, HttpObject msg) throws Exception {
        //判断 msg 是不是 httprequest 请求
        if(msg instanceof HttpRequest){
            System.out.println("msg 类型 = " + msg.getClass());
            System.out.println("客户端地址 = " + ctx.channel().remoteAddress());

            HttpRequest httpRequest = (HttpRequest) msg;
            //获取 URI
            URI uri = new URI(httpRequest.uri());
            if("/favicon.ico".equals(uri.getPath())){
                System.out.println("请求了 favicon.ico, 不做响应");
                return ;
            }

            //回复信息给浏览器 [http 协议]
            ByteBuf content = Unpooled.copiedBuffer("hello, 我是服务器。。。", CharsetUtil.UTF_8);

            //构造一个 http 的响应,即 httpresponse
            FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK, content);

//            response.headers().set(HttpHeaderNames.CONTENT_TYPE, "application/json");
            response.headers().set(HttpHeaderNames.CONTENT_TYPE, "text/plain");
            response.headers().set(HttpHeaderNames.CONTENT_LENGTH, content.readableBytes());

            //将构建好的 response 返回
            ctx.writeAndFlush(response);
        }
    }

}

​ Initializer 代码:

package com.pengtxyl.netty.netty.http;

import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;
import io.netty.handler.codec.http.HttpServerCodec;

public class HttpServerInitializer extends ChannelInitializer<SocketChannel> {
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        //向管道加入处理器

        //得到管道
        ChannelPipeline pipeline = ch.pipeline();

        //加入一个 netty 提供的 httpServerCodec code => [coder - decoder]
        //HttpServerCodec 说明:
        //HttpServerCodec 是 netty 提供的处理 http 的编码解码器
        pipeline.addLast("MyHttpServerCodec", new HttpServerCodec());
        //增加一个自定义的 handler
        pipeline.addLast("MyHttpServerHandler", new HttpServerHandler());

    }
}

六、Netty 核心模块组件

1、Bootstrap、 ServerBootstrap

1)、Bootstrap 意思是引导, 一个 Netty 应用通常由一个 Bootstrap 开始, 主要作用是配置整个 Netty 程序, 串

​ 联各个组件, Netty 中 Bootstrap 类是客户端程序的启动引导类, ServerBootstrap 是服务端启动引导类

2)、常见的方法有

​ public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup)

​ 该方法用于服务器端,用来设置两个 EventLoop

​ public B group(EventLoopGroup group)

​ 该方法用于客户端, 用来设置一个 EventLoop

​ public B channel(Class<? extends C> channelClass)

​ 该方法用来设置一个服务器端的通道实现

​ public B option(ChannelOption option, T value)

​ 用来给 ServerChannel 添加配置

​ public ServerBootstrap childOption(ChannelOption childOption, T value)

​ 用来给接收到的通道添加配置

​ public ServerBootstrap childHandler(ChannelHandler childHandler)

​ 该方法用来设置业务处理类( 自定义的handler)

​ public ServerBootstrap handler(ChannelHandler handler)

​ 该方法和 childHandler 的区别是:childHandler 对应的是 workerGroup,而 handler 对应的是 bossGroup

​ public ChannelFuture bind(int inetPort)

​ 该方法用于服务器端, 用来设置占用的端口号

​ public ChannelFuture connect(String inetHost, int inetPort)

​ 该方法用于客户端, 用来连接服务器端

2、Future、 ChannelFuture

Netty 中所有的 IO 操作都是异步的, 不能立刻得知消息是否被正确处理。 但是可以过一会等它执行完成或者直接

注册一个监听, 具体的实现就是通过 Future 和 ChannelFutures, 他们可以注册一个监听, 当操作执行成功或失

败时监听会自动触发注册的监听事件

​ 常见的方法有:

Channel channel(), 返回当前正在进行 IO 操作的通道

ChannelFuture sync(), 等待异步操作执行完毕

3、Channel

1)、Netty 网络通信的组件, 能够用于执行网络 I/O 操作

2)、通过 Channel 可获得当前网络连接的通道的状态

3)、通过 Channel 可获得 网络连接的配置参数 (例如接收缓冲区大小)

4)、Channel 提供异步的网络 I/O 操作(如建立连接, 读写, 绑定端口), 异步调用意味着任何 I/O 调用都将立即

​ 返回, 并且不保证在调用结束时所请求的 I/O 操作已完成

5)、调用立即返回一个 ChannelFuture 实例, 通过注册监听器到 ChannelFuture 上, 可以 I/O 操作成功、 失败

​ 或取消时回调通知调用方

6)、支持关联 I/O 操作与对应的处理程序

7)、不同协议、 不同的阻塞类型的连接都有不同的 Channel 类型与之对应, 常用的 Channel 类型:

​ NioSocketChannel, 异步的客户端 TCP Socket 连接。

​ NioServerSocketChannel, 异步的服务器端 TCP Socket 连接。

​ NioDatagramChannel, 异步的 UDP 连接。

​ NioSctpChannel, 异步的客户端 Sctp 连接。

​ NioSctpServerChannel, 异步的 Sctp 服务器端连接, 这些通道涵盖了 UDP 和 TCP 网络 IO 以及文件 IO。

4、Selector

1)、Netty 基于 Selector 对象实现 I/O 多路复用, 通过 Selector 一个线程可以监听多个连接的 Channel 事件。

2)、当向一个 Selector 中注册 Channel 后, Selector 内部的机制就可以自动不断地查询(Select) 这些注册的

​ Channel 是否有已就绪的 I/O 事件(例如可读, 可写, 网络连接完成等) , 这样程序就可以很简单地使用

​ 一个线程高效地管理多个 Channel

5、ChannelHandler 及其实现类

1)、ChannelHandler 是一个接口, 处理 I/O 事件或拦截 I/O 操作, 并将其转发到其 ChannelPipeline(业务处理

​ 链) 中的下一个处理程序。

2)、ChannelHandler 本身并没有提供很多方法, 因为这个接口有许多的方法需要实现, 方便使用期间, 可以继

​ 承它的子类

3)、ChannelHandler 及其实现类一览图(后)

在这里插入图片描述

4)、我们经常需要自定义一个 Handler 类去继承 ChannelInboundHandlerAdapter, 然后通过重写相应方法实现

​ 业务逻辑, 我们接下来看看一般都需要重写哪些方法

在这里插入图片描述

6 Pipeline 和 ChannelPipeline

​ ChannelPipeline 是一个重点:

1)、ChannelPipeline 是一个 Handler 的集合, 它负责处理和拦截 inbound 或者 outbound 的事件和操作, 相

​ 当于一个贯穿 Netty 的链。 (也可以这样理解: ChannelPipeline 是 保存 ChannelHandler 的 List, 用于处

​ 理或拦截 Channel 的入站事件和出站操作)

2)、ChannelPipeline 实现了一种高级形式的拦截过滤器模式, 使用户可以完全控制事件的处理方式, 以及

​ Channel 中各个的 ChannelHandler 如何相互交互

3)、在 Netty 中每个 Channel 都有且仅有一个 ChannelPipeline 与之对应, 它们的组成关系如下

在这里插入图片描述

4)、常用方法

​ ChannelPipeline addFirst(ChannelHandler… handlers)

​ 把一个业务处理类(handler) 添加到链中的第一个位置

​ ChannelPipeline addLast(ChannelHandler… handlers)

​ 把一个业务处理类(handler) 添加到链中的最后一个位置

7、ChannelHandlerContext

1)、保存 Channel 相关的所有上下文信息, 同时关联一个 ChannelHandler 对象

2)、即 ChannelHandlerContext 中 包 含 一 个 具 体 的 事 件 处 理 器 ChannelHandler , 同时

​ ChannelHandlerContext 中也绑定了对应的 pipeline 和 Channel 的信息, 方便对 ChannelHandler 进行调用

3)、常用方法

在这里插入图片描述

8、ChannelOption

1)、Netty 在创建 Channel 实例后,一般都需要设置 ChannelOption 参数。

2)、ChannelOption 参数如下:

在这里插入图片描述

9、EventLoopGroup 和其实现类 NioEventLoopGroup

1)、EventLoopGroup 是一组 EventLoop 的抽象, Netty 为了更好的利用多核 CPU 资源, 一般会有多个

​ EventLoop 同时工作, 每个 EventLoop 维护着一个 Selector 实例。

2)、EventLoopGroup 提供 next 接口, 可以从组里面按照一定规则获取其中一个 EventLoop 来处理任务。 在

​ Netty 服 务 器 端 编 程 中 , 我 们 一 般 都 需 要 提 供 两 个 EventLoopGroup , 例 如 :

​ BossEventLoopGroup 和

​ WorkerEventLoopGroup

3)、通常一个服务端口即一个 ServerSocketChannel 对应一个 Selector 和一个 EventLoop 线程。

​ BossEventLoop 负责接收客户端的连接并将 SocketChannel 交给 WorkerEventLoopGroup 来进行 IO 处

​ 理, 如下图所示

在这里插入图片描述

4)、常用方法

​ public NioEventLoopGroup()

​ 构造方法

​ public Future<?> shutdownGracefully()

​ 断开连接, 关闭线程

10、Unpooled 类

1)、Netty 提供一个专门用来操作缓冲区(即 Netty 的数据容器)的工具类

2)、常用方法如下所示

在这里插入图片描述

3)、举例说明 Unpooled 获取 Netty 的数据容器 ByteBuf 的基本使用 【案例演示】

在这里插入图片描述

​ 案例 1:

package com.pengtxyl.netty.netty.buf;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;

public class NettyByteBuf01 {

    public static void main(String[] args) {

        //创建一个 ByteBuf
        //说明:
        //1. 创建对象,该对象包含一个数组 arr,是一个 byte[10]
        //2. 在 netty 的 buffer 中,不需要使用 flip 进行反转
        //      底层维护了 readerIndex 和 writerIndex
        //3. 通过 readerIndex 和 writerIndex 和 capacity,将 buffer 分成三个区域
        //      0 --- readerIndex 已经读取的区域
        //      readerIndex --- writerIndex 可读的区域
        //      writerIndex --- capacity 可写的区域
        ByteBuf buffer = Unpooled.buffer(10);

        for(int i = 0 ; i < 10 ; i++){
            //buffer.writeByte() 会将 writerIndex 递增
            buffer.writeByte(i);
        }

        System.out.println("capacity = " + buffer.capacity());

        //输出
//        for (int i = 0; i < buffer.capacity(); i++) {
//            System.out.println(buffer.getByte(i));
//        }

        for (int i = 0; i < buffer.capacity(); i++) {
            //buffer.readByte() 会将 readerIndex 递增
            System.out.println(buffer.readByte());
        }
        System.out.println("执行完毕");

    }

}

​ 案例2:

package com.pengtxyl.netty.netty.buf;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;

import java.nio.charset.Charset;

public class NettyByteBuf02 {

    public static void main(String[] args) {
        //创建 ByteBuf
        ByteBuf byteBuf = Unpooled.copiedBuffer("hello, world!", Charset.forName("utf-8"));

        //使用相关的方法
        if(byteBuf.hasArray()){ //是否分配了一个数组
            byte[] content = byteBuf.array();
            //将 content 转成字符串
            System.out.println(new String(content, Charset.forName("utf-8")));
            System.out.println("byteBuf = " + byteBuf);
            System.out.println(byteBuf.arrayOffset());  //0
            System.out.println(byteBuf.readerIndex());  //0
            System.out.println(byteBuf.writerIndex());  //12
            System.out.println(byteBuf.capacity());     //36

            System.out.println(byteBuf.getByte(0)); //104 -> h

            int len = byteBuf.readableBytes();          //可读的字节数
            System.out.println("len = " + len);

            //使用 for 取出各个字节
            for (int i = 0; i < len; i++) {
                System.out.println((char) byteBuf.getByte(i));
            }

            //从位置为0开始读取4个数据
            System.out.println(byteBuf.getCharSequence(0, 4, Charset.forName("utf-8")));
            //从位置为4开始读取6个数据
            System.out.println(byteBuf.getCharSequence(4, 6, Charset.forName("utf-8")));
        }
    }

}

11、Netty 应用实例-群聊系统

​ 实例要求

1)、编写一个 Netty 群聊系统, 实现服务器端和客户端之间的数据简单通讯(非阻塞)

2)、实现多人群聊

3)、服务器端: 可以监测用户上线, 离线, 并实现消息转发功能

4)、客户端: 通过 channel 可以无阻塞发送消息给其它所有用户, 同时可以接受其它用户发送的消息(有服务器转

​ 发得到)

5)、目的: 进一步理解 Netty 非阻塞网络编程机制

6)、看代码演示

在这里插入图片描述

​ 服务端代码:

package com.pengtxyl.netty.netty.groupchat;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelOption;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;

public class GroupChatServer {

    private int port; //监听端口

    public GroupChatServer(int port){
        this.port = port;
    }

    //编写 run 方法,处理客户端的请求
    public void run() throws Exception{
        //创建两个线程组
        NioEventLoopGroup bossGroup = new NioEventLoopGroup(1);
        NioEventLoopGroup workerGroup = new NioEventLoopGroup();

        try {
            ServerBootstrap b = new ServerBootstrap();

            b.group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childOption(ChannelOption.SO_BACKLOG, 128)
                    .childHandler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            //获取到 pipeline
                            ChannelPipeline pipeline = ch.pipeline();
                            //向 pipeline 加入解码器
                            pipeline.addLast("decoder", new StringDecoder());
                            //向 pipeline 加入编码器
                            pipeline.addLast("encoder", new StringEncoder());
                            //加入自己的业务处理 handler
                            pipeline.addLast(new GroupChatServerHandler());
                        }
                    });

            System.out.println("netty 服务器启动");
            ChannelFuture channelFuture = b.bind(port).sync();
            //监听关闭
            channelFuture.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }

    public static void main(String[] args) throws Exception{
        new GroupChatServer(7000).run();
    }

}

​ 服务端自定义 handler 代码:

package com.pengtxyl.netty.netty.groupchat;

import io.netty.channel.Channel;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.channel.group.ChannelGroup;
import io.netty.channel.group.DefaultChannelGroup;
import io.netty.util.concurrent.GlobalEventExecutor;

import java.text.SimpleDateFormat;

public class GroupChatServerHandler extends SimpleChannelInboundHandler<String> {

    //定义一个 channel 组,管理所有的 channel
    //GlobalEventExecutor.INSTANCE 是全局的事件执行器,是一个单例
    private static ChannelGroup channelGroup = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    //handlerAdded 表示连接建立,一旦连接,handlerAdded 是第一个执行的方法
    //将当前 channel 加入到 channelGroup
    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        Channel channel = ctx.channel();
        //将该客户加入聊天的信息推送给其他在线的客户端
        /*
        * 该方法会将 channelGroup 中所有的 channel 遍历,并发送消息,我们不需要自己遍历
        * */
        channelGroup.writeAndFlush("[客户端] " + channel.remoteAddress() + " 加入聊天\n");
        channelGroup.add(channel);
    }

    //断开连接,将 xx 客户端离开消息推送给当前在线的客户端
    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
        Channel channel = ctx.channel();
        channelGroup.writeAndFlush("[客户端] " + channel.remoteAddress() + " 离开了\n");
        System.out.println("channelGroup size " + channelGroup.size());
    }

    //表示 channel 处于活动状态,提示 xx 上线
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        System.out.println(ctx.channel().remoteAddress() + " 上线了...");
    }

    //表示 channel 处于不活动状态,提示 xx 离线了
    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {
        System.out.println(ctx.channel().remoteAddress() + " 离线了...");
    }

    //读取消息
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
        //获取当前的 channel
        Channel channel = ctx.channel();
        //这时我们遍历 channelGroup, 根据不同的情况,回送不同的消息
        channelGroup.forEach(ch -> {
            if(channel != ch) {   //不是当前的 channel, 转发消息
                ch.writeAndFlush("[客户端] " + channel.remoteAddress() + " 发送消息: " + msg + "\n");
            } else {    //回显自己发送的消息给自己
                ch.writeAndFlush("[自己]发送了消息: " + msg + "\n");
            }
        });
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        //关闭
        ctx.close();
    }
}

​ 客户端代码:

package com.pengtxyl.netty.netty.groupchat;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;

import java.util.Scanner;

public class GroupChatClient {

    //属性
    private final String host;
    private final int port;

    public GroupChatClient(String host, int port){
        this.host = host;
        this.port = port;
    }

    public void run() throws Exception{
        NioEventLoopGroup group = new NioEventLoopGroup();

        try {
            Bootstrap bootstrap = new Bootstrap();
            bootstrap.group(group)
                    .channel(NioSocketChannel.class)
                    .handler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            //得到 pipeline
                            ChannelPipeline pipeline = ch.pipeline();
                            //加入相关的 handler
                            pipeline.addLast("decoder", new StringDecoder());
                            pipeline.addLast("encoder", new StringEncoder());
                            //加入自定义的 handler
                            pipeline.addLast(new GroupChatClientHandler());
                        }
                    });
            ChannelFuture channelFuture = bootstrap.connect(host, port).sync();
            //得到 channel
            Channel channel = channelFuture.channel();
            System.out.println("-------" + channel.localAddress() + "-------");
            //客户端需要输入信息,创建一个扫描器
            Scanner scanner = new Scanner(System.in);
            while(scanner.hasNextLine()){
                String msg = scanner.nextLine();
                //通过 channel 发送到服务器端
                channel.writeAndFlush(msg + "\r\n");
            }
        } finally {
            group.shutdownGracefully();
        }
    }

    public static void main(String[] args) throws Exception{
        new GroupChatClient("127.0.0.1", 7000).run();
    }

}

​ 客户端自定义 handler:

package com.pengtxyl.netty.netty.groupchat;

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;

public class GroupChatClientHandler extends SimpleChannelInboundHandler<String>{
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception {
        System.out.println(msg.trim());
    }
}

12、Netty 心跳检测机制案例

​ 实例要求:

1)、编写一个 Netty 心跳检测机制案例, 当服务器超过 3 秒没有读时, 就提示读空闲

2)、当服务器超过 5 秒没有写操作时, 就提示写空闲

3)、实现当服务器超过 7 秒没有读或者写操作时, 就提示读写空闲

4)、代码如下:

​ 服务端代码:

package com.pengtxyl.netty.netty.heartbeat;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.logging.LogLevel;
import io.netty.handler.logging.LoggingHandler;
import io.netty.handler.timeout.IdleStateHandler;

import java.util.concurrent.TimeUnit;

public class HeartBeatServer {

    public static void main(String[] args) throws Exception{
        //创建两个线程组
        NioEventLoopGroup bossGroup = new NioEventLoopGroup(1);
        NioEventLoopGroup workerGroup = new NioEventLoopGroup();

        try{
            ServerBootstrap sbs = new ServerBootstrap();

            sbs.group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .handler(new LoggingHandler(LogLevel.INFO))
                    .childHandler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ChannelPipeline pipeline = ch.pipeline();
                            //加入一个 netty 提供的 IdleStateHandler
                            /*
                            * 说明:
                            * 1. IdleStateHandler 是 netty 提供的处理空闲状态的处理器
                            * 2. long readerIdleTime: 表示多长时间没有读就会发送一个心跳检测包检测是否连接
                            * 3. long writerIdleTime: 表示多长时间没有写就会发送一个心跳检测包检测是否连接
                            * 4. long allIdleTime: 表示多长时间没有读写就会发送一个心跳检测包检测是否连接
                            * 5. 文档说明
                            *       Triggers an {@link IdleStateEvent} when a {@link Channel} has not performed
                            *       read, write, or both operation for a while.
                            *       (当有一个通道没有执行读,写或读写都没有执行就会触发空闲状态事件)
                            * 6. 当 IdleStateEvent 触发后,就会传到给管道的下一个 handler 去处理,通过
                            *       调用(触发)下一个 handler 的 userEventTiggered,该方法中去处理
                            *       IdleStateEvent(读空闲,写空闲,读写空闲)
                            * */
                            pipeline.addLast(new IdleStateHandler(3, 5, 7, TimeUnit.SECONDS));
                            //加入一个对空闲检测进一步处理的 handler(自定义)
                            pipeline.addLast(new HeartBeatServerHandler());
                        }
                    });
            //启动服务器
            ChannelFuture channelFuture = sbs.bind(7000).sync();
            channelFuture.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }

}

​ 服务端自定义 handler:

package com.pengtxyl.netty.netty.heartbeat;

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.handler.timeout.IdleStateEvent;

public class HeartBeatServerHandler extends ChannelInboundHandlerAdapter {

    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
        if(evt instanceof IdleStateEvent){
            //将 evt 向下转型 IdleStateEvent
            IdleStateEvent event = (IdleStateEvent) evt;
            String eventTypt = null;
            switch (event.state()){
                case READER_IDLE:
                    eventTypt = "读空闲";
                    break;
                case WRITER_IDLE:
                    eventTypt = "写空闲";
                    break;
                case ALL_IDLE:
                    eventTypt = "读写空闲";
                    break;
            }
            System.out.println(ctx.channel().remoteAddress() + "--超时时间--" + eventTypt);
            System.out.println("服务器做相应处理");
        }
    }
}

13、Netty 通过 WebSocket 编程实现服务器和客户端长连接

​ 实例要求:

1)、Http 协议是无状态的, 浏览器和服务器间的请求响应一次, 下一次会重新创建连接

2)、要求: 实现基于 webSocket 的长连接的全双工的交互

3)、改变 Http 协议多次请求的约束, 实现长连接了, 服务器可以发送消息给浏览器

4)、客户端浏览器和服务器端会相互感知,比如服务器关闭了,浏览器会感知,同样浏览器关闭了,服务器会感知

5)、运行界面

在这里插入图片描述

6)、代码:

​ 服务端代码:

package com.pengtxyl.netty.netty.websocket;

import com.pengtxyl.netty.netty.heartbeat.HeartBeatServerHandler;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.http.HttpObjectAggregator;
import io.netty.handler.codec.http.HttpServerCodec;
import io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler;
import io.netty.handler.logging.LogLevel;
import io.netty.handler.logging.LoggingHandler;
import io.netty.handler.stream.ChunkedWriteHandler;
import io.netty.handler.timeout.IdleStateHandler;

import java.util.concurrent.TimeUnit;

public class WebSocketServer {

    public static void main(String[] args) throws Exception{

        //创建两个线程组
        NioEventLoopGroup bossGroup = new NioEventLoopGroup(1);
        NioEventLoopGroup workerGroup = new NioEventLoopGroup();

        try{
        ServerBootstrap sbs = new ServerBootstrap();

        sbs.group(bossGroup, workerGroup)
                .channel(NioServerSocketChannel.class)
                .handler(new LoggingHandler(LogLevel.INFO))
                .childHandler(new ChannelInitializer<SocketChannel>() {
                    @Override
                    protected void initChannel(SocketChannel ch) throws Exception {
                        ChannelPipeline pipeline = ch.pipeline();
                        //因为基于 http 协议,使用 http 的编码和解码器
                        pipeline.addLast(new HttpServerCodec());
                        //是以块方式写,添加 ChunkedWriteHandler 处理器
                        pipeline.addLast(new ChunkedWriteHandler());
                        /*
                        * 说明:
                        * 1. http 数据在传输过程中是分段,HttpObjectAggregator 就是可以将多个段聚合
                        * 2. 这就是为什么当浏览器发送大量数据时,就会发出多次 http 请求
                        * */
                        pipeline.addLast(new HttpObjectAggregator(8192));
                        /*
                        * 说明:
                        * 1. 对应 websocket, 它的数据是以 帧(frame) 形式传递
                        * 2. 可以看到 WebSocketFrame 下面有六个子类
                        * 3. 浏览器请求时 ws://localhost:7000/hello 表示请求的 uri
                        * 4. WebSocketServerProtocolHandler 核心功能是将 http 协议升级为 ws 协议,保持长连接
                        * 5. 是通过一个状态码 101
                        * */
                        pipeline.addLast(new WebSocketServerProtocolHandler("/hello"));
                        //自定义的 handler,处理业务连接
                        pipeline.addLast(new WebSocketFrameHandler());
                    }
                });
        //启动服务器
        ChannelFuture channelFuture = sbs.bind(7000).sync();
        channelFuture.channel().closeFuture().sync();
    } finally {
        bossGroup.shutdownGracefully();
        workerGroup.shutdownGracefully();
    }
    }

}

​ 服务端自定义 handler:

package com.pengtxyl.netty.netty.websocket;

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.websocketx.TextWebSocketFrame;

import java.time.LocalDateTime;

// 这里 TextWebSocketFrame 类型,表示一个文本帧(frame)
public class WebSocketFrameHandler extends SimpleChannelInboundHandler<TextWebSocketFrame> {
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {
        System.out.println("服务器接收信息: " + msg.text());

        //回复消息
        ctx.channel().writeAndFlush(new TextWebSocketFrame("服务器时间 " + LocalDateTime.now() + " : " + msg.text()));
    }

    //当 web 客户端连接后,触发该方法
    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
        //id 表示唯一的值,LongText 是唯一的,ShortText 不是唯一的
        System.out.println("handlerAdded 被调用, LongText: " + ctx.channel().id().asLongText());
        System.out.println("handlerAdded 被调用, ShortText: " + ctx.channel().id().asShortText());
    }

    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {
        System.out.println("handlerRemoved 被调用, LongText: " + ctx.channel().id().asLongText());
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        System.out.println("异常发生 " + cause.getMessage());
        ctx.close(); //关闭
    }
}

​ 页面代码:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

    <form onsubmit="return false">
        <textarea name="message" style="height: 300px; width: 300px"></textarea>
        <input type="button" value="发送消息" onclick="send(this.form.message.value)">
        <textarea id="responseText" style="height: 300px; width: 300px"></textarea>
        <input type="button" value="清空内容" onclick="document.getElementById('responseText').value=''">
    </form>

    <script>
        var socket;
        //判断当前浏览器是否支持 websocket
        if(window.WebSocket){
            socket = new WebSocket("ws://localhost:7000/hello");
            //相当于 channelRead0,ev 表示收到服务器端回送的消息
            socket.onmessage = function (ev) {
                var rt = document.getElementById("responseText");
                rt.value = rt.value + "\n" + ev.data;
            }

            //相当于连接开启(感知到连接开启)
            socket.onopen = function (ev) {
                var rt = document.getElementById("responseText");
                rt.value = "连接开始了..."
            }

            //相当于连接关闭(感知到连接关闭)
            socket.onclose = function (ev) {
                var rt = document.getElementById("responseText");
                rt.value = rt.value + "\n" + "连接关闭了..."
            }
        } else {
            alert("当前浏览器不支持websocket...")
        }

        function send(message) {
            if(!window.socket) {  //先判断socket 是否创建好
                return ;
            }
            if(socket.readyState == WebSocket.OPEN){
                //通过 socket 发送消息
                socket.send(message);
            } else {
                alert("连接没有开启...")
            }
        }
    </script>

</body>
</html>

七、Google Protobuf

1、编码和解码的基本介绍

1)、编写网络应用程序时, 因为数据在网络中传输的都是二进制字节码数据, 在发送数据时就需要编码, 接收数

​ 据时就需要解码 [示意图]

2)、codec(编解码器) 的组成部分有两个: decoder(解码器)和 encoder(编码器)。 encoder 负责把业务数据转换

​ 成字节码数据, decoder 负责把字节码数据转换成业务数据

在这里插入图片描述

2、Netty 本身的编码解码的机制和问题分析

1)、Netty 自身提供了一些 codec(编解码器)

2)、Netty 提供的编码器

​ StringEncoder, 对字符串数据进行编码

​ ObjectEncoder, 对 Java 对象进行编码

​ …

3)、Netty 提供的解码器

​ StringDecoder, 对字符串数据进行解码

​ ObjectDecoder, 对 Java 对象进行解码

​ …

4)、Netty 本身自带的 ObjectDecoder 和 ObjectEncoder 可以用来实现 POJO 对象或各种业务对象的编码和解

​ 码, 底层使用的仍是 Java 序列化技术 , 而 Java 序列化技术本身效率就不高, 存在如下问题:

​ ■ 无法跨语言

​ ■ 序列化后的体积太大, 是二进制编码的 5 倍多

​ ■ 序列化性能太低

5)、引出 新的解决方案 [Google 的 Protobuf]

3、Protobuf

1)、Protobuf 基本介绍和使用示意图

2)、Protobuf 是 Google 发布的开源项目, 全称 Google Protocol Buffers, 是一种轻便高效的结构化数据存储格

​ 式,可以用于结构化数据串行化, 或者说序列化。 它很适合做数据存储

​ 或 RPC[远程过程调用 remote procedurecall ] 数据交换格式

​ 目前很多公司 http+json —> tcp+protobuf

3)、参考文档 : https://developers.google.com/protocol-buffers/docs/proto 语言指南

4)、Protobuf 是以 message 的方式来管理数据的

5)、支持跨平台、 跨语言, 即[客户端和服务器端可以是不同的语言编写的] (支持目前绝大多数语言, 例如

​ C++、C#、 Java、 python 等)

6)、高性能, 高可靠性

7)、使用 protobuf 编译器能自动生成代码, Protobuf 是将类的定义使用 .proto 文件进行描述。 说明, 在 idea

​ 中编写 .proto 文件时, 会自动提示是否下载 .ptotot 编写插件,可以让语法高亮。

8)、然后通过 protoc.exe 编译器根据.proto 自动生成.java 文件

9)、protobuf 使用示意图

在这里插入图片描述

4、Protobuf 快速入门实例1

编写程序, 使用 Protobuf 完成如下功能

1)、客户端可以发送一个 Student PoJo 对象到服务器 (通过 Protobuf 编码)

2)、服务端能接收 Student PoJo 对象, 并显示信息(通过 Protobuf 解码)

3)、具体看演示步骤

​ ■ 将之前 netty.simple 包下面的四个类拷贝到 netty.codec 包下面

​ ■ 使用 protobuf 之前,需要在 idea 中安装 protobuf 插件。具体步骤:

​ 点击 settings -> plugins -> 安装 protobuf,搜索 protobuf,选择 Protobuf Support 进行安装

​ ■ 在 pom.xml 中加入如下依赖:

        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>3.6.1</version>
        </dependency>

​ ■ 新建 Student.proto 文件,内容如下

syntax = "proto3";  //版本
option java_outer_classname = "StudentPOJO";    //生成的外部类名,同时也是文件名
//protobuf 使用 message 管理数据
message Student {   //会在 StudentPOJO 外部类生成一个内部类 Student,它是真正发送的 POJO 对象
    int32 id = 1;   //Student 类中有一个属性名字为 id,类型为 int32(protobuf类型)。1 表示属性序号,不是具体值
    string name = 2;
}

​ ■ 在 protobuf 官网下载 protoc.exe,此工具能对上面创建的 proto 文件进行编译,这里已经下载好了,存放在

​ D:\software\java\protobuf 目录下。

​ ■ 编译上面创建的 Student.proto 文件,操作如下:

​ □ 将 protoc.exe 目录下的其他文件先删除,只保留 protoc.exe 工具

​ □ 将 Student.proto 文件保存在 protoc.exe 目录下,或者将 protoc.exe 保存在 Student.proto 文件夹下

​ □ 在 protoc.exe 目录下将 cmd 窗口打开

​ □ 输入内容如下:

protoc.exe --java_out=. Student.proto	#注意等号左边和右边的写法

在这里插入图片描述

​ □ 编译完成之后会在当前目录下生产 StudentPOJO.java 文件,将此文件拷贝到相应的项目目录下

​ ■ 修改 NettyClientHandler 类中的 channelActive 方法,如下:

package com.pengtxyl.netty.netty.codec;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

public class NettyClientHandler extends ChannelInboundHandlerAdapter{

    //当通道就绪就会触发该方法
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        //发送一个 Student 对象到服务器
        StudentPOJO.Student student = StudentPOJO.Student.newBuilder().setId(4).setName("豹子头 林冲").build();
        ctx.writeAndFlush(student);
    }

    //当通道有读取事件时,会触发
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        ByteBuf buf = (ByteBuf) msg;
        System.out.println("服务器回复的消息: " + buf.toString(CharsetUtil.UTF_8));
        System.out.println("服务器的地址: " + ctx.channel().remoteAddress());
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}

​ ■ 在 NettyClient 类中修改如下:在 pipeline 中加入 ProtoBufEncoder

package com.pengtxyl.netty.netty.codec;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.protobuf.ProtobufEncoder;

public class NettyClient {

    public static void main(String[] args) throws InterruptedException {
        //客户端需要一个事件循环组
        EventLoopGroup group = new NioEventLoopGroup();

        try {
            //创建客户端启动对象
            //注意客户端使用的不是 ServerBootstrap, 而是 Bootstrap
            Bootstrap bootstrap = new Bootstrap();

            //设置相关参数
            bootstrap.group(group) //设置线程组
                    .channel(NioSocketChannel.class)   //设置客户端通道的实现类(反射)
                    .handler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ChannelPipeline pipeline = ch.pipeline();
                            //在 pipeline 中加入 ProtoBufEncoder
                            pipeline.addLast("encoder", new ProtobufEncoder());
                            pipeline.addLast(new NettyClientHandler());   //加入自己的处理器
                        }
                    });

            System.out.println("客户端 ok ...");

            //启动客户端去连接服务器端
            //关于 ChannelFuture 要分析,涉及到 netty 的异步模型
            ChannelFuture channelFuture = bootstrap.connect("127.0.0.1", 6668).sync();

            //给关闭通道进行监听
            channelFuture.channel().closeFuture().sync();
        } finally {
            group.shutdownGracefully();
        }
    }

}

​ ■ 在 NettyServer 中修改:在 pipeline 加入 ProtoBufDecoder,并指定哪种对象进行解码

package com.pengtxyl.netty.netty.codec;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.protobuf.ProtobufDecoder;

public class NettyServer {

    public static void main(String[] args) throws InterruptedException {

        //创建 BossGroup 和 WorkerGroup
        //说明:
        //1. 创建两个线程组 bossGroup 和 workerGroup
        //2. bossGroup 只是处理连接请求,真正的和客户端业务处理会交给 workerGroup 完成
        //3. 两个都是无限循环
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {

            //创建服务器端的启动对象,配置参数
            ServerBootstrap bootstrap = new ServerBootstrap();

            //使用链式编程来进行设置
            bootstrap.group(bossGroup, workerGroup) //设置两个线程组
                    .channel(NioServerSocketChannel.class)   //使用NioSocketChannel 作为服务器的通道实现
                    .option(ChannelOption.SO_BACKLOG, 128) //设置线程队列得到连接个数
                    .childOption(ChannelOption.SO_KEEPALIVE, true) //设置保持活动连接状态
                    .childHandler(new ChannelInitializer<SocketChannel>() {    //创建一个通道测试对象(匿名对象)
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ChannelPipeline pipeline = ch.pipeline();
                            //在 pipeline 加入 ProtoBufDecoder,并指定哪种对象进行解码
                            pipeline.addLast("decoder", new ProtobufDecoder(StudentPOJO.Student.getDefaultInstance()));
                            pipeline.addLast(new NettyServerHandler());
                        }
                    });     //给 workerGroup 的 EventLoop 对应的管道设置处理器

            System.out.println(".....服务器 is ready .....");

            //绑定一个端口并且同步,生成了一个 ChannelFuture 对象
            //启动服务器(并绑定端口)
            ChannelFuture cf = bootstrap.bind(6668).sync();

            //给 cf 注册监听器,监听我们关心的事件
            cf.addListener(new ChannelFutureListener() {
                @Override
                public void operationComplete(ChannelFuture future) throws Exception {
                    if(cf.isSuccess()){
                        System.out.println("监听端口 6668 成功");
                    } else {
                        System.out.println("监听端口 6668 失败");
                    }
                }
            });

            //对关闭通道进行监听
            cf.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }

    }

}

​ ■ 在 NettyServerHandler 文件中修改 channelRead 方法,如下:

package com.pengtxyl.netty.netty.codec;

import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

import java.util.concurrent.TimeUnit;

/*
* 说明:
* 1. 我们自定义一个 Handler 需要继承 netty 规定好的某个 HandlerAdapter(规范)
* 2. 这时我们自定义一个 Handler,才能成为一个 handler
* */
public class NettyServerHandler extends ChannelInboundHandlerAdapter {

    //读取数据事件(这里我们可以读取客户端发送的消息)
    /*
    * 1. ChannelHandlerContext ctx: 上下文对象,含有管道 Pipeline, 通道 channel, 地址 等
    * 2. Object msg: 就是客户端发送的数据,默认 Object
    * */
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        //读取从客户端发送的 StudentPojo.Student
        StudentPOJO.Student student = (StudentPOJO.Student) msg;
        System.out.println("客户端发送的数据 id= " + student.getId() + ", 名字= " + student.getName());
    }

    //数据读取完毕
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        //writeAndFlush 是 write + flush
        //将数据写入到缓存,并刷新
        //一般讲,我们对这个发送的数据进行编码
        ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端~", CharsetUtil.UTF_8));
    }

    //处理异常,一般是需要关闭通道

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }
}

​ ■ 启动服务端,再启动客户端,可以看到数据传输正确

​ ■ 我们也可以让 NettyServerHandler 类继承自 SimpleChannelInboundHandler,然后泛型传入

​ StudentPOJO.Student,这样我们就可以直接使用 StudentPOJO.Student 这个类了,不需要强转了

//public class NettyServerHandler extends ChannelInboundHandlerAdapter {
public class NettyServerHandler extends SimpleChannelInboundHandler<StudentPOJO.Student> {

    //直接使用,不需要强转
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, StudentPOJO.Student msg) throws Exception {

    }

5、Protobuf 快速入门实例2

​ 当我们需要传输的数据类型不止一个,而是多个时,上面的用法就不是很合适,我们可以使用下面的方式

1)、编写程序, 使用 Protobuf 完成如下功能

2)、客户端可以随机发送 Student PoJo/ Worker PoJo 对象到服务器 (通过 Protobuf 编码)

3)、服务端能接收 Student PoJo/ Worker PoJo 对象(需要判断是哪种类型), 并显示信息(通过 Protobuf 解码)

4)、具体看演示步骤

​ ■ 同样将 netty.simple 包下的四个类拷贝到 codec2 包下,其余的步骤和前面一样

​ ■ 在 codec2 包下创建 Student.proto,内容如下:

syntax = "proto3";
option optimize_for = SPEED;    //加快解析
option java_package="com.pengtxyl.netty.codec2";    //指定生成到哪个包下
option java_outer_classname="MyDataInfo";   //外部类名

//protobuf 可以使用 message 管理其他的 message
message MyMessage{
    //定义一个枚举类型
    enum DataType{
        StudentType = 0;    //在 proto3 要求 enum 的编号从0开始
        WorkerType = 1;
    }

    //用 data_type 来标识传入的是哪一个枚举类型
    DataType data_type = 1;

    //表示每次枚举类型最多只能出现其中的一个,节省空间
    oneof dataBody{
        Student student = 2;
        Worker worker = 3;
    }
//    Student student = 2;
//    Worker worker = 3;
}

message Student{
    int32 id = 1;   //Student类的属性
    string name = 2;
}

message Worker{
    string name = 1;
    int32 age = 2;
}

​ ■ 同样使用 protoc.exe 进行编译,跟之前一样,先删除 protoc.exe 其余文件,以免冲突。然后进行编译

在这里插入图片描述

​ ■ 编译完成以后,会生成 com.pengtxyl.netty.codec2.MyDataInfo.java 文件,并拷贝到 netty.codec2 包下,

​ com.pengtxyl.netty.codec2 路径是之前 Student.proto 文件中指定的包路径

​ ■ 修改 NettyClientHandler 类中 channelActive 方法

package com.pengtxyl.netty.netty.codec2;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;

import java.util.Random;

public class NettyClientHandler extends ChannelInboundHandlerAdapter{

    //当通道就绪就会触发该方法
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        //随机地发送 Student 或者 Worker 对象
        int random = new Random().nextInt();
        MyDataInfo.MyMessage myMessage = null;

        if(0 == random){    //发送 Student 对象
            myMessage = MyDataInfo.MyMessage.newBuilder()
                    .setDataType(MyDataInfo.MyMessage.DataType.StudentType)
                    .setStudent(MyDataInfo.Student.newBuilder().setId(5)
                            .setName("玉麒麟 卢俊义").build()).build();
        } else {    //发送一个 Worker 对象
            myMessage = MyDataInfo.MyMessage.newBuilder()
                    .setDataType(MyDataInfo.MyMessage.DataType.WorkerType)
                    .setWorker(MyDataInfo.Worker.newBuilder().setAge(20)
                            .setName("老李").build()).build();
        }
        ctx.writeAndFlush(myMessage);
    }

    //当通道有读取事件时,会触发
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        ByteBuf buf = (ByteBuf) msg;
        System.out.println("服务器回复的消息: " + buf.toString(CharsetUtil.UTF_8));
        System.out.println("服务器的地址: " + ctx.channel().remoteAddress());
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}

​ ■ 修改 NettyServer 中 ProtobufDecoder 类的传入参数

package com.pengtxyl.netty.netty.codec2;

import com.pengtxyl.netty.netty.codec.StudentPOJO;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.protobuf.ProtobufDecoder;

public class NettyServer {

    public static void main(String[] args) throws InterruptedException {

        //创建 BossGroup 和 WorkerGroup
        //说明:
        //1. 创建两个线程组 bossGroup 和 workerGroup
        //2. bossGroup 只是处理连接请求,真正的和客户端业务处理会交给 workerGroup 完成
        //3. 两个都是无限循环
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {

            //创建服务器端的启动对象,配置参数
            ServerBootstrap bootstrap = new ServerBootstrap();

            //使用链式编程来进行设置
            bootstrap.group(bossGroup, workerGroup) //设置两个线程组
                    .channel(NioServerSocketChannel.class)   //使用NioSocketChannel 作为服务器的通道实现
                    .option(ChannelOption.SO_BACKLOG, 128) //设置线程队列得到连接个数
                    .childOption(ChannelOption.SO_KEEPALIVE, true) //设置保持活动连接状态
                    .childHandler(new ChannelInitializer<SocketChannel>() {    //创建一个通道测试对象(匿名对象)
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ChannelPipeline pipeline = ch.pipeline();
                            //在 pipeline 加入 ProtoBufDecoder,并指定哪种对象进行解码
                            pipeline.addLast("decoder", new ProtobufDecoder(MyDataInfo.MyMessage.getDefaultInstance()));
                            pipeline.addLast(new NettyServerHandler());
                        }
                    });     //给 workerGroup 的 EventLoop 对应的管道设置处理器

            System.out.println(".....服务器 is ready .....");

            //绑定一个端口并且同步,生成了一个 ChannelFuture 对象
            //启动服务器(并绑定端口)
            ChannelFuture cf = bootstrap.bind(6668).sync();

            //给 cf 注册监听器,监听我们关心的事件
            cf.addListener(new ChannelFutureListener() {
                @Override
                public void operationComplete(ChannelFuture future) throws Exception {
                    if(cf.isSuccess()){
                        System.out.println("监听端口 6668 成功");
                    } else {
                        System.out.println("监听端口 6668 失败");
                    }
                }
            });

            //对关闭通道进行监听
            cf.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }

    }

}

​ ■ 修改 NettyServerHandler 类的继承关系为 SimpleChannelInboundHandler<MyDataInfo.MyMessage>,并

​ 且重写 channelRead0 方法

package com.pengtxyl.netty.netty.codec2;

import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.util.CharsetUtil;

import java.util.concurrent.TimeUnit;

/*
* 说明:
* 1. 我们自定义一个 Handler 需要继承 netty 规定好的某个 HandlerAdapter(规范)
* 2. 这时我们自定义一个 Handler,才能成为一个 handler
* */
public class NettyServerHandler extends SimpleChannelInboundHandler<MyDataInfo.MyMessage> {

    //读取数据事件(这里我们可以读取客户端发送的消息)
    /*
    * 1. ChannelHandlerContext ctx: 上下文对象,含有管道 Pipeline, 通道 channel, 地址 等
    * 2. Object msg: 就是客户端发送的数据,默认 Object
    * */
    @Override
    public void channelRead0(ChannelHandlerContext ctx, MyDataInfo.MyMessage msg) throws Exception {
        //根据 dataType 来显示不同的信息
        MyDataInfo.MyMessage.DataType dataType = msg.getDataType();
        if(dataType == MyDataInfo.MyMessage.DataType.StudentType){
            MyDataInfo.Student student = msg.getStudent();
            System.out.println("学生id= " + student.getId() + ", 学生名字= " + student.getName());
        } else if(dataType == MyDataInfo.MyMessage.DataType.WorkerType){
            MyDataInfo.Worker worker = msg.getWorker();
            System.out.println("工人的名字= " + worker.getName() + ", 年龄= " + worker.getAge());
        } else {
            System.out.println("传输的类型不正确");
        }
    }

    //数据读取完毕
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        //writeAndFlush 是 write + flush
        //将数据写入到缓存,并刷新
        //一般讲,我们对这个发送的数据进行编码
        ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端~", CharsetUtil.UTF_8));
    }

    //处理异常,一般是需要关闭通道

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }
}

​ ■ 分别启动 NettyServer 和 NettyClient,可以看到数据发送成功

八、Netty 编解码器和 handler 的调用机制

1、基本说明

1)、netty 的组件设计: Netty 的主要组件有 Channel、 EventLoop、 ChannelFuture、 ChannelHandler、

​ ChannelPipe 等

2)、ChannelHandler 充当了处理入站和出站数据的应用程序逻辑的容器。 例如, 实现

​ ChannelInboundHandler 接口(或ChannelInboundHandlerAdapter) , 你就可以接收入站事件和数据,

​ 这些数据会被业务逻辑处理。 当要给客户端发 送 响 应 时 , 也 可 以 从 ChannelInboundHandler 冲 刷 数

​ 据 。 业 务 逻 辑 通 常 写 在 一 个 或 者 多 个ChannelInboundHandler 中。 ChannelOutboundHandler 原

​ 理一样, 只不过它是用来处理出站数据的

3)、ChannelPipeline 提供了 ChannelHandler 链的容器。 以客户端应用程序为例, 如果事件的运动方向是从客

​ 户端到服务端的, 那么我们称这些事件为出站的, 即客户端发送给服务端的数据会通过 pipeline 中的一系列

​ ChannelOutboundHandler, 并被这些 Handler 处理, 反之则称为入站的

在这里插入图片描述

2、编码解码器

1)、当 Netty 发送或者接受一个消息的时候, 就将会发生一次数据转换。 入站消息会被解码: 从字节转换为另一

​ 种格式(比如 java 对象) ; 如果是出站消息, 它会被编码成字节

2)、Netty 提供一系列实用的编解码器, 他们都实现了 ChannelInboundHadnler 或者

​ ChannelOutboundHandler接口。在这些类中, channelRead 方法已经被重写了。 以入站为例, 对于每个

​ 从入站 Channel 读取的消息, 这个方法会被调用。 随后, 它将调用由解码器所提供的 decode()方法进行解

​ 码, 并将已经解码的字节转发给 ChannelPipeline中的下一个 ChannelInboundHandler。

3、解码器-ByteToMessageDecoder

  1. 关系继承图

在这里插入图片描述

2)、由于不可能知道远程节点是否会一次性发送一个完整的信息, tcp 有可能出现粘包拆包的问题, 这个类会对

​ 入站数据进行缓冲, 直到它准备好被处理.

3)、一个关于 ByteToMessageDecoder 实例分析

在这里插入图片描述

4、Netty 的 handler 链的调用机制

​ 实例要求:

1)、使用自定义的编码器和解码器来说明 Netty 的 handler 调用机制

​ 客户端发送 long -> 服务器

​ 服务端发送 long -> 客户端

2)、代码

​ 服务端代码:

​ MyServer 类:

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.server;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;

public class MyServer {

    public static void main(String[] args) throws Exception {
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            serverBootstrap
                    .group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new MyServerInitializer());    //自定义一个初始化类

            ChannelFuture channelFuture = serverBootstrap.bind(7777).sync();
            channelFuture.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }

}

​ MyServerInitializer 类

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.server;

import com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.client.MyLongToByteEncode;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;

public class MyServerInitializer extends ChannelInitializer<SocketChannel> {

    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();

        //入站的 handler 进行解码 MyByteToLongDecoder
        //pipeline.addLast(new MyByteToLongDecoder());
        pipeline.addLast(new MyByteToLongDecoder2());

        //出站的 handler 进行编码
        pipeline.addLast(new MyLongToByteEncode());

        //自定义的 handler 处理业务逻辑
        pipeline.addLast(new MyServerHandler());
    }
}

​ MyServerHandler 类:

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.server;

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;

/**
 * @author 86130
 * @date 2020/5/26 21:07
 */
public class MyServerHandler extends SimpleChannelInboundHandler<Long> {
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, Long msg) throws Exception {
        System.out.println("从客户端 " + ctx.channel().remoteAddress() + " 读取到 long 数据: " + msg);
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}

​ MyByteToLongDecoder 类:

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.server;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ByteToMessageDecoder;

import java.util.List;

public class MyByteToLongDecoder extends ByteToMessageDecoder {
    
    /**
     * @param ctx:上下文对象
     * @param in:入站的 ByteBuf
     * @param out:List 集合,将解码后的数据传给下一个 handler
     * @return
     * @throws
     * @author 86130
     * @date   2020/5/26 21:05
     */
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        System.out.println("MyByteToLongDecoder 被调用");
        //因为 long 8 个字节,需要判断有 8 个字节,才能读取一个 long
        if(in.readableBytes() >= 8) {
            out.add(in.readLong());
        }
    }
}

​ 客户端类:

​ MyClient 类:

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.client;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioSocketChannel;

/**
 * @author 86130
 * @date 2020/5/26 21:09
 */
public class MyClient {

    public static void main(String[] args) throws Exception{
        EventLoopGroup group = new NioEventLoopGroup();

        try {
            Bootstrap bootstrap = new Bootstrap();
            bootstrap
                    .group(group)
                    .channel(NioSocketChannel.class)
                    .handler(new MyClientInitializer()); //自定义一个初始化类

            ChannelFuture channelFuture = bootstrap.connect("localhost", 7777).sync();
            channelFuture.channel().closeFuture().sync();
        } finally {
            group.shutdownGracefully();
        }
    }
}

​ MyClientInitializer 类:

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.client;

import com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.server.MyByteToLongDecoder;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;

/**
 * @author 86130
 * @date 2020/5/26 21:13
 * @desc 描述:
 */
public class MyClientInitializer extends ChannelInitializer<SocketChannel>{
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();

        //加入一个出站的 handler 对数据进行一个编码
        pipeline.addLast(new MyLongToByteEncode());

        //这是一个入站的解码器(入站的 handler)
        //pipeline.addLast(new MyByteToLongDecoder());
        pipeline.addLast(new MyByteToLongDecoder2());

        //加入一个自定义的 handler,处理业务
        pipeline.addLast(new MyClientHandler());
    }
}

​ MyClientHandler 类:

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.client;

import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.util.CharsetUtil;

/**
 * @author 86130
 * @date 2020/5/26 21:28
 * @desc 描述:
 */
public class MyClientHandler extends SimpleChannelInboundHandler<Long> {
    @Override
    protected void channelRead0(ChannelHandlerContext ctx, Long msg) throws Exception {
        System.out.println("服务器的ip = " + ctx.channel().remoteAddress());
        System.out.println("收到服务器消息 = " + msg);
    }

    //重写 channelActive 发送数据
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        System.out.println("MyClientHandler 发送数据");
        //ctx.writeAndFlush(Unpooled.copiedBuffer("")
        ctx.writeAndFlush(123456L); //发送的是一个 long

        //分析
        //1、"abcdabcdabcdabcdabcd" 是16个字节
        //2、该处理器的前一个 handler 是 MyLongToByteEncoder
        //3、MyLongToByteEncode 父类 MessageToByteEncoder
        //4、父类 MessageToByteEncoder
        /*
        public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
        ByteBuf buf = null;
        try {
            if (acceptOutboundMessage(msg)) {   //判断当前 msg 是不是应该处理的类型,如果是就处理,
                                                //不是就跳过 encode
                @SuppressWarnings("unchecked")
                I cast = (I) msg;
                buf = allocateBuffer(ctx, cast, preferDirect);
                try {
                    encode(ctx, cast, buf);
                } finally {
                    ReferenceCountUtil.release(cast);
                }

                if (buf.isReadable()) {
                    ctx.write(buf, promise);
                } else {
                    buf.release();
                    ctx.write(Unpooled.EMPTY_BUFFER, promise);
                }
                buf = null;
            } else {
                ctx.write(msg, promise);
            }
         */
        //5、因此我们编写 Encoder 时要注意传入的数据类型和处理的数据类型一致
        //ctx.writeAndFlush(Unpooled.copiedBuffer("abcdabcdabcdabcd", CharsetUtil.UTF_8));
    }
}

​ MyLongToByteEncode 类:

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.client;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;

/**
 * @author 86130
 * @date 2020/5/26 21:26
 * @desc 描述:
 */
public class MyLongToByteEncode extends MessageToByteEncoder<Long> {
    //编码方法
    @Override
    protected void encode(ChannelHandlerContext ctx, Long msg, ByteBuf out) throws Exception {
        System.out.println("MyLongToByteEncoder encode 被调用");
        System.out.println("msg = " + msg);
        out.writeLong(msg);
    }
}


3)、案例演示 ,先启动 MyServer 类,再启动 MyClient 类

在这里插入图片描述

4)、结论

​ 不论解码器 handler 还是编码器 handler 即接收的消息类型必须与待处理的消息类型一致,否则该 handler 不

​ 会被执行

​ 在解码器进行数据解码时,需要判断缓存区(ByteBuf)的数据是否足够,否则接收到的结果会期望结果可能不一

​ 致

5、解码器-ReplayingDecoder

1)、public abstract class ReplayingDecoder extends ByteToMessageDecoder

2)、ReplayingDecoder 扩展了 ByteToMessageDecoder 类, 使用这个类, 我们不必调用 readableBytes()方

​ 法。参数 S 指定了用户状态管理的类型, 其中 Void 代表不需要状态管理

3)、应用实例: 使用 ReplayingDecoder 编写解码器, 对前面的案例进行简化 [案例演示]

​ 只需将前面案例中的 MyServerInitializer 类的 initChannel 方法中的

​ pipeline.addLast(new MyByteToLongDecoder());

​ 换成 pipeline.addLast(new MyByteToLongDecoder2());

​ 将 MyClientInitializer 类中的 initChannel 方法中的

​ pipeline.addLast(new MyByteToLongDecoder());

​ 换成 pipeline.addLast(new MyByteToLongDecoder2());

package com.pengtxyl.netty.netty.inboundhandlerandoutboundhandler.decoder;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ReplayingDecoder;

import java.util.List;

/**
 * @author 86130
 * @date 2020/5/27 21:44
 * @desc 描述:
 */
public class MyByteToLongDecoder2 extends ReplayingDecoder<Void>{
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        System.out.println("MyByteToLongDecoder2 被调用");
        //在 ReplayingDecoder 中不需要判断数据是否足够读取,内部会进行处理判断
        //if(in.readableBytes() >= 8) {
            out.add(in.readLong());
        //}
    }
}

4)、ReplayingDecoder 使用方便, 但它也有一些局限性:

  1. 并 不 是 所 有 的 ByteBuf 操 作 都 被 支 持 , 如 果 调 用 了 一 个 不 被 支 持 的 方 法 , 将 会 抛 出 一 个

​ UnsupportedOperationException。

  1. ReplayingDecoder 在某些情况下可能稍慢于 ByteToMessageDecoder, 例如网络缓慢并且消息格式复杂

​ 时,消息会被拆成了多个碎片, 速度变慢

6、其它编解码器

①、其它解码器

1)、LineBasedFrameDecoder: 这个类在 Netty 内部也有使用, 它使用行尾控制字符(\n 或者\r\n) 作为分隔

​ 符来解析数据。

2)、DelimiterBasedFrameDecoder: 使用自定义的特殊字符作为消息的分隔符。

3)、HttpObjectDecoder: 一个 HTTP 数据的解码器

4)、LengthFieldBasedFrameDecoder:通过指定长度来标识整包消息,这样就可以自动的处理黏包和半包消。

②、其它编码器

在这里插入图片描述

7、Log4j 整合到 Netty

1)、在 Maven 中添加对 Log4j 的依赖 在 pom.xml

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.25</version>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.25</version>
    <scope>test</scope>
</dependency>

2)、配置 Log4j , 在 resources/log4j.properties

​ log4j.rootLogger=DEBUG, stdout

​ log4j.appender.stdout=org.apache.log4j.ConsoleAppender

​ log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

​ log4j.appender.stdout.layout.ConversionPattern=[%p] %C{1} - %m%n

3)、演示整合

在这里插入图片描述

九、TCP 粘包和拆包 及解决方案

1、TCP 粘包和拆包基本介绍

1)、TCP 是面向连接的, 面向流的, 提供高可靠性服务。 收发两端(客户端和服务器端) 都要有一一成对的

​ socket,因此,发送端为了将多个发给接收端的包,更有效的发给对方,使用了优化方法(Nagle 算法),

​ 将多次间隔较小且数据量小的数据, 合并成一个大的数据块, 然后进行封包。 这样做虽然提高了效率, 但

​ 是接收端就难于分辨出完整的数据包了, 因为面向流的通信是无消息保护边界的

2)、由于 TCP 无消息保护边界, 需要在接收端处理消息边界问题, 也就是我们所说的粘包、 拆包问题, 看一张图

3)、示意图 TCP 粘包、 拆包图解

在这里插入图片描述

​ 对图的说明:

​ 假设客户端分别发送了两个数据包 D1 和 D2 给服务端, 由于服务端一次读取到字节数是不确定的, 故可能

​ 存在以下四种情况:

​ 1)、服务端分两次读取到了两个独立的数据包, 分别是 D1 和 D2, 没有粘包和拆包

​ 2)、服务端一次接受到了两个数据包, D1 和 D2 粘合在一起, 称之为 TCP 粘包

​ 3)、服务端分两次读取到了数据包, 第一次读取到了完整的 D1 包和 D2 包的部分内容, 第二次读取到了

​ D2 包的剩余内容, 这称之为 TCP 拆包

​ 4)、服务端分两次读取到了数据包, 第一次读取到了 D1 包的部分内容 D1_1, 第二次读取到了 D1 包的剩

​ 余部分内容 D1_2 和完整的 D2 包。

2、TCP 粘包和拆包现象实例

在编写 Netty 程序时, 如果没有做处理, 就会发生粘包和拆包的问题

看一个具体的实例:

​ 服务端代码:

​ MyServer 类:

package com.pengtxyl.netty.netty.tcp;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;

public class MyServer {

    public static void main(String[] args) throws Exception {
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            serverBootstrap
                    .group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new MyServerInitializer());    //自定义一个初始化类

            ChannelFuture channelFuture = serverBootstrap.bind(7777).sync();
            channelFuture.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }

}

​ MyServerHandler 类:

package com.pengtxyl.netty.netty.tcp;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;

import java.nio.charset.Charset;
import java.util.UUID;

/**
 * @author 86130
 * @date 2020/5/27 21:58
 * @desc 描述:
 */
public class MyServerHandler extends SimpleChannelInboundHandler<ByteBuf> {

    private int count;

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
        byte[] buffer = new byte[msg.readableBytes()];
        msg.readBytes(buffer);

        //将 buffer 转成字符串
        String message = new String(buffer, Charset.forName("utf-8"));

        System.out.println("服务器接收到数据: " + message);
        System.out.println("服务器接收到消息量: " + (++this.count));

        //服务器回送数据给客户端,回送一个随机 id
        ByteBuf responseByteBuf = Unpooled.copiedBuffer(UUID.randomUUID().toString() + " ", Charset.forName("utf-8"));
        ctx.writeAndFlush(responseByteBuf);

    }
}

​ MyServerInitializer 类:

package com.pengtxyl.netty.netty.tcp;

import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;

/**
 * @author 86130
 * @date 2020/5/27 21:57
 * @desc 描述:
 */
public class MyServerInitializer extends ChannelInitializer<SocketChannel> {
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        pipeline.addLast(new MyServerHandler());
    }
}

​ 客户端代码:

​ MyClient 类:

package com.pengtxyl.netty.netty.tcp;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioSocketChannel;

/**
 * @author 86130
 * @date 2020/5/26 21:09
 */
public class MyClient {

    public static void main(String[] args) throws Exception{
        EventLoopGroup group = new NioEventLoopGroup();

        try {
            Bootstrap bootstrap = new Bootstrap();
            bootstrap
                    .group(group)
                    .channel(NioSocketChannel.class)
                    .handler(new MyClientInitializer()); //自定义一个初始化类

            ChannelFuture channelFuture = bootstrap.connect("localhost", 7777).sync();
            channelFuture.channel().closeFuture().sync();
        } finally {
            group.shutdownGracefully();
        }
    }
}

​ MyClientHandler 类:

package com.pengtxyl.netty.netty.tcp;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;

import java.nio.charset.Charset;

/**
 * @author 86130
 * @date 2020/5/27 21:53
 * @desc 描述:
 */
public class MyClientHandler extends SimpleChannelInboundHandler<ByteBuf> {

    private int count = 0;

    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        //使用客户端发送10条数据 hello, server
        for (int i = 0; i < 10; i++) {
            ByteBuf buffer = Unpooled.copiedBuffer("hello, server" + i + "||", Charset.forName("utf-8"));
            ctx.writeAndFlush(buffer);
        }
    }

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
        byte[] buffer = new byte[msg.readableBytes()];
        msg.readBytes(buffer);

        String message = new String(buffer, Charset.forName("utf-8"));
        System.out.println("客户端接收到消息: " + message);
        System.out.println("客户端接收消息数量: " + (++this.count));
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}

​ MyClientInitializer 类:

package com.pengtxyl.netty.netty.tcp;

import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;

/**
 * @author 86130
 * @date 2020/5/27 21:52
 * @desc 描述:
 */
public class MyClientInitializer extends ChannelInitializer<SocketChannel> {
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        pipeline.addLast(new MyClientHandler());
    }
}

​ 先启动服务端 MyServer 类,再启动客户端 MyClient 类,可以看到服务端的输入结果如下:

​ 可以看到服务端收到的消息并不是 10 次,只有3次,这就是 TCP 粘包的现象

在这里插入图片描述

3、TCP 粘包和拆包解决方案

1)、使用自定义协议 + 编解码器 来解决

2)、关键就是要解决 服务器端每次读取数据长度的问题, 这个问题解决, 就不会出现服务器多读或少读数据的问

​ 题, 从而避免的 TCP 粘包、 拆包 。

4、看一个具体的实例

1)、要求客户端发送 5 个 Message 对象, 客户端每次发送一个 Message 对象

2)、服务器端每次接收一个 Message, 分 5 次进行解码, 每读取到 一个 Message , 会回复一个 Message 对象 给

​ 客户端.

在这里插入图片描述

3)、代码演示

​ 服务端:

​ MyServer 类:

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;

public class MyServer {

    public static void main(String[] args) throws Exception {
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            serverBootstrap
                    .group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new MyServerInitializer());    //自定义一个初始化类

            ChannelFuture channelFuture = serverBootstrap.bind(7777).sync();
            channelFuture.channel().closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }
    }

}

​ MyServerHandler 类:

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;

import java.nio.charset.Charset;
import java.util.UUID;

/**
 * @author 86130
 * @date 2020/5/27 21:58
 * @desc 描述: 处理业务的 handler
 */
public class MyServerHandler extends SimpleChannelInboundHandler<MessageProtocol> {

    private int count;

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, MessageProtocol msg) throws Exception {

        //接收到数据,并处理
        int len = msg.getLen();
        byte[] content = msg.getContent();

        System.out.println("服务器接收到信息如下:");
        System.out.println("长度=" + len);
        System.out.println("内容=" + new String(content, Charset.forName("utf-8")));

        System.out.println("服务器接收到消息包数量=" + (++this.count));

        //回复消息
        String responseContent = UUID.randomUUID().toString();
        int responseLen = responseContent.getBytes("utf-8").length;
        byte[] responseContentBytes = responseContent.getBytes("utf-8");
        //构建一个协议包
        MessageProtocol messageProtocol = new MessageProtocol();
        messageProtocol.setLen(responseLen);
        messageProtocol.setContent(responseContentBytes);

        ctx.writeAndFlush(messageProtocol);
    }
}


​ MyServerInitializer 类:

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;

/**
 * @author 86130
 * @date 2020/5/27 21:57
 * @desc 描述:
 */
public class MyServerInitializer extends ChannelInitializer<SocketChannel> {
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        pipeline.addLast(new MyMessageDecoder());   //解码器
        pipeline.addLast(new MyMessageEncoder());   //编码器
        pipeline.addLast(new MyServerHandler());
    }
}


​ 客户端:

​ MyClient 类:

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioSocketChannel;

/**
 * @author 86130
 * @date 2020/5/26 21:09
 */
public class MyClient {

    public static void main(String[] args) throws Exception{
        EventLoopGroup group = new NioEventLoopGroup();

        try {
            Bootstrap bootstrap = new Bootstrap();
            bootstrap
                    .group(group)
                    .channel(NioSocketChannel.class)
                    .handler(new MyClientInitializer()); //自定义一个初始化类

            ChannelFuture channelFuture = bootstrap.connect("localhost", 7777).sync();
            channelFuture.channel().closeFuture().sync();
        } finally {
            group.shutdownGracefully();
        }
    }
}


​ MyClientHandler 类:

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;

import java.nio.charset.Charset;

/**
 * @author 86130
 * @date 2020/5/27 21:53
 * @desc 描述:
 */
public class MyClientHandler extends SimpleChannelInboundHandler<MessageProtocol> {

    private int count = 0;

    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        //使用客户端发送10条数据 "今天天气冷,吃火锅"
        for (int i = 0; i < 5; i++) {
            String mes = "今天天气冷,吃火锅";
            byte[] content = mes.getBytes(Charset.forName("utf-8"));
            int length = mes.getBytes(Charset.forName("utf-8")).length;

            //创建协议包对象
            MessageProtocol messageProtocol = new MessageProtocol();
            messageProtocol.setLen(length);
            messageProtocol.setContent(content);
            ctx.writeAndFlush(messageProtocol);
        }
    }

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, MessageProtocol msg) throws Exception {

        int len = msg.getLen();
        byte[] content = msg.getContent();

        System.out.println("客户端接收到消息如下:");
        System.out.println("长度=" + len);
        System.out.println("内容=" + new String(content, Charset.forName("utf-8")));

        System.out.println("客户端接收消息数量=" + (++this.count));

    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        System.out.println("异常信息=" + cause.getMessage());
        ctx.close();
    }
}


​ MyClientInitializer 类:

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;

/**
 * @author 86130
 * @date 2020/5/27 21:52
 * @desc 描述:
 */
public class MyClientInitializer extends ChannelInitializer<SocketChannel> {
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        pipeline.addLast(new MyMessageEncoder());
        pipeline.addLast(new MyMessageDecoder());
        pipeline.addLast(new MyClientHandler());
    }
}


​ 编解码器:

​ MyMessageDecoder 类(解码器):

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ReplayingDecoder;

import java.util.List;

/**
 * @author 86130
 * @date 2020/6/5 19:56
 * @desc 描述:
 */
public class MyMessageDecoder extends ReplayingDecoder<Void> {
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        System.out.println("MyMessageDecoder decoder 方法被调用");
        //需要将得到的二进制字节码 -> MessageProtocol 数据包(对象)
        int length = in.readInt();

        byte[] content = new byte[length];
        in.readBytes(content);

        //封装成 MessageProtocol 对象,放入 out,传递下一个 handler 业务处理
        MessageProtocol messageProtocol = new MessageProtocol();
        messageProtocol.setLen(length);
        messageProtocol.setContent(content);

        out.add(messageProtocol);
    }
}


​ MyMessageEncoder 类(编码器):

package com.pengtxyl.netty.netty.protocoltcp;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;

/**
 * @author 86130
 * @date 2020/6/5 19:54
 * @desc 描述:
 */
public class MyMessageEncoder extends MessageToByteEncoder<MessageProtocol> {
    @Override
    protected void encode(ChannelHandlerContext ctx, MessageProtocol msg, ByteBuf out) throws Exception {
        System.out.println("MyMessageEncoder encoder 方法被调用");
        out.writeInt(msg.getLen());
        out.writeBytes(msg.getContent());
    }
}


​ 协议包:

​ MessageProtocol 类:

package com.pengtxyl.netty.netty.protocoltcp;

/**
 * @author 86130
 * @date 2020/6/4 19:18
 * @desc 描述: 协议包
 */
public class MessageProtocol {

    private int len; //关键
    private byte[] content;

    public int getLen() {
        return len;
    }

    public void setLen(int len) {
        this.len = len;
    }

    public byte[] getContent() {
        return content;
    }

    public void setContent(byte[] content) {
        this.content = content;
    }
}


十、Netty 核心源码剖析

十一、用Netty自己实现dubbo RPC

1、RPC 基本介绍

1)、RPC(Remote Procedure Call) 指远程过程调用,是一个计算机通信协议。该协议允许运行于一台计算机的程

​ 序调用另一台计算机的子程序,而程序员无需额外地为这个交互作用编程

2)、两个或多个应用程序都分布在不同的服务器上,它们之间的调用都像是本地方法调用一样(如图)

在这里插入图片描述

3)、常见的 RPC 框架有:比较知名的如阿里的Dubbo、google的gRPC、Go语言的rpcx、Apache的thrift,

​ Spring 旗下的 Spring Cloud

在这里插入图片描述

2、RPC 调用流程图

在这里插入图片描述

3、PRC 调用流程说明

1)、服务消费方(client)以本地调用方式调用服务

2)、client stub 接收到调用后负责将方法、 参数等封装成能够进行网络传输的消息体

3)、client stub 将消息进行编码并发送到服务端

4)、server stub 收到消息后进行解码

5)、server stub 根据解码结果调用本地的服务

6)、本地服务执行并将结果返回给 server stub

7)、server stub 将返回导入结果进行编码并发送至消费方

8)、client stub 接收到消息并进行解码

9)、服务消费方(client)得到结果

​ 小结:RPC 的目标就是将 2-8 这些步骤都封装起来,用户无需关心这些细节,可以像调用本地方法一样即可

​ 完成远程服务调用

4、自己实现dubbo RPC(基于 Netty)

1)、需求说明

①、dubbo 底层使用了 Netty 作为网络通讯框架, 要求用 Netty 实现一个简单的 RPC 框架

②、模仿 dubbo, 消费者和提供者约定接口和协议, 消费者远程调用提供者的服务, 提供者返回一个字符串,

​ 消费者打印提供者返回的数据。 底层网络通信使用 Netty 4.1.20

2)、设计说明

①、创建一个接口, 定义抽象方法。 用于消费者和提供者之间的约定

②、创建一个提供者, 该类需要监听消费者的请求, 并按照约定返回数据

③、创建一个消费者, 该类需要透明的调用自己不存在的方法, 内部需要使用 Netty 请求提供者返回数据

④、开发的分析图:

在这里插入图片描述

3)、代码实现:

​ 创建一个公共接口:

​ HelloService

package com.pengtxyl.netty.netty.dubborpc.publicinterface;

/**
 * @author 86130
 * @date 2020/6/5 20:51
 * @desc 描述: 这个是接口,是服务提供方和服务消费方都需要
 */
public interface HelloService {

    String hello(String msg);

}

​ 提供方:

​ HelloServiceImpl 类:

package com.pengtxyl.netty.netty.dubborpc.provider;

import com.pengtxyl.netty.netty.dubborpc.publicinterface.HelloService;

/**
 * @author 86130
 * @date 2020/6/5 20:53
 * @desc 描述:
 */
public class HelloServiceImpl implements HelloService {

    private int count = 0;
    //当有消费方调用该方法时,就返回一个结果
    @Override
    public String hello(String msg) {
        System.out.println("收到客户端消息=" + msg);
        if(msg != null) {
            return "你好客户端,我已经收到你的消息 [" + msg + "] 第" + (++count) + "次";
        } else {
            return "你好客户端,我已经收到你的消息";
        }
    }
}


​ ServerBootstrap 类:

package com.pengtxyl.netty.netty.dubborpc.provider;

import com.pengtxyl.netty.netty.dubborpc.netty.NettyServer;

/**
 * @author 86130
 * @date 2020/6/5 20:56
 * @desc 描述:
 */
//ServerBootstrap 会启动一个服务提供者,就是 NettyServer
public class ServerBootstrap {

    public static void main(String[] args) {

        //代码待填
        NettyServer.startServer("127.0.0.1", 7000);

    }

}


​ Netty:

​ Netty服务端:

​ NettyServer 类:

package com.pengtxyl.netty.netty.dubborpc.netty;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;

/**
 * @author 86130
 * @date 2020/6/5 20:57
 * @desc 描述:
 */
public class NettyServer {

    public static void startServer(String hostName, int port) {
        startSrver0(hostName, port);
    }

    //编写一个方法,完成对 NettyServer 的初始化和启动
    private static void startSrver0(String hostname, int port) {

        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup();

        try {

            ServerBootstrap serverBootstrap = new ServerBootstrap();
            serverBootstrap.group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            ChannelPipeline pipeline = ch.pipeline();
                            pipeline.addLast(new StringDecoder());
                            pipeline.addLast(new StringEncoder());
                            pipeline.addLast(new NettyServerHandler()); //业务处理器
                        }
                    });

            ChannelFuture channelFuture = serverBootstrap.bind(hostname, port).sync();

            System.out.println("服务提供方开始提供服务....");
            channelFuture.channel().closeFuture().sync();

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }

    }

}


​ NettyServerHandler 类:

package com.pengtxyl.netty.netty.dubborpc.netty;

import com.pengtxyl.netty.netty.dubborpc.provider.HelloServiceImpl;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;

/**
 * @author 86130
 * @date 2020/6/5 21:03
 * @desc 描述:
 */
//服务器这边 handler 比较简单
public class NettyServerHandler extends ChannelInboundHandlerAdapter {
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        //获取客户端发送的消息,并调用服务
        System.out.println("msg=" + msg);
        //客户端在调用服务器的api 时,我们需要定义一个协议
        //比如我们要求每次发消息都必须以某个字符串开头 "HelloService#hello#"
        if(msg.toString().startsWith("HelloService#hello#")) {
            String result = new HelloServiceImpl().hello(msg.toString()
                    .substring(msg.toString().lastIndexOf("#") + 1));
            ctx.writeAndFlush(result);
        }
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }
}


​ Netty 客户端:

​ NettyClient 类:

package com.pengtxyl.netty.netty.dubborpc.netty;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelOption;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;

import java.lang.reflect.Proxy;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

/**
 * @author 86130
 * @date 2020/6/5 21:21
 * @desc 描述:
 */
public class NettyClient {

    //创建线程池
    private static ExecutorService executor = Executors.newFixedThreadPool(
            Runtime.getRuntime().availableProcessors());

    private static NettyClientHandler client;

    //编写方法使用代理模式,获取一个代理对象
    public Object getBean(final Class<?> serviceClass, final String providerName) {
        return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
                new Class<?>[] {serviceClass}, (proxy, method, args) -> {

                //{} 部分的代码,客户端每调用一次 hello,就会进入到该代码
                if(client == null) {
                    initClient();
                }

                //设置要发给服务器端的信息
                // providerName 协议头 args[0] 就是客户端调用 api hello(???), 参数
                client.setPara(providerName + args[0]);
                return executor.submit(client).get();
                });
    }

    //初始化客户端
    private static void initClient() {
        client = new NettyClientHandler();
        //创建 EventLoopGroup
        NioEventLoopGroup group = new NioEventLoopGroup();
        Bootstrap bootstrap = new Bootstrap();
        bootstrap.group(group)
                .channel(NioSocketChannel.class)
                .option(ChannelOption.TCP_NODELAY, true)
                .handler(
                        new ChannelInitializer<SocketChannel>() {
                            @Override
                            protected void initChannel(SocketChannel ch) throws Exception {
                                ChannelPipeline pipeline = ch.pipeline();
                                pipeline.addLast(new StringDecoder());
                                pipeline.addLast(new StringEncoder());
                            }
                        }
                );

        try {
            bootstrap.connect("127.0.0.1", 7000).sync();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}


​ NettyClientHandler 类:

package com.pengtxyl.netty.netty.dubborpc.netty;

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;

import java.util.concurrent.Callable;

/**
 * @author 86130
 * @date 2020/6/5 21:11
 * @desc 描述:
 */
public class NettyClientHandler extends ChannelInboundHandlerAdapter implements Callable {

    private ChannelHandlerContext context;  //上下文
    private String result; //返回的结果
    private String para;    //客户端调用方法时,传入的参数

    //与服务器的连接创建后,就会被调用,这个方法是第一个被调用 (1)
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        System.out.println("channelActive 被调用");
        context = ctx;  //因为我们在其他方法会使用到 ctx
    }

    //收到服务器的数据后,调用方法 (4)
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        System.out.println("channelRead 被调用");
        result = msg.toString();
        notify();   //唤醒等待的线程
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        ctx.close();
    }

    //被代理对象调用,发送数据给服务器 -> wait - > 等待被唤醒(channelRead) -> 返回结果 (3) -> (5)
    @Override
    public Object call() throws Exception {
        System.out.println("call1 被调用");
        context.writeAndFlush(para);
        //进行 wait
        wait(); //等待 channelRead 方法获取到服务器的结果后,唤醒
        System.out.println("call2 被调用");
        return result;  //服务方返回的结果
    }

    // (2)
    void setPara(String para) {
        System.out.println("setPara 被调用");
        this.para = para;
    }

}


​ 消费方:

​ ClientBootStrap 类:

package com.pengtxyl.netty.netty.dubborpc.customer;

import com.pengtxyl.netty.netty.dubborpc.netty.NettyClient;
import com.pengtxyl.netty.netty.dubborpc.publicinterface.HelloService;

/**
 * @author 86130
 * @date 2020/6/5 21:33
 * @desc 描述:
 */
public class ClientBootStrap {

    //定义协议头
    public static final String providerName = "HelloService#hello#";

    public static void main(String[] args) throws Exception{
        //创建一个消费者
        NettyClient customer = new NettyClient();

        //创建代理对象
        HelloService service = (HelloService) customer.getBean(HelloService.class, providerName);

        for(;;) {
            Thread.sleep(2 * 1000);
            //通过代理对象调用服务提供者的方法(服务)
            String res = service.hello("你好 dubbo...");
            System.out.println("调用的结果 res= " + res);
        }
    }

}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值