2. 程式人生 > >OKHttp原始碼分析(二)之RequestBody

OKHttp原始碼分析(二)之RequestBody

阿新 • • 發佈：2019-01-31

一，概述

在上篇blog中以get請求為例分析了OKHttp框架的表層原始碼，具體參見：OKHttp原始碼分析（一）

在post請求中用到的API很大部分與get請求中用到的API相同，最大的不同就是Request.Builder類的post方法，這個方法的作用是設定post請求的請求體，接收的引數是RequestBody類及子類物件。

Request.Builder類的post方法的原始碼是：

    public Builder post(RequestBody body) {
      return method("POST", body);
    }

method方法的原始碼是：

    public Builder method(String method, RequestBody body) {
      this.method = method;
      this.body = body;
      return this;
    }

這個方法的作用就是將body物件給Request物件的body欄位賦值。

在OKHttp原始碼分析（一）中我們知道：OKHttpClient物件和Request物件都傳遞給了RealCall類，即可以在RealCall物件中拿到body物件，然後就可以呼叫body的writeTo方法得到流物件，向伺服器寫資料。body的writeTo方法中的程式碼原理類似於httpURLconnection的post方式上傳引數，我們可以對比學習。

具體在哪兒呼叫的body的writeTo方法不是本篇的重點，本篇的重點是分析RequestBody類及其子類。
具體為以下幾點：
1，RequestBody類中核心方法
2，RequestBody類中Create方法
3，FromBody類
4，MultipartBody類

二，RequestBody類及其核心方法

RequestBody類是請求體類，這是上傳資料的核心類，它的writeTo方法可以得到流物件，然後將請求體資料寫到伺服器。這是上傳資料的核心方法。

RequestBody類中核心方法有以下三個：

1，public abstract MediaType contentType
 
()//資料型別
2，public long contentLength()//資料長度
3，public abstract void writeTo(BufferedSink sink)//寫操作

對於熟悉http協議的小夥伴都知道，在http上傳資料時都有資料型別和資料長度，所以前兩個方法就不做介紹。下面重點看第三個方法。

RequestBody類中的writeTo方法是抽象方法，具體實現在子類中，所以具體寫資料的邏輯也在子類中。這兒需要說明的是BufferedSink 類。

BufferedSink 類是square公司開源的IO框架Okio中的一個類，這個類封裝了OutputStream，即本質是一個輸出流，具有write方法。Okio框架和BufferedSink 類也不是本篇介紹的重點，這兒不做講解。把BufferedSink 當成OutputStream使用即可。

三，RequestBody類的create方法

我們知道RequestBody是一個抽象類，它不能進行例項化。因此RequestBody類提供了create方法來建立RequestBody的例項物件。

RequestBody類的create方法有多個過載，但重要的方法只有兩個：

//1，建立上傳byte資料的RequestBody物件。
create(final MediaType contentType, final byte[] content,final int offset, final int byteCount)
//2，建立上傳File資料的RequestBody物件。
create(final MediaType contentType, final File file)

1，建立上傳byte資料的RequestBody物件

這個方法的表面意思是上傳byte資料，但根據程式設計師的第六感覺可以清晰的發現它可以上傳String資料和file資料。因為String資料和file資料都可以輕鬆轉換成byte陣列。由於File檔案較大，轉換成Byte陣列太佔記憶體，所以提供了File資料的專用方法。對於上傳String資料常常使用該方法。在OKHttp的使用詳解中上傳Json資料底層呼叫的就是該方法。

方法的原碼是：

  public static RequestBody create(final MediaType contentType, final byte[] content,
      final int offset, final int byteCount) {
    return new RequestBody() {
      @Override public MediaType contentType() {
        return contentType;
      }

      @Override public long contentLength() {
        return byteCount;
      }

      @Override public void writeTo(BufferedSink sink) throws IOException {
        sink.write(content, offset, byteCount);
      }
    };
  }

其實方法的實現很簡單，就是建立RequestBody 的子類物件，並重寫三個方法。下面注重看writeTo方法。writeTo方法的實現只有一行程式碼：
sink.write(content, offset, byteCount);

這行程式碼的意思是：寫byte陣列，從offset開始，寫byteCount長度。
sink.write方法就類似於OutputStream的write方法，此時我們應該明白這行程式碼的含義了。

此時我們發現：OKHttp雖然是偏底層的網路請求框架，但底層實現並不麻煩，這與httpURLconnection的用法很類似。

2，建立上傳File資料的RequestBody物件

方法的原碼如下：

  public static RequestBody create(final MediaType contentType, final File file) {
    if (file == null) throw new NullPointerException("content == null");

    return new RequestBody() {
      @Override public MediaType contentType() {
        return contentType;
      }

      @Override public long contentLength() {
        return file.length();
      }

      @Override public void writeTo(BufferedSink sink) throws IOException {
        Source source = null;
        try {
          source = Okio.source(file);
          sink.writeAll(source);
        } finally {
          Util.closeQuietly(source);
        }
      }
    };
  }

這個方法也是建立RequestBody類的例項物件，下面也重點看writeTo方法。writeTo方法的核心程式碼是：

source = Okio.source(file);//根據檔案得到輸入流物件。
sink.writeAll(source);//將輸入流物件寫出去。

writeAll是RealBufferSink類的方法，這個也是屬於Okio框架中的。方法的原碼是：

  @Override public long writeAll(Source source) throws IOException {
    long totalBytesRead = 0;
    for (long readCount; (readCount = source.read(buffer, Segment.SIZE)) != -1; ) {
      totalBytesRead += readCount;
      emitCompleteSegments();
    }
    return totalBytesRead;
  }

emitCompleteSegments方法的原始碼是：

  @Override public BufferedSink emitCompleteSegments() throws IOException {
    if (closed) throw new IllegalStateException("closed");
    long byteCount = buffer.completeSegmentByteCount();
    if (byteCount > 0) sink.write(buffer, byteCount);
    return this;
  }

有沒有一種很熟悉的感覺。對，這就是常用的IO流操作。

四，FormBody類

雖然RequestBody提供了create方法可以上傳String型別資料。但對於上傳鍵值對資料來說需要拼接資料，比較麻煩，所以框架中提供了專業上傳鍵值對資料的FormBody類。

FormBody類的基本用法如下：

 FormBody.Builder formBody = new FormBody.Builder();//建立表單請求體
 formBody.add("username","zhangsan");//傳遞鍵值對引數
 formBody.add("password","000000");//傳遞鍵值對引數
 RequestBody body= formBody.build();

這兒明顯是Builder設計模式。

1，分析FormBody的內部類Builder類

Builder是FormBody的內部類，原碼是：

public static final class Builder {
    private final List<String> names = new ArrayList<>();
    private final List<String> values = new ArrayList<>();

    public Builder add(String name, String value) {
      names.add(HttpUrl.canonicalize(name, FORM_ENCODE_SET, false, false, true, true));
      values.add(HttpUrl.canonicalize(value, FORM_ENCODE_SET, false, false, true, true));
      return this;
    }
    public FormBody build() {
      return new FormBody(names, values);
    }
  }

這個類的邏輯非常簡單，重點如下：
1，首先建立兩個list集合，分別用來盛放key和value；
2，add方法的作用就是將鍵值對分別放入兩個集合中。
3，build方法的作用是將key集合與value集合傳遞給FormBody物件。

2，FormBody類的writeTo方法

下面看重點，FormBody類的writeTo方法的原碼：

  @Override public void writeTo(BufferedSink sink) throws IOException {
    writeOrCountBytes(sink, false);
  }

writeOrCountBytes方法的核心原碼是：

private long writeOrCountBytes(BufferedSink sink, boolean countBytes) {
    long byteCount = 0L;

    Buffer buffer;
    if (countBytes) {
      buffer = new Buffer();
    } else {
      buffer = sink.buffer();
    }

    for (int i = 0, size = encodedNames.size(); i < size; i++) {
      if (i > 0) buffer.writeByte('&');
      buffer.writeUtf8(encodedNames.get(i));
      buffer.writeByte('=');
      buffer.writeUtf8(encodedValues.get(i));
    }

    if (countBytes) {
      byteCount = buffer.size();
      buffer.clear();
    }

    return byteCount;
  }

看到這兒是不是仍是一種熟悉的感覺，在使用HttpURLconnection的post請求傳遞鍵值對引數時就是這麼拼接的。

五，MultipartBody類

根據類名就可得知這個類是多重的body，即可以上傳鍵值對資料，又可以同時上傳File資料。比如在微信中發朋友圈時，既需要上傳文字又需要上傳圖片，此時就需要使用這種多重的body。

MultipartBody類的基本使用如下：

MultipartBody multipartBody =new MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        .addFormDataPart("groupId",""+groupId)//新增鍵值對引數
        .addFormDataPart("title","title")
        .addFormDataPart("file",file.getName(),RequestBody.create(MediaType.parse("file/*"), file))//新增檔案
        .build();

這兒明顯也是builder設計模式。

1，分析MultipartBody 內部類builder

MultipartBody 實現同時上傳鍵值對資料和File資料的原理與httpURLconnection相似，都是仿照Web中提交Form表單資料時的資料格式。

下面看addFormDataPart方法，這個方法有兩個重要過載：

//1，新增鍵值對資料
addFormDataPart(String name, String value)
//2，新增File資料
addFormDataPart(String name, String filename, RequestBody body)

首先看新增鍵值對資料addFormDataPart方法的原始碼：

    public Builder addFormDataPart(String name, String value) {
      return addPart(Part.createFormData(name, value));
    }

再看addPart方法：

    public Builder addPart(Part part) {
      if (part == null) throw new NullPointerException("part == null");
      parts.add(part);
      return this;
    }

這個方法的本質將Part物件賦值給Builder的parts欄位。下面看part物件的建立。

在addFormDataPart方法中可知，part物件建立的程式碼是：
Part.createFormData(name, value)。
方法的原始碼是：

    public static Part createFormData(String name, String value) {
      return createFormData(name, null, RequestBody.create(null, value));
    }

createFormData方法的原始碼是：

    public static Part createFormData(String name, String filename, RequestBody body) {
      StringBuilder disposition = new StringBuilder("form-data; name=");
      appendQuotedString(disposition, name);

      if (filename != null) {
        disposition.append("; filename=");
        appendQuotedString(disposition, filename);
      }

      return create(Headers.of("Content-Disposition", disposition.toString()), body);
    }

此時開始初步仿照web中提交form表單資料的格式進行封裝。將name和fileName封裝到Header物件中。

Part類的create方法的原始碼是：

    public static Part create(Headers headers, RequestBody body) {
      return new Part(headers, body);
    }

將header物件和body物件傳遞給part物件，然後將part物件放入Builder的欄位parts集合中。

首先看新增File資料addFormDataPart方法的原始碼：

   public Builder addFormDataPart(String name, String filename, RequestBody body) {
      return addPart(Part.createFormData(name, filename, body));
    }

首先將File物件得到body物件。下面的方法addPart和Part類的createFormData方法都已經講解過。

新增File資料的流程如下：
1，首先將File物件得到body物件。
2，將name和fileName封裝到Header物件中。
3，將header物件和body物件傳遞給part物件，然後將part物件放入Builder的欄位parts集合中。

最後看Builder類的build方法：

    public MultipartBody build() {
      return new MultipartBody(boundary, type, parts);
    }

建立MultipartBody物件，將三個引數傳遞過去。
boundary和type作用是封裝資料格式，parts中封裝了header和body資料。

2，分析MultipartBody類的WriteTo方法

方法的原始碼是：

  @Override public void writeTo(BufferedSink sink) throws IOException {
    writeOrCountBytes(sink, false);
  }

writeOrCountBytes方法的原始碼如下：

private long writeOrCountBytes(BufferedSink sink, boolean countBytes) throws IOException {
    long byteCount = 0L;

    Buffer byteCountBuffer = null;

    for (int p = 0, partCount = parts.size(); p < partCount; p++) {//遍歷part集合
      Part part = parts.get(p);
      Headers headers = part.headers;
      RequestBody body = part.body;

      sink.write(DASHDASH);//寫資料格式字元
      sink.write(boundary);
      sink.write(CRLF);

      if (headers != null) {
        for (int h = 0, headerCount = headers.size(); h < headerCount; h++) {
          sink.writeUtf8(headers.name(h))
              .write(COLONSPACE)
              .writeUtf8(headers.value(h))
              .write(CRLF);//寫Header資料
        }
      }

      MediaType contentType = body.contentType();
      if (contentType != null) {
        sink.writeUtf8("Content-Type: ")
            .writeUtf8(contentType.toString())
            .write(CRLF);
      }

      long contentLength = body.contentLength();
      if (contentLength != -1) {
        sink.writeUtf8("Content-Length: ")
            .writeDecimalLong(contentLength)
            .write(CRLF);
      } else if (countBytes) {
        byteCountBuffer.clear();
        return -1L;
      }

      sink.write(CRLF);

      if (countBytes) {
        byteCount += contentLength;
      } else {
        body.writeTo(sink);//寫body資料
      }

      sink.write(CRLF);
    }

    sink.write(DASHDASH);//寫資料格式字元
    sink.write(boundary);
    sink.write(DASHDASH);
    sink.write(CRLF);

    if (countBytes) {
      byteCount += byteCountBuffer.size();
      byteCountBuffer.clear();
    }

    return byteCount;
  }

MultipartBody類的WriteTo方法稍微有些複雜，但這部分程式碼是上傳資料的關鍵，值得我們研究學習。

相關推薦

OKHttp原始碼分析(二)之RequestBody

一，概述 在上篇blog中以get請求為例分析了OKHttp框架的表層原始碼，具體參見：OKHttp原始碼分析（一） 在post請求中用到的API很大部分與get請求中用到的API相同，最大的不同就是Request.Builder類的post方法，這個方法的

RxJava2原始碼分析二之just、fromArray、fromIterable

     Observable.just：接收1個以上,10個以下的引數，然後逐個發射。         Observable.fromArray：接收一個數組，從陣列中一個一個取出來發射。  

Redux原始碼分析(二)之combineReducers

Redux原始碼分析(combineReducers) 上一篇我們看完了createStore這個自認為最為核心的檔案之後，我們再來看下combineReducers.js這個檔案，其他它最主要的作用就是合併多個reducer，因為在createStore中的第

springsession原始碼分析二之RedisHttpSessionConfiguration

SpringHttpSessionConfiguration SpringHttpSessionConfiguration是RedisHttpSessionConfiguration的父類 程式碼 @Configuration public cl

OkHttp原始碼詳解之二完結篇

1. 請大家思考幾個問題 在開始本文之前，請大家思考如下幾個問題。並請大家帶著這幾個問題，去本文尋找答案。如果你對下面幾個問題的答案瞭如指掌那本文可以略過不看 在瀏覽器中輸入一個網址，按回車後發生了什麼？ Okhttp的TCP連線建立發生在什麼時候？ Okht

原始碼分析篇之String原始碼分析二

    前面已經分析過String原始碼為什麼是不可變的，同時通過我們常用的String的相關的類StringBuffer和StringBuilder，我們可以發現String類中欄位名被定義為了final型別，這樣的話將只能被賦值一次。接下來，繼續看String原始碼實現的

UNIX v6原始碼分析除錯之二：單步除錯系統程式碼 main函式之 kinit1

    環境搭建完成，該學習Main.c的main函數了。先貼上main函式的實現。int main(void) { kinit1(end, P2V(4*1024*1024)); // phys page allocator kvmalloc(); // k

Okhttp使用和原始碼分析二(OkHttp3.x用法)

上一篇介紹了OkHttp2.x的用法，這一篇文章我們來對照OkHttp2.x版本來看看，OkHttp3使用起來有那些變化？ 1.使用前準備,Android Studio 配置gradle： compile 'com.squareup.okhttp3:okht

Spring5原始碼深度分析(二)之理解@Conditional,@Import註解

 程式碼地址：https://github.com/showkawa/spring-annotation/tree/master/src/main/java/com/brian 1.原始碼分析二主要分析的內容 1.使用@Condition多條件註冊bean物件2.@Import註解快速注入第三方

Qt update重新整理之原始碼分析(二)

大家好，我是IT文藝男，來自一線大廠的一執行緒序員 上次視訊給大家從原始碼層面剖析了Qt update重新整理機制的非同步事件投遞過程，這次視訊主要從原始碼層面剖析Qt重新整理事件(QEvent::UpdateRequest)的處理過程 我們追蹤QEvent::UpdateRequest事件處理，進入訊息

NSQ原始碼分析(二）—— Topic

Topic是NSQ非常重要的概念，本次主要講述Topic的獲取、新建、Topic中訊息的輪詢、Topic中訊息的來源、Topic的刪除和退出以及Topic的暫停和取消暫停 topic的相關操作主要在nsq/nsqd/topic.go中 首先看下Topic結構體 type Topic st

【Android】OkHttp原始碼分析

Android為我們提供了兩種HTTP互動的方式：HttpURLConnection 和 Apache HttpClient，雖然兩者都支援HTTPS，流的上傳和下載，配置超時，IPv6和連線池，已足夠滿足我們各種HTTP請求的需求。但更高效的使用HTTP 可以讓您的應用執行更快、更節省

Django rest framework 許可權操作(原始碼分析二)

知識回顧  這一篇是基於上一篇寫的，上一篇謝了認證的具體流程，看懂了上一篇這一篇才能看懂， 當用戶訪問是 首先執行dispatch函式，當執行當第二部時： #2.處理版本資訊 處理認證資訊 處理許可權資訊 對使用者的訪問頻率進行限制 self

OkHttp原始碼詳解之Okio原始碼詳解

請在電腦上閱讀，效果更佳 本文將從兩個技術點講解OkHttp 1. 講解Okio，因為Okhttp的IO操作都是基於Okio，拋開Okio的OkHttp講解是不完美的 2. 講解OkHttp原始碼 Okio 1. Okio簡介 引用官方的一段介紹 Okio是一個補

Dubbo 原始碼分析系列之三 —— 架構原理

1 核心功能 首先要了解Dubbo提供的三大核心功能： Remoting:遠端通訊 提供對多種NIO框架抽象封裝，包括“同步轉非同步”和“請求-響應”模式的資訊交換方式。 Cluster: 服務框架 提供基於介面方法的透明遠端過程呼叫，包括多協議支援，以及

Elastic-Job原始碼解析(二)之定時核心實現quartz

Elastic-Job是一個分散式定時任務框架,其內部的定時主要是利用quartz來實現,而Elastic-Job核心是對quartz進行了封裝,並提供了分散式任務的功能。具體是怎麼實現呢? 怎麼實現分散式呢? 主要是通過Zookeeper通訊,獲取任務伺服器ip地址,並通

android okhttp原始碼分析

okhttp是Square公司開發貢獻的，其功能強大，現在是安卓主流網路框架。 現在我們就看看這個框架牛逼之處，探究其原始碼。 compile 'com.squareup.okhttp3:okhttp:3.8.0' 我們分析的版本是3.8.0. public class

Java程式設計師從笨鳥到菜鳥之（八十一）細談Spring（十）深入原始碼分析Spring之HibernateTemplate

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！        

WebSocket學習——結合OkHttp原始碼分析

轉自：https://www.jianshu.com/p/ba0f45aa7457 前言 最近公司有專案需要用WebSocket完成及時通訊的需求，這裡來學習一下。 WebScoket簡介 在以前的web應用中，雙向通訊機制往往藉助輪詢或是長輪詢來實現，但是這兩種方式都會或多或少的造

okhttp原始碼分析（一）——基本流程（超詳細）

1.okhttp原始碼分析（一）——基本流程（超詳細） 2.okhttp原始碼分析（二）——RetryAndFollowUpInterceptor過濾器 3.okhttp原始碼分析（三）——CacheInterceptor過濾器 4.okhttp原始碼分析（四）——Conn