netty系列之:輕輕鬆鬆搭個支援中文的伺服器

flydean發表於2021-08-30
Netty伺服器

目錄

簡介

之前講了那麼多關於netty的文章，都是講netty的底層原理和實現，各位小夥伴一定都在想了，看了這麼多篇文章，netty到底能幹啥呢？今天讓我們來使用netty簡簡單單搭一個支援中文的伺服器，展示一下netty的威力。

netty的HTTP支援

今天我們搭的伺服器是支援HTTP1.1的伺服器。在netty中搭建伺服器就像是拼房子，找到合適的工具就可以事半功倍。那麼要搭建HTTP的房子，netty提供了什麼樣的工具呢？

在講解netty對HTTP的支援之前，我們先看一下HTTP的版本發展情況。

HTTP的全稱是Hypertext Transfer Protocol，是在1989年World Wide Web發展起來之後出現的標準協議，用來在WWW上傳輸資料。HTTP/1.1是1997年在原始的HTTP協議基礎上進行的補充和優化。

到了2015年，為了適應快速傳送的web應用和現代瀏覽器的需求，發展出了新的HTTP/2協議，主要在手機瀏覽器、延時處理、影像處理和視訊處理方面進行了優化。

基本上所有的現代瀏覽器都支援HTTP/2協議了，但是還有很多應用程式使用的是老的HTTP/1.1協議。netty為HTTP2和HTTP1提供了不同的支援包，對於HTTP1的支援包叫做netty-codec-http,對HTTP2支援的包叫做netty-codec-http2。

本文會講解netty對HTTP1的支援，將會在後續的文章中繼續HTTP2的介紹。

netty-codec-http提供了對HTTP的非常有用的一些封裝。

首先是代表HTTP中傳輸物件的類HttpObject，這個類代表著傳輸中的所有物件。繼承這個類的物件有兩個非常重要的物件，分別是HttpMessage和HttpContent。

HttpMessage可能跟我想象的不太一樣，它實際上只包含了兩部分內容，分別是HttpVersion和HttpHeaders，但是並不包含任何內容。

public interface HttpMessage extends HttpObject {

    HttpVersion protocolVersion();

    HttpMessage setProtocolVersion(HttpVersion version);

    HttpHeaders headers();
}

這裡HttpVersion只支援HTTP/1.0和HTTP/1.1協議。而HttpHeaders就是對HTTP請求中頭物件的封裝。

HttpMessage的子類是HttpRequest和HttpResponse，所以這兩個類本身是不帶請求內容的。

而具體請求的內容是在HttpContent中，HttpContent繼承自ByteBufHolder，表示它中間可以帶有ByteBuf的內容資訊。

而HttpContent真正的實現類就是DefaultFullHttpRequest和DefaultFullHttpResponse，這兩個內包含了HTTP頭和HTTP請求響應內容資訊。

那麼問題來了，為什麼要把HTTP頭和HTTP內容分開呢？

這就涉及到HTTP1.1中訊息傳輸中的壓縮機制了。為了提升傳輸的效率，一般來說在傳輸的的過程中都會物件訊息進行壓縮，但是對於HTTP1.1來說，頭部的內容是沒辦法壓縮的，只能壓縮content部分，所以需要區別對待。

netty中使用HTTP的原理

我們知道netty底層是客戶端和伺服器端構建通道，通過通道來傳輸ByteBuf訊息。那麼netty是怎麼支援HTTP請求呢？

當客戶端向伺服器端傳送HTTP請求之後，伺服器端需要把接收到的資料使用解碼器解碼成為可以被應用程式使用的各種HttpObject物件，從而能夠在應用程式中對其解析。

netty提供了HttpResponseEncoder和HttpRequestDecoder類，來對HTTP的訊息進行編碼和解碼。

如果不想分別使用兩個類來進行編碼和解碼，netty還提供了HttpServerCodec類來進行編碼和解碼工作。

這個類包含了HttpRequestDecoder和HttpResponseEncoder兩部分的工作，可以同時用來進行編碼和解碼。

100 (Continue) Status

在HTTP中有一個獨特的功能叫做，100 (Continue) Status，就是說client在不確定server端是否會接收請求的時候，可以先傳送一個請求頭，並在這個頭上加一個"100-continue"欄位，但是暫時還不傳送請求body。直到接收到伺服器端的響應之後再傳送請求body。

為了處理這種請求，netty提供了一個HttpServerExpectContinueHandler物件，用來處理100 Status的情況。

當然，如果你的客戶端沒有這種請求，那麼可以直接使用HttpObjectAggregator來將HttpMessage和HttpContent和合併成為FullHttpRequest或者FullHttpResponse。

為netty搭建HTTP伺服器

有了上面的工作，我們就可以使用netty搭建http伺服器了。最關鍵的一點就是在HttpRequestServerInitializer新增對應的codec和自定義handler。

    public void initChannel(SocketChannel ch) {
        ChannelPipeline p = ch.pipeline();
        p.addLast(new HttpServerCodec());
        p.addLast(new HttpServerExpectContinueHandler());
        p.addLast(new HttpRequestServerHandler());
    }

在自定義的handler中，我們需要實現一個功能，就是當收到客戶端的請求時候，需要返回給客戶端一段歡迎語。

首先將獲得的HttpObject轉換成為HttpRequest物件，然後根據請求物件構建一個DefaultFullHttpResponse物件，然後設定該response物件的頭，最後將該物件寫到channel中。

對應的關鍵程式碼如下：

 private static final byte[] CONTENT = "歡迎來到www.flydean.com!".getBytes(StandardCharsets.UTF_8);

    public void channelRead0(ChannelHandlerContext ctx, HttpObject msg) {
        if (msg instanceof HttpRequest) {
            HttpRequest req = (HttpRequest) msg;

            boolean keepAlive = HttpUtil.isKeepAlive(req);
            FullHttpResponse response = new DefaultFullHttpResponse(req.protocolVersion(), OK,
                                                                    Unpooled.wrappedBuffer(CONTENT));
            response.headers()
//                    .set(CONTENT_TYPE, TEXT_PLAIN)
                    .set(CONTENT_TYPE, "text/plain;charset=utf-8")
                    .setInt(CONTENT_LENGTH, response.content().readableBytes());

            if (keepAlive) {
                if (!req.protocolVersion().isKeepAliveDefault()) {
                    //設定header connection=keep-alive
                    response.headers().set(CONNECTION, KEEP_ALIVE);
                }
            } else {
                // 如果keepAlive是false，則設定header connection=close
                response.headers().set(CONNECTION, CLOSE);
            }
            ChannelFuture f = ctx.write(response);
            if (!keepAlive) {
                f.addListener(ChannelFutureListener.CLOSE);
            }
        }
    }

上面的關鍵程式碼中CONTENT包含了中文字串，我們使用getBytes將其轉換成了UTF-8編碼的byte陣列。那麼如果要想客戶端能夠正確識別UTF-8編碼，需要在response的header中設定內容型別檔案為："text/plain;charset=utf-8"。

最後，使用下面的程式碼啟動server：

 // server配置
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        try {
            ServerBootstrap b = new ServerBootstrap();
            b.option(ChannelOption.SO_BACKLOG, 1024);
            b.group(bossGroup, workerGroup)
             .channel(NioServerSocketChannel.class)
             .handler(new LoggingHandler(LogLevel.INFO))
             .childHandler(new HttpRequestServerInitializer());

            Channel ch = b.bind(PORT).sync().channel();
            log.info("請開啟你的瀏覽器，訪問 http://127.0.0.1:8000/");
            ch.closeFuture().sync();
        } finally {
            bossGroup.shutdownGracefully();
            workerGroup.shutdownGracefully();
        }

總結

現在，使用你的瀏覽器訪問你搭建的伺服器地址，你就可以得到"歡迎來到www.flydean.com!"。 到此一個簡單的netty伺服器就完成了。

本文的例子可以參考：learn-netty4

本文已收錄於 http://www.flydean.com/19-netty-http-client-request/

最通俗的解讀，最深刻的乾貨，最簡潔的教程，眾多你不知道的小技巧等你來發現！

歡迎關注我的公眾號:「程式那些事」,懂技術，更懂你！

相關文章