netty系列之:自建客戶端和HTTP伺服器互動

flydean發表於2021-08-31

簡介

上一篇文章,我們搭建了一個支援中文的HTTP伺服器,並且能夠從瀏覽器訪問,並獲取到相應的結果。雖然瀏覽器在日常的應用中很普遍,但是有時候我們也有可能從自建的客戶端來呼叫HTTP伺服器的服務。

今天給大家介紹如何自建一個HTTP客戶端來和HTTP伺服器進行互動。

使用客戶端構建請求

在上一篇文章中,我們使用瀏覽器來訪問伺服器,並得到到了響應的結果,那麼如何在客戶端構建請求呢?

netty中的HTTP請求可以分成兩個部分,分別是HttpRequest和HttpContent。其中HttpRequest只包含了請求的版本號和訊息頭的資訊,HttpContent才包含了真正的請求內容資訊。

但是如果要構建一個請求的話,需要同時包含HttpRequest和HttpContent的資訊。netty提供了一個請求類叫做DefaultFullHttpRequest,這個類同時包含了兩部分的資訊,可以直接使用。

使用DefaultFullHttpRequest的建構函式,我們就可以構造出一個HttpRequest請求如下:

HttpRequest request = new DefaultFullHttpRequest(
                    HttpVersion.HTTP_1_1, HttpMethod.GET, uri.getRawPath(), Unpooled.EMPTY_BUFFER);

上面的程式碼中,我們使用的協議是HTTP1.1,方法是GET,請求的content是一個空的buffer。

構建好基本的request資訊之後,我們可能還需要在header中新增一下額外的資訊,比如connection,accept-encoding還有cookie的資訊。

比如設定下面的資訊:

request.headers().set(HttpHeaderNames.HOST, host);
            request.headers().set(HttpHeaderNames.CONNECTION, HttpHeaderValues.CLOSE);
            request.headers().set(HttpHeaderNames.ACCEPT_ENCODING, HttpHeaderValues.GZIP);

還有設定cookie:

request.headers().set(
                    HttpHeaderNames.COOKIE,
                    ClientCookieEncoder.STRICT.encode(
                            new DefaultCookie("name", "flydean"),
                            new DefaultCookie("site", "www.flydean.com")));

設定cookie我們使用的是ClientCookieEncoder.encode方法,ClientCookieEncoder有兩種encoder模式,一種是STRICT,一種是LAX。

在STRICT模式下,會對cookie的name和value進行校驗和排序。

和encoder對應的就是ClientCookieDecoder,用於對cookie進行解析。

設定好我們所有的request之後就可以寫入到channel中了。

accept-encoding

在客戶端寫入請求的時候,我們在請求頭上新增了accept-encoding,並將其值設定為GZIP,表示客戶端接收的編碼方式是GZIP。

如果伺服器端傳送了GZIP的編碼內容之後,客戶端怎麼進行解析呢?我們需要對GZIP的編碼格式進行解碼。

netty提供了HttpContentDecompressor類,可以對gzip或者deflate格式的編碼進行解碼。在解碼之後,會同時修改響應頭中的“Content-Encoding”和“Content-Length”。

我們只需要將其新增到pipline中即可。

和它對應的類是HttpContentCompressor,用於對HttpMessage和HttpContent進行gzip或者deflate編碼。

所以說HttpContentDecompressor應該被新增到client的pipline中,而HttpContentCompressor應該被新增到server端的pipline中。

server解析HTTP請求

server需要一個handler來解析客戶端請求過來的訊息。對於伺服器來說,解析客戶端的請求應該注意哪些問題呢?

首先要注意的是客戶端100 Continue請求的問題。

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

如果伺服器收到100Continue請求的話,直接返回確認即可:

if (HttpUtil.is100ContinueExpected(request)) {
                send100Continue(ctx);
            }

    private static void send100Continue(ChannelHandlerContext ctx) {
        FullHttpResponse response = new DefaultFullHttpResponse(HTTP_1_1, CONTINUE, Unpooled.EMPTY_BUFFER);
        ctx.write(response);
    }

如果不是100請求的話,server端就可以準備要返回的內容了:

這裡用一個StringBuilder來儲存要返回的內容:

StringBuilder buf = new StringBuilder();

為什麼要用StringBuf呢?是因為有可能server端一次並不能完全接受客戶端的請求,所以將所有的要返回的內容都放到buffer中,等全部接受之後再一起返回。

我們可以向server端新增歡迎資訊,可以可以新增從客戶端獲取的各種資訊:

buf.setLength(0);
            buf.append("歡迎來到www.flydean.com\r\n");
            buf.append("===================================\r\n");

            buf.append("VERSION: ").append(request.protocolVersion()).append("\r\n");
            buf.append("HOSTNAME: ").append(request.headers().get(HttpHeaderNames.HOST, "unknown")).append("\r\n");
            buf.append("REQUEST_URI: ").append(request.uri()).append("\r\n\r\n");

還可以向buffer中新增請求頭資訊:

HttpHeaders headers = request.headers();
            if (!headers.isEmpty()) {
                for (Entry<String, String> h: headers) {
                    CharSequence key = h.getKey();
                    CharSequence value = h.getValue();
                    buf.append("HEADER: ").append(key).append(" = ").append(value).append("\r\n");
                }
                buf.append("\r\n");
            }

可以向buffer中新增請求引數資訊:

            QueryStringDecoder queryStringDecoder = new QueryStringDecoder(request.uri());
            Map<String, List<String>> params = queryStringDecoder.parameters();
            if (!params.isEmpty()) {
                for (Entry<String, List<String>> p: params.entrySet()) {
                    String key = p.getKey();
                    List<String> vals = p.getValue();
                    for (String val : vals) {
                        buf.append("PARAM: ").append(key).append(" = ").append(val).append("\r\n");
                    }
                }
                buf.append("\r\n");
            }

要注意的是當讀取到HttpContent的時候的處理方式。如果讀取的訊息是HttpContent,那麼將content的內容新增到buffer中:

if (msg instanceof HttpContent) {
            HttpContent httpContent = (HttpContent) msg;

            ByteBuf content = httpContent.content();
            if (content.isReadable()) {
                buf.append("CONTENT: ");
                buf.append(content.toString(CharsetUtil.UTF_8));
                buf.append("\r\n");
                appendDecoderResult(buf, request);
            }

那麼怎麼判斷一個請求是否結束了呢?netty提供了一個類叫做LastHttpContent,這個類表示的是訊息的最後一部分,當收到這一部分訊息之後,我們就可以判斷一個HTTP請求已經完成了,可以正式的返回訊息了:

if (msg instanceof LastHttpContent) {
                log.info("LastHttpContent:{}",msg);
                buf.append("END OF CONTENT\r\n");

要寫回channel,同樣需要構建一個DefaultFullHttpResponse,這裡使用buffer來進行構建:

FullHttpResponse response = new DefaultFullHttpResponse(
                HTTP_1_1, currentObj.decoderResult().isSuccess()? OK : BAD_REQUEST,
                Unpooled.copiedBuffer(buf.toString(), CharsetUtil.UTF_8));

然後新增一些必須的header資訊就可以呼叫ctx.write進行回寫了。

總結

本文介紹瞭如何在client構建HTTP請求,並詳細講解了HTTP server對HTTP請求的解析流程。

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

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

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

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

相關文章