Netty(4.x)中文文檔

??????本文由筆者翻譯于Netty官方文檔,如有任何翻譯上的錯誤,請聯(lián)系筆者,感謝!

前言

問題

??????現(xiàn)在我們使用通用應用程序或庫來彼此通信。例如,我們經(jīng)常使用HTTP客戶端庫從web服務器檢索信息,并通過web服務調(diào)用遠程過程調(diào)用。然而,一個通用協(xié)議或它的實現(xiàn)有時并不能很好地擴展。這就像我們沒有使用通用的HTTP服務器來交換巨大的文件、電子郵件消息和接近實時的消息(如財務信息和多人游戲數(shù)據(jù))。需要的是一個高度優(yōu)化的協(xié)議實現(xiàn),專門用于特定的目的。例如,您可能想實現(xiàn)一個針對基于ajax的聊天應用程序、媒體流或大型文件傳輸進行優(yōu)化的HTTP服務器。您甚至可能想設(shè)計和實現(xiàn)一個全新的協(xié)議,它可以根據(jù)您的需要進行精確定制。另一種不可避免的情況是,您必須處理遺留的專有協(xié)議,以確保與舊系統(tǒng)的互操作性。在這種情況下,重要的是在不犧牲應用程序的穩(wěn)定性和性能的情況下,我們可以多快地實現(xiàn)該協(xié)議。

解決方案

??????Netty項目致力于提供一個異步事件驅(qū)動的網(wǎng)絡(luò)應用框架和工具,用于快速開發(fā)可維護的高性能和高可伸縮性協(xié)議服務器和客戶端。
??????換句話說,Netty是一個NIO客戶端服務器框架,它支持快速而簡單地開發(fā)網(wǎng)絡(luò)應用程序,如協(xié)議服務器和客戶端。它極大地簡化和簡化了網(wǎng)絡(luò)編程,如TCP和UDP套接字服務器開發(fā)。“快速和簡單”并不意味著結(jié)果應用程序?qū)⑹艿娇删S護性或性能問題的影響。
??????Netty是經(jīng)過精心設(shè)計的,從許多協(xié)議(如FTP、SMTP、HTTP和各種基于二進制和文本的遺留協(xié)議)的實現(xiàn)中吸取了經(jīng)驗。因此,Netty成功地找到了一種方法,可以在不妥協(xié)的情況下實現(xiàn)開發(fā)的易用性、性能、穩(wěn)定性和靈活性。
有些用戶可能已經(jīng)發(fā)現(xiàn)了其他聲稱具有相同優(yōu)勢的網(wǎng)絡(luò)應用程序框架,您可能想知道是什么使Netty與它們?nèi)绱瞬煌?。答案是它所建立的哲學。
??????Netty從一開始就為您提供API和實現(xiàn)方面最舒適的體驗。這不是一些有形的東西,但你會意識到,這種哲學將使你的生活更容易,當你閱讀本指南和玩Netty。

開始

??????本章通過簡單的例子介紹了Netty的核心構(gòu)造,讓你快速入門。當你在本章結(jié)束的時候,你將能夠?qū)懸粋€客戶端和一個服務器在Netty之上。如果您喜歡使用自頂向下的方法來學習,您可能希望從第2章“架構(gòu)概述”開始,然后再回到這里。

開始之前

??????運行本章示例的最低要求只有兩個;最新版本的Netty和JDK 1.6或以上。最新版本的Netty可以在項目下載頁面中找到。要下載正確版本的JDK,請參考您首選的JDK供應商的網(wǎng)站。

??????在閱讀的過程中,你可能會對本章介紹的課程有更多的疑問。如果您想了解更多有關(guān)它們的信息,請參閱API參考。為了您的方便,本文檔中的所有類名都鏈接到在線API參考。此外,如果有任何不正確的信息、語法錯誤或打字錯誤,請不要猶豫聯(lián)系Netty項目社區(qū),并讓我們知道,如果您有任何好的想法來幫助改進文檔。

寫一個丟棄服務

??????世界上最簡單的協(xié)議不是“你好,世界!”但丟棄。它是一種丟棄任何接收到的數(shù)據(jù)而不進行任何響應的協(xié)議。
??????要實現(xiàn)丟棄協(xié)議,您需要做的唯一一件事就是忽略所有接收到的數(shù)據(jù)。讓我們直接從處理程序?qū)崿F(xiàn)開始,它處理Netty生成的I/O事件。

package io.netty.example.discard;

import io.netty.buffer.ByteBuf;

import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;

/**
 * Handles a server-side channel.
 */
public class DiscardServerHandler extends ChannelInboundHandlerAdapter { // (1)

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) { // (2)
        // Discard the received data silently.
        ((ByteBuf) msg).release(); // (3)
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) { // (4)
        // Close the connection when an exception is raised.
        cause.printStackTrace();
        ctx.close();
    }
}

??????1.DiscardServerHandler擴展了ChannelInboundHandlerAdapter,它是ChannelInboundHandler的實現(xiàn)。ChannelInboundHandler提供了各種可以覆蓋的事件處理程序方法。現(xiàn)在,擴展ChannelInboundHandlerAdapter就足夠了,而不需要您自己實現(xiàn)處理程序接口。
??????2.我們在這里重寫channelRead()事件處理程序方法。每當從客戶端接收到新數(shù)據(jù)時,就會隨著接收到的消息調(diào)用此方法。在本例中,接收到的消息的類型是ByteBuf。
??????3.要實現(xiàn)丟棄協(xié)議,處理程序必須忽略接收到的消息。ByteBuf是一個引用計數(shù)對象,必須通過release()方法顯式地釋放它。請記住,釋放傳遞給處理程序的引用計數(shù)對象是處理程序的責任。通常,channelRead()處理程序方法的實現(xiàn)如下所示:

@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
    try {
        // Do something with msg
    } finally {
        ReferenceCountUtil.release(msg);
    }
}

??????4.當Netty由于I/O錯誤或處理程序?qū)崿F(xiàn)由于處理事件時拋出異常而引發(fā)異常時,使用Throwable調(diào)用exceptionCaught()事件處理程序方法。在大多數(shù)情況下,應該記錄捕獲的異常,并在這里關(guān)閉與之關(guān)聯(lián)的通道,盡管此方法的實現(xiàn)可能因您想要處理異常情況而有所不同。例如,您可能希望在關(guān)閉連接之前發(fā)送帶有錯誤代碼的響應消息。

??????到目前為止一切順利。我們已經(jīng)實現(xiàn)了丟棄服務器的前半部分。現(xiàn)在剩下的工作是編寫main()方法,該方法使用DiscardServerHandler啟動服務器。

package io.netty.example.discard;
    
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;
    
/**
 * Discards any incoming data.
 */
public class DiscardServer {
    
    private int port;
    
    public DiscardServer(int port) {
        this.port = port;
    }
    
    public void run() throws Exception {
        EventLoopGroup bossGroup = new NioEventLoopGroup(); // (1)
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        try {
            ServerBootstrap b = new ServerBootstrap(); // (2)
            b.group(bossGroup, workerGroup)
             .channel(NioServerSocketChannel.class) // (3)
             .childHandler(new ChannelInitializer<SocketChannel>() { // (4)
                 @Override
                 public void initChannel(SocketChannel ch) throws Exception {
                     ch.pipeline().addLast(new DiscardServerHandler());
                 }
             })
             .option(ChannelOption.SO_BACKLOG, 128)          // (5)
             .childOption(ChannelOption.SO_KEEPALIVE, true); // (6)
    
            // Bind and start to accept incoming connections.
            ChannelFuture f = b.bind(port).sync(); // (7)
    
            // Wait until the server socket is closed.
            // In this example, this does not happen, but you can do that to gracefully
            // shut down your server.
            f.channel().closeFuture().sync();
        } finally {
            workerGroup.shutdownGracefully();
            bossGroup.shutdownGracefully();
        }
    }
    
    public static void main(String[] args) throws Exception {
        int port = 8080;
        if (args.length > 0) {
            port = Integer.parseInt(args[0]);
        }

        new DiscardServer(port).run();
    }
}

??????1.NioEventLoopGroup是一個處理I/O操作的多線程事件循環(huán)。Netty為不同類型的傳輸提供了各種EventLoopGroup實現(xiàn)。在本例中,我們將實現(xiàn)一個服務器端應用程序,因此將使用兩個NioEventLoopGroup。第一個,通常稱為“boss”,接受一個傳入連接。第二個,通常稱為“worker”,在老板接受連接并向worker注冊已接受的連接后,處理已接受連接的流量。使用多少線程以及如何將它們映射到創(chuàng)建的通道取決于EventLoopGroup實現(xiàn),甚至可以通過構(gòu)造函數(shù)進行配置。
??????2.ServerBootstrap是一個設(shè)置服務器的助手類。您可以直接使用通道設(shè)置服務器。但是,請注意,這是一個乏味的過程,而且在大多數(shù)情況下不需要這樣做。
??????3.這里,我們指定使用NioServerSocketChannel類,該類用于實例化一個新通道以接受傳入連接
??????4.這里指定的處理程序?qū)⑹冀K由新接受的通道進行評估。ChannelInitializer是一個特殊的處理程序,用于幫助用戶配置新通道。您很可能希望通過添加一些處理程序(如DiscardServerHandler)來配置新通道的ChannelPipeline,以實現(xiàn)網(wǎng)絡(luò)應用程序。隨著應用程序變得越來越復雜,您可能會向管道中添加更多的處理程序,并最終將這個匿名類提取到一個頂級類中。
??????5.您還可以設(shè)置特定于通道實現(xiàn)的參數(shù)。我們正在編寫一個TCP/IP服務器,因此允許設(shè)置套接字選項,如tcpNoDelay和keepAlive。請參考ChannelOption的apidocs和特定的ChannelConfig實現(xiàn),以獲得有關(guān)受支持的ChannelOptions的概述。
??????6.您注意到option()和childOption()了嗎?option()用于接受傳入連接的NioServerSocketChannel。childOption()用于父服務器通道(在本例中為NioServerSocketChannel)接受的通道。
??????7.我們現(xiàn)在準備走了。剩下的工作就是綁定到端口并啟動服務器。在這里,我們綁定到機器中所有nic(網(wǎng)絡(luò)接口卡)的端口8080?,F(xiàn)在可以任意多次調(diào)用bind()方法(使用不同的綁定地址)。

??????恭喜你!您剛剛完成了在Netty上的第一個服務器。

查看收到的數(shù)據(jù)

??????現(xiàn)在我們已經(jīng)編寫了我們的第一個服務器,我們需要測試它是否真的工作。最簡單的測試方法是使用telnet命令。例如,您可以在命令行中輸入telnet localhost 8080并鍵入一些內(nèi)容。
??????但是,我們能說服務器工作正常嗎?我們不能真正知道這一點,因為它是一個廢棄服務器。你不會得到任何回應。為了證明它確實在工作,讓我們修改服務器來打印它收到的內(nèi)容。
??????我們已經(jīng)知道,只要接收到數(shù)據(jù),就會調(diào)用channelRead()方法。讓我們在DiscardServerHandler的channelRead()方法中放入一些代碼:

@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
    ByteBuf in = (ByteBuf) msg;
    try {
        while (in.isReadable()) { // (1)
            System.out.print((char) in.readByte());
            System.out.flush();
        }
    } finally {
        ReferenceCountUtil.release(msg); // (2)
    }
}

??????1.這個低效循環(huán)實際上可以簡化為:System.out.println(in.toString(io.net . uti.charsetutil.us_ascii))
??????2.您也可以在這里使用in.release()。

??????如果您再次運行telnet命令,您將看到服務器打印它接收到的內(nèi)容。
??????丟棄服務器的完整源代碼位于該發(fā)行版的io.net .example.丟棄包中。

寫一個應答服務器

??????到目前為止,我們一直在使用數(shù)據(jù)而沒有響應。然而,服務器通常應該響應請求。讓我們學習如何通過實現(xiàn)ECHO協(xié)議向客戶端編寫響應消息,接收到的任何數(shù)據(jù)都會被發(fā)回。
??????與我們在前幾節(jié)中實現(xiàn)的丟棄服務器的惟一區(qū)別是,它將發(fā)送回接收到的數(shù)據(jù),而不是將接收到的數(shù)據(jù)打印到控制臺。因此,修改channelRead()方法就足夠了

 @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) {
        ctx.write(msg); // (1)
        ctx.flush(); // (2)
    }

??????1.ChannelHandlerContext對象提供各種操作,使您能夠觸發(fā)各種I/O事件和操作。在這里,我們調(diào)用write(Object)來逐字寫入接收到的消息。請注意,我們沒有像在丟棄示例中那樣釋放接收到的消息。這是因為Netty在將其寫入網(wǎng)絡(luò)時為您釋放了它。write(Object)不會將消息寫入網(wǎng)絡(luò)。它在內(nèi)部進行緩沖,然后通過ctx.flush()將其刷新到連接上?;蛘?,為了簡潔,您可以調(diào)用ctx.writeAndFlush(msg)。
??????2.write(Object)不會將消息寫入網(wǎng)絡(luò)。它在內(nèi)部進行緩沖,然后通過ctx.flush()將其刷新到連接上?;蛘撸瑸榱撕啙?,您可以調(diào)用ctx.writeAndFlush(msg)。

??????如果您再次運行telnet命令,您將看到服務器發(fā)回您發(fā)送給它的任何內(nèi)容。
??????echo服務器的完整源代碼位于該發(fā)行版的io.net .example.echo包中。

寫一個時間服務器

?
?


??????未完,待續(xù)!

????????????最近更新于2020.11.04


??????
??????

??????

??????

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

友情鏈接更多精彩內(nèi)容