Netty入門（一）：零基礎「HelloWorld」詳細圖文步驟

時間 2019-11-13

標籤 netty 入門零基礎 helloworld 詳細圖文步驟欄目 Netty 简体版

原文原文鏈接

由於接下來的項目要用到netty,因此就瞭解一下這個程序，奈何網上的教程都是稍微有點基礎的，因此，就寫一篇對於netty零基礎的，順便也記錄一下。html

先扔幾個參考學習的網頁： java

netty 官方API： http://netty.io/4.1/api/index.htmlapache

netty 中文指南：https://waylau.com/netty-4-user-guide/ （來自我的）bootstrap

關於NIO基礎的知識：https://my.oschina.net/andylucc/blog/614295windows

　　　　　　　　　 http://www.cnblogs.com/dolphin0520/p/3919162.html　api

　　　　　　　　　　http://blog.csdn.net/wuxianglong/article/details/6604817 瀏覽器

我這裏所使用的：服務器

netty版本：netty-5.0.0.Alpha2 http://files.cnblogs.com/files/applerosa/netty-5.0.0.Alpha2.7z網絡

maven依賴：多線程

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-all</artifactId>
    <version>5.0.0.Alpha2</version>
</dependency>

好了，咱們開始。

1、首先，你要創建一個java工程，至於普通工程仍是maven工程，看本身喜愛，由於我這裏只是作爲學習，就建了一個普通工程，而後把下載的jar包扔到lib中，引入便可。

2、接下來咱們要搞清楚，netty是什麼玩意。

　　官方那個給出的介紹是：Netty是由JBOSS提供的一個java開源框架。Netty提供異步的、事件驅動的網絡應用程序框架和工具，用以快速開發高性能、高可靠性的網絡服務器和客戶端程序。

　　而後咱們簡單理解一下，這玩意就是個程序，幹什麼的？netty是封裝java socket noi的。相似的功能是 apache的mina。

　　相對於Tomcat這種Web Server（顧名思義主要是提供Web協議相關的服務的），Netty是一個Network Server，是處於Web Server更下層的網絡框架，也就是說你可使用Netty模仿Tomcat作一個提供HTTP服務的Web容器。

　　說白了，就是一個好使的處理Socket的東西。要是想了解詳細點，能夠去看看官方的介紹。

3、回到正題咱們開始寫所謂的「Hello World"

　　這裏插一下，就是咱們的的通訊是創建在必定的協議之上的，就好比咱們經常使用的Web工程，前臺（瀏覽器）發送一個請求，後臺作出相應返回相應的結果，這個通訊的過程亦是如此。

　　在netty官方指南里面有講，世上最簡單的協議不是'Hello, World!' 而是 DISCARD(拋棄服務)。這個協議將會拋棄任何收到的數據，而不響應。就是你客戶端發送消息，好，發送過去了，服務器也收到了，可是拋棄了。

　　說白了，就是你發一條消息給我，我收到了，可是我直接就把消息拋棄了，不理你的。

其次，關於netty ，首先要搞清楚，這是創建在客戶端和服務端之間的。

咱們先說服務端，服務端創建相應的規則，而後運行起來，等待客戶端訪問或者發送」消息「。好了，咱們先創建服務端代碼：

第一步：先創建相應的規則：

package _01discard;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerAdapter;
import io.netty.channel.ChannelHandlerContext;
import io.netty.util.CharsetUtil;
import io.netty.util.ReferenceCountUtil;

/**
 * 服務端處理通道.這裏只是打印一下請求的內容，並不對請求進行任何的響應 DiscardServerHandler 繼承自
 * ChannelHandlerAdapter， 這個類實現了ChannelHandler接口， ChannelHandler提供了許多事件處理的接口方法，
 * 而後你能夠覆蓋這些方法。 如今僅僅只須要繼承ChannelHandlerAdapter類而不是你本身去實現接口方法。
 *
 */
public class DiscardServerHandler extends ChannelHandlerAdapter {
    /**
     * 這裏咱們覆蓋了chanelRead()事件處理方法。 每當從客戶端收到新的數據時， 這個方法會在收到消息時被調用，
     * 這個例子中，收到的消息的類型是ByteBuf
     * 
     * @param ctx
     *            通道處理的上下文信息
     * @param msg
     *            接收的消息
     */
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) {

        try {
            ByteBuf in = (ByteBuf) msg;
            // 打印客戶端輸入，傳輸過來的的字符
            System.out.print(in.toString(CharsetUtil.UTF_8));
        } finally {
            /**
             * ByteBuf是一個引用計數對象，這個對象必須顯示地調用release()方法來釋放。
             * 請記住處理器的職責是釋放全部傳遞處處理器的引用計數對象。
             */
            // 拋棄收到的數據
            ReferenceCountUtil.release(msg);
        }

    }

    /***
     * 這個方法會在發生異常時觸發
     * 
     * @param ctx
     * @param cause
     */
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        /**
         * exceptionCaught() 事件處理方法是當出現 Throwable 對象纔會被調用，即當 Netty 因爲 IO
         * 錯誤或者處理器在處理事件時拋出的異常時。在大部分狀況下，捕獲的異常應該被記錄下來 而且把關聯的 channel
         * 給關閉掉。然而這個方法的處理方式會在遇到不一樣異常的狀況下有不 同的實現，好比你可能想在關閉鏈接以前發送一個錯誤碼的響應消息。
         */
        // 出現異常就關閉
        cause.printStackTrace();
        ctx.close();
    }

}

第二步：咱們須要應用相應的規則。就是說，咱們創建了接收消息的規則，可是光創建規則有什麼用，僅僅只是一個規則，咱們須要把這個規則」應用「起來，一般就是咱們一般的」運行「。

package _01discard;

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;

/**
 * 丟棄任何進入的數據 啓動服務端的DiscardServerHandler
 */
public class DiscardServer {
    private int port;

    public DiscardServer(int port) {
        super();
        this.port = port;
    }

    public void run() throws Exception {

        /***
         * NioEventLoopGroup 是用來處理I/O操做的多線程事件循環器，
         * Netty提供了許多不一樣的EventLoopGroup的實現用來處理不一樣傳輸協議。 在這個例子中咱們實現了一個服務端的應用，
         * 所以會有2個NioEventLoopGroup會被使用。 第一個常常被叫作‘boss’，用來接收進來的鏈接。
         * 第二個常常被叫作‘worker’，用來處理已經被接收的鏈接， 一旦‘boss’接收到鏈接，就會把鏈接信息註冊到‘worker’上。
         * 如何知道多少個線程已經被使用，如何映射到已經建立的Channels上都須要依賴於EventLoopGroup的實現，
         * 而且能夠經過構造函數來配置他們的關係。
         */
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        System.out.println("準備運行端口：" + port);
        try {
            /**
             * ServerBootstrap 是一個啓動NIO服務的輔助啓動類 你能夠在這個服務中直接使用Channel
             */
            ServerBootstrap b = new ServerBootstrap();
            /**
             * 這一步是必須的，若是沒有設置group將會報java.lang.IllegalStateException: group not
             * set異常
             */
            b = b.group(bossGroup, workerGroup);
            /***
             * ServerSocketChannel以NIO的selector爲基礎進行實現的，用來接收新的鏈接
             * 這裏告訴Channel如何獲取新的鏈接.
             */
            b = b.channel(NioServerSocketChannel.class);
            /***
             * 這裏的事件處理類常常會被用來處理一個最近的已經接收的Channel。 ChannelInitializer是一個特殊的處理類，
             * 他的目的是幫助使用者配置一個新的Channel。
             * 也許你想經過增長一些處理類好比NettyServerHandler來配置一個新的Channel
             * 或者其對應的ChannelPipeline來實現你的網絡程序。 當你的程序變的複雜時，可能你會增長更多的處理類到pipline上，
             * 而後提取這些匿名類到最頂層的類上。
             */
            b = b.childHandler(new ChannelInitializer<SocketChannel>() { // (4)
                @Override
                public void initChannel(SocketChannel ch) throws Exception {
                    ch.pipeline().addLast(new DiscardServerHandler());// demo1.discard
                    // ch.pipeline().addLast(new
                    // ResponseServerHandler());//demo2.echo
                    // ch.pipeline().addLast(new
                    // TimeServerHandler());//demo3.time
                }
            });
            /***
             * 你能夠設置這裏指定的通道實現的配置參數。 咱們正在寫一個TCP/IP的服務端，
             * 所以咱們被容許設置socket的參數選項好比tcpNoDelay和keepAlive。
             * 請參考ChannelOption和詳細的ChannelConfig實現的接口文檔以此能夠對ChannelOptions的有一個大概的認識。
             */
            b = b.option(ChannelOption.SO_BACKLOG, 128);
            /***
             * option()是提供給NioServerSocketChannel用來接收進來的鏈接。
             * childOption()是提供給由父管道ServerChannel接收到的鏈接，
             * 在這個例子中也是NioServerSocketChannel。
             */
            b = b.childOption(ChannelOption.SO_KEEPALIVE, true);
            /***
             * 綁定端口並啓動去接收進來的鏈接
             */
            ChannelFuture f = b.bind(port).sync();
            /**
             * 這裏會一直等待，直到socket被關閉
             */
            f.channel().closeFuture().sync();
        } finally {
            /***
             * 關閉
             */
            workerGroup.shutdownGracefully();
            bossGroup.shutdownGracefully();
        }
    }
　　

　　 //將規則跑起來 public static void main(String[] args) throws Exception {
        int port;
        if (args.length > 0) {
            port = Integer.parseInt(args[0]);
        } else {
            port = 8080;
        }
        new DiscardServer(port).run();
        System.out.println("server:run()");
    }
}