SpringBoot整合Netty服務端的方法示例

更新時間：2024年10月30日 10:24:26 作者：m0_70554089

本文詳細介紹了SpringBoot和Netty的整合方法,包括添加依賴、創(chuàng)建Netty服務端代碼解析類、創(chuàng)建字符解析器等步驟,以及開發(fā)過程中遇到的問題及解決方法,感興趣的可以了解一下

一、什么是Netty

Netty是由JBOSS提供的一個Java開源框架，現(xiàn)為Github上的獨立項目。它是一個異步的、基于事件驅(qū)動的網(wǎng)絡應用框架，用以快速開發(fā)高性能、高可靠性的網(wǎng)絡IO程序。Netty主要針對在TCP協(xié)議下，面向Clients端的高并發(fā)應用，或者Peer-to-Peer場景下的大量數(shù)據(jù)持續(xù)傳輸?shù)膽谩?/p>

Netty提供了一套完整的API，用于處理網(wǎng)絡IO操作，如TCP和UDP套接字。它封裝了底層的網(wǎng)絡編程細節(jié)，使得開發(fā)者可以更加專注于業(yè)務邏輯的實現(xiàn)。Netty使用了一種高效的線程模型，可以處理大量的并發(fā)連接，并且具有很好的伸縮性。

Netty在多個領域都有廣泛的應用，如RPC框架、游戲行業(yè)、大數(shù)據(jù)領域等。它支持多種傳輸類型和協(xié)議，如阻塞和非阻塞、基于BIO和NIO的UDP傳輸、本地傳輸（in-VM傳輸）、HTTP通道等。同時，Netty還提供了豐富的編解碼器，用于處理各種協(xié)議的編解碼操作。

Netty的整體結(jié)構(gòu)包括核心層和協(xié)議支持層。核心層提供了底層網(wǎng)絡通信的通用抽象和實現(xiàn)，包括可擴展的事件模型、通用的通信API、支持零拷貝的ByteBuf等。協(xié)議支持層則覆蓋了主流協(xié)議的編解碼實現(xiàn)，如HTTP、SSL、Protobuf等。

總的來說，Netty是一個功能強大、易于使用的網(wǎng)絡應用框架，它可以幫助開發(fā)者快速構(gòu)建高性能、高可靠性的網(wǎng)絡應用程序。

二、Netty核心組件

Netty的核心組件主要包括以下幾個部分：

Channels：Channel是Netty網(wǎng)絡通信的抽象，用于進行I/O操作。它可以被看作是Java NIO的一個基本抽象，代表了與硬件設備、文件、網(wǎng)絡socket等實體的開放連接，或者是一個能夠完成讀、寫等I/O操作的程序。Channel可以被打開或關(guān)閉，連接或斷開。
Callbacks（回調(diào)）：Callback是一個方法，它是提供給另一個方法的引用，使得另一個方法可以在適當?shù)臅r候回過頭來調(diào)用這個Callback方法。Callback在很多編程情形中被廣泛使用，是用于通知相關(guān)方某個操作已經(jīng)完成最常用的方法之一。
Futures：在Netty中，F(xiàn)utures用于異步I/O操作的結(jié)果。當一個異步操作開始時，會立即返回一個Future，這個Future會在操作完成時得到結(jié)果或者異常。
Handlers：Handlers是Netty中處理I/O事件或攔截I/O操作的組件。Netty提供了許多內(nèi)置的Handler，如ChannelInboundHandler、ChannelOutboundHandler等，這些Handler可以處理各種I/O事件，如連接建立、數(shù)據(jù)接收、異常處理等。
Bootstrap與ServerBootstrap：Bootstrap和ServerBootstrap是Netty程序的引導類，主要用于配置各種參數(shù)并啟動整個Netty服務。它們都繼承自AbstractBootstrap抽象類，不同的是，Bootstrap用于客戶端引導，而ServerBootstrap用于服務端引導。
EventLoopGroup：EventLoopGroup可以理解為一個線程池，用于處理I/O操作。在服務端程序中，一般會綁定兩個EventLoopGroup，一個用于處理Accept事件（即新的連接請求），另一個用于處理讀寫事件。

以上這些組件共同構(gòu)成了Netty的核心框架，使得開發(fā)者可以更加專注于業(yè)務邏輯的實現(xiàn)，而無需過多關(guān)心底層的網(wǎng)絡通信細節(jié)。

三、SpringBoot與Netty整合

1. 添加依賴

在SpringBoot項目的pom.xml文件中，我們需要添加Netty的依賴。Netty的官方Maven倉庫地址為：https://mvnrepository.com/artifact/io.netty/netty-all

    <dependencies>
        <!-- mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>

        <!-- Mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--   數(shù)據(jù)源     -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
        </dependency>

        <!--   netty     -->
        <dependency>
            <groupId>io.netty</groupId>
            <artifactId>netty-all</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>

    </dependencies>

2.創(chuàng)建Netty服務端

@Component
public class NettyServer {

    //負責處理接受進來的鏈接
    private EventLoopGroup bossGroup;
    //負責處理已經(jīng)被接收的連接上的I/O操作
    private EventLoopGroup workerGroup;
    //在這個場景中，它表示服務器的綁定操作的結(jié)果
    private ChannelFuture future;

    @PostConstruct
    public void startServer() throws Exception {
        bossGroup = new NioEventLoopGroup();
        workerGroup = new NioEventLoopGroup();
        try {
            //創(chuàng)建ServerBootstrap,這個類封裝了服務器端的網(wǎng)絡配置，使得我們可以輕松地設置服務器參數(shù)
            ServerBootstrap bootstrap = new ServerBootstrap();
            bootstrap.group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new NettyServerInitializer());

            // 綁定端口并開始接受進來的連接
            future = bootstrap.bind(7000).sync();

            // 等待服務器套接字關(guān)閉
            future.channel().closeFuture().sync();
        } finally {
            workerGroup.shutdownGracefully();
            bossGroup.shutdownGracefully();
        }
    }

    @PreDestroy
    public void stopServer() {
        if (future != null && !future.isDone()) {
            future.cancel(true);
        }
        workerGroup.shutdownGracefully();
        bossGroup.shutdownGracefully();
    }
}

代碼解析

類注解

@Component: 這是Spring框架的注解，表示這個類是一個組件，Spring會掃描到這個類并將其作為Bean注冊到Spring容器中。因此，這個類可以被其他Spring管理的Bean自動裝配（如果需要的話）。

類成員變量

bossGroup 和 workerGroup: 這兩個是EventLoopGroup的實例，用于處理網(wǎng)絡事件。bossGroup 主要負責接收進來的連接，而 workerGroup 負責處理已經(jīng)被接收的連接上的I/O操作。
future: 這是一個ChannelFuture的實例，代表了一個異步的I/O操作的結(jié)果。在這個場景中，它表示服務器的綁定操作的結(jié)果。

startServer 方法

該方法使用@PostConstruct注解，這意味著當Spring容器實例化這個Bean并完成依賴注入后，會自動調(diào)用這個方法。
在這個方法中，首先創(chuàng)建了兩個NioEventLoopGroup實例，一個用于boss，一個用于worker。
然后，使用ServerBootstrap類來配置和啟動服務器。這個類封裝了服務器端的網(wǎng)絡配置，使得我們可以輕松地設置服務器參數(shù)。
通過group方法設置boss和worker的EventLoopGroup。
通過channel方法指定使用NioServerSocketChannel作為服務器的通道實現(xiàn)。
通過childHandler方法設置一個新的連接被接受后如何處理。這里使用了NettyServerInitializer（這個類沒有在提供的代碼段中定義，但我們可以假設它是一個ChannelInitializer的實現(xiàn)，用于配置新的Channel）。
使用bind方法綁定服務器到指定的端口（這里是7000），并使用sync方法阻塞直到綁定完成。
最后，使用closeFuture().sync()方法阻塞當前線程，直到服務器套接字關(guān)閉。
在finally塊中，無論是否發(fā)生異常，都會優(yōu)雅地關(guān)閉EventLoopGroup。

stopServer 方法

該方法使用@PreDestroy注解，意味著當Spring容器銷毀這個Bean之前，會自動調(diào)用這個方法。
在這個方法中，首先檢查future是否已經(jīng)完成（即服務器是否已經(jīng)關(guān)閉）。如果沒有，就調(diào)用cancel(true)方法來嘗試取消這個操作。但是，需要注意的是，這里的cancel可能并不總是能立即停止服務器，它更多的是嘗試停止服務器，而不是強制停止。

3.創(chuàng)建字符解析器,用于解析收到的消息

public class NettyServerInitializer extends ChannelInitializer<SocketChannel> {

    @Override
    protected void initChannel(SocketChannel ch){
        ChannelPipeline pipeline = ch.pipeline();

        // 添加一個字符串解碼器，用于將接收到的ByteBuf轉(zhuǎn)換成字符串
        // 這里假設使用的是UTF-8字符集
        pipeline.addLast("decoder", new StringDecoder(CharsetUtil.UTF_8));

        // 添加一個字符串編碼器，用于將發(fā)送的字符串轉(zhuǎn)換成ByteBuf
        // 這樣服務器發(fā)送字符串時，客戶端可以直接接收到字符串
        pipeline.addLast("encoder", new StringEncoder(CharsetUtil.UTF_8));

        // 添加自定義的ChannelInboundHandlerAdapter來處理業(yè)務邏輯
        pipeline.addLast("handler", new MyChannelHandler());
    }
}

這段代碼定義了一個NettyServerInitializer類，它繼承自ChannelInitializer<SocketChannel>，并覆蓋了initChannel方法。在Netty中，ChannelInitializer是一個特殊的處理器，它的主要目的是幫助用戶配置一個新的Channel的ChannelPipeline。當一個新的連接被接受時，Netty會自動調(diào)用ChannelInitializer的initChannel方法來設置這個新連接的ChannelPipeline。

具體來說，initChannel方法會在以下情況下被調(diào)用：

當ServerBootstrap的bind方法被調(diào)用并成功綁定到某個端口后，開始監(jiān)聽傳入的連接。
一旦有客戶端連接到服務器，ServerBootstrap會接受這個連接，并創(chuàng)建一個新的SocketChannel來表示這個連接。
對于這個新的SocketChannel，Netty會調(diào)用之前設置的ChannelInitializer（在這個例子中是NettyServerInitializer）的initChannel方法。
initChannel方法內(nèi)部會配置這個新SocketChannel的ChannelPipeline，添加解碼器、編碼器、業(yè)務處理器等。
一旦initChannel方法執(zhí)行完畢，這個ChannelInitializer的使命就完成了，并且會從ChannelPipeline中移除自身，因為它只負責初始化工作，不參與后續(xù)的數(shù)據(jù)處理。

所以，總結(jié)來說，NettyServerInitializer的initChannel方法會在一個新的客戶端連接被服務器接受時運行，用于初始化這個新連接的ChannelPipeline。

4.創(chuàng)建Handler處理接受到的消息

public class MyChannelHandler extends ChannelInboundHandlerAdapter {
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        // 在這里處理接收到的數(shù)據(jù)


        System.out.println("msg = " + msg);
    }
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        // 在這里處理異常
    }
}