Netty入門（八）構建Netty HTTP/HTTPS應用

　　HTTP/HTTPS 是最常見的一種協議，這節主要是看一下 Netty 提供的 ChannelHaandler。

一、HTTP Decoder，Encoder 和 Codec

　　HTTP 是請求-響應模式，客戶端發送一個 HTTP 請求，服務就響應此請求。

　　HttpRequest 包格式如下：

　　

1.  包頭
2.  數據部分，后續可以有多個 HttpContent 部分
3.  包尾，標記 request 包結束，同時可能包含頭的尾部信息
4.  完整的 HTTP request

　　HttpResponce 包格式如下：

　　

1.  包頭
2.  數據部分，后續可以有多個 HttpContent 部分
3.  包尾，標記 responce 包結束，同時可能包含頭的尾部信息
4.  完整的 HTTP responce

 　　下面是 Netty 提供的解碼器和編碼器用來處理上述的包信息：

　　

　　所以，如果我們想要在應用程序中支持 HTTP，只需要添加正確的 ChannelHandler 到 ChannelPipeline 中即可：

public class HttpPipelineInitializer extends ChannelInitializer<Channel> {
    private final boolean client;
    
    public HttpPipelineInitializer(boolean client) {
        this.client = client;
    }
    
    @Override
    protected void initChannel(Channel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        if(client) {
            // 客戶端需要解碼服務器響應，編碼客戶端請求
            pipeline.addLast("decoder", new HttpResponseDecoder());
            pipeline.addLast("encoder", new HttpRequestEncoder());
        } else {
            // 服務端需要解碼客戶端請求，編碼服務端響應
            pipeline.addLast("decoder", new HttpRequestDecoder());
            pipeline.addLast("encoder", new HttpResponseEncoder());
        }
    }

}

 

 

 二、HTTP 消息聚合

 　　由於 HTTP 請求和響應消息部分可以由許多塊組成，我們需要聚合它們形成完整的消息。Netty 提供了一個聚合器。如下為簡單實現：

/**
 * HTTP 消息聚合
 * HttpObjectAggregator
 */
public class HttpAggregatorInitializer extends ChannelInitializer<Channel> {
    private final boolean client;
    
    public HttpAggregatorInitializer(boolean client) {
        this.client = client;
    }

    @Override
    protected void initChannel(Channel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        if(client) {
            // 客戶端
            pipeline.addLast("codec", new HttpClientCodec());
        } else {
            // 服務器
            pipeline.addLast("codec", new HttpServerCodec());
        }
        // HTTP聚合，設置最大消息值為512KB
        pipeline.addLast("aggegator", new HttpObjectAggregator(512 * 1024));
    }

}

 

 

 三、HTTP 壓縮

 　　使用 HTTP 時建議壓縮數據以減少傳輸流量，Netty 支持 “gzip”和“deflate”。簡單實現如下：

/**
 * HTTP 壓縮
 * HttpContentDecompressor 用於客戶端解壓縮
 * HttpContentCompressor 用於服務器壓縮
 */
public class HttpCompressorInitializer extends ChannelInitializer<Channel> {
    private final boolean client;
    
    public HttpCompressorInitializer(boolean client) {
        this.client = client;
    }
    
    @Override
    protected void initChannel(Channel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        if(client) {
            // 客戶端
            pipeline.addLast("codec", new HttpClientCodec());
            // 解壓縮，用於處理來自服務器的壓縮內容
            pipeline.addLast("decompressor", new HttpContentDecompressor());
        } else {
            // 服務端
            pipeline.addLast("codec", new HttpServerCodec());
            // 壓縮，將要發送的消息壓縮后再發出
            pipeline.addLast("compressor", new HttpContentCompressor());
        }
    }

}

 

 

 四、使用 HTTPS

　　啟動 HTTPS（比 HTTP 安全），只需添加 SslHandler。簡單實現如下：

/**
 * HTTPS
 */
public class HttpsCodecInitializer extends ChannelInitializer<Channel> {
    private final SslContext context;
    private final boolean client;
    
    public HttpsCodecInitializer(SslContext context, boolean client) {
        this.context = context;
        this.client = client;    
    }

    @Override
    protected void initChannel(Channel ch) throws Exception {
        ChannelPipeline pipeline  = ch.pipeline();
        SSLEngine engine = context.newEngine(ch.alloc());
        
        // 添加SslHandler以啟用HTTPS
        pipeline.addFirst("ssl", new SslHandler(engine));
        if(client) {
            // 客戶端
            pipeline.addLast("codec", new HttpClientCodec());
        } else {
            // 服務端
            pipeline.addLast("codec", new HttpServerCodec());
        }
    }
    
}

 

 

 五、WebSocket

 　　WebSocket 允許數據雙向傳輸，而不需要請求-響應模式。當我們需要服務器主動向客戶端發送消息，比如實時系統，WebSocket 就是一個不錯的選擇。下面是一個通用的 WebSocket 協議：

　　

1.  Client（HTTP）與 Server 通訊
2.  Server（HTTP）與 Client 通訊
3.  Client 通過 HTTP(s) 來進行 WebSocket 握手，並等待確認
4.  連接協議升級至 WebSocket

 　　應用程序支持 WebSocket 只需要添加適當的客戶端或服務器端 WebSocket ChannelHandler 到管道。這個類將處理 WebSocket 定義的信息類型，稱為“幀”。幀類型可分為數據幀和控制幀，如下：

　　

　　簡單實現如下：

/**
 * WebSocket
 * WebSocketServerProtocolHandler 處理其他類型幀
 * TextFrameHandler BinaryFrameHandler ContinuationFrameHandler
 */
public class WebSocketServerInitializer extends ChannelInitializer<Channel> {

    @Override
    protected void initChannel(Channel ch) throws Exception {
        ch.pipeline().addLast(
                new HttpServerCodec(),
                new HttpObjectAggregator(65536),        // HTTP 聚合
                // 處理除指定Frame之外的其他類型幀，比如Ping,Pong,Close等
                new WebSocketServerProtocolHandler("/websocket"),
                new TextFrameHandler(),
                new BinaryFrameHandler(),
                new ContinuationFrameHandler());
    }

    // Text Frame
    public static final class TextFrameHandler 
        extends SimpleChannelInboundHandler<TextWebSocketFrame> {
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, TextWebSocketFrame msg) throws Exception {
            // TODO Handle Text Frame
        }        
    }
    
    // Binary Frame
    public static final class BinaryFrameHandler 
    extends SimpleChannelInboundHandler<BinaryWebSocketFrame> {
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, BinaryWebSocketFrame msg) throws Exception {
            // TODO Handle Text Frame
        }
    }
    
    // Continuation Frame
    public static final class ContinuationFrameHandler 
    extends SimpleChannelInboundHandler<ContinuationWebSocketFrame> {
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, ContinuationWebSocketFrame msg) throws Exception {
            // TODO Handle Text Frame
        }
    }
}