Volley 源碼解析

来源:http://www.cnblogs.com/jycboy/archive/2017/02/06/6370505.html
-Advertisement-
Play Games

1. 功能介紹 1.1. Volley Volley 是 Google 推出的 Android 非同步網路請求框架和圖片載入框架。在 Google I/O 2013 大會上發佈。 名字由來：a burst or emission of many things or a large amount at ...


1. 功能介紹

1.1. Volley

Volley 是 Google 推出的 Android 非同步網路請求框架和圖片載入框架。在 Google I/O 2013 大會上發佈。

名字由來：a burst or emission of many things or a large amount at once
發佈演講時候的配圖
Volley

從名字由來和配圖中無數急促的火箭可以看出 Volley 的特點：特別適合數據量小，通信頻繁的網路操作。（個人認為 Android 應用中絕大多數的網路操作都屬於這種類型）。

1.2 Volley 的主要特點

(1). 擴展性強。Volley 中大多是基於介面的設計，可配置性強。
(2). 一定程度符合 Http 規範，包括返回 ResponseCode(2xx、3xx、4xx、5xx）的處理，請求頭的處理，緩存機制的支持等。並支持重試及優先順序定義。
(3). 預設 Android2.3 及以上基於 HttpURLConnection，2.3 以下基於 HttpClient 實現，這兩者的區別及優劣在4.2.1 Volley中具體介紹。
(4). 提供簡便的圖片載入工具。

2. 總體設計

2.1 總體設計圖

總體設計圖
上面是 Volley 的總體設計圖，主要是通過兩種Dispatch Thread不斷從RequestQueue中取出請求，根據是否已緩存調用Cache或Network這兩類數據獲取介面之一，從記憶體緩存或是伺服器取得請求的數據，然後交由ResponseDelivery去做結果分發及回調處理。

2.2 Volley 中的概念

簡單介紹一些概念，在詳細設計中會仔細介紹。
Volley 的調用比較簡單，通過 newRequestQueue(…) 函數新建並啟動一個請求隊列RequestQueue後，只需要往這個RequestQueue不斷 add Request 即可。

Volley：Volley 對外暴露的 API，通過 newRequestQueue(…) 函數新建並啟動一個請求隊列RequestQueue。

Request：表示一個請求的抽象類。StringRequest、JsonRequest、ImageRequest 都是它的子類，表示某種類型的請求。

RequestQueue：表示請求隊列，裡面包含一個CacheDispatcher(用於處理走緩存請求的調度線程)、NetworkDispatcher數組(用於處理走網路請求的調度線程)，一個ResponseDelivery(返回結果分發介面)，通過 start() 函數啟動時會啟動CacheDispatcher和NetworkDispatchers。

CacheDispatcher：一個線程，用於調度處理走緩存的請求。啟動後會不斷從緩存請求隊列中取請求處理，隊列為空則等待，請求處理結束則將結果傳遞給ResponseDelivery去執行後續處理。當結果未緩存過、緩存失效或緩存需要刷新的情況下，該請求都需要重新進入NetworkDispatcher去調度處理。

NetworkDispatcher：一個線程，用於調度處理走網路的請求。啟動後會不斷從網路請求隊列中取請求處理，隊列為空則等待，請求處理結束則將結果傳遞給ResponseDelivery去執行後續處理，並判斷結果是否要進行緩存。

ResponseDelivery：返回結果分發介面，目前只有基於ExecutorDelivery的在入參 handler 對應線程內進行分發。

HttpStack：處理 Http 請求，返回請求結果。目前 Volley 中有基於 HttpURLConnection 的HurlStack和 基於 Apache HttpClient 的HttpClientStack。

Network：調用HttpStack處理請求，並將結果轉換為可被ResponseDelivery處理的NetworkResponse。

Cache：緩存請求結果，Volley 預設使用的是基於 sdcard 的DiskBasedCache。NetworkDispatcher得到請求結果後判斷是否需要存儲在 Cache，CacheDispatcher會從 Cache 中取緩存結果。

3. 流程圖

Volley 請求流程圖
Volley 請求流程圖

上圖是 Volley 請求時的流程圖，在 Volley 的發佈演講中給出，我在這裡將其用中文重新畫出。

4. 詳細設計

4.1 類關係圖

類關係圖
這是 Volley 框架的主要類關係圖

圖中紅色圈內的部分，組成了 Volley 框架的核心，圍繞 RequestQueue 類，將各個功能點以組合的方式結合在了一起。各個功能點也都是以介面或者抽象類的形式提供。
紅色圈外面的部分，在 Volley 源碼中放在了 toolbox 包中，作為 Volley 為各個功能點提供的預設的具體實現。
通過類圖我們看出， Volley 有著非常好的拓展性。通過各個功能點的介面，我們可以給出自定義的，更符合我們需求的具體實現。

多用組合，少用繼承；針對介面編程，不針對具體實現編程。

優秀框架的設計，令人叫絕，受益良多。

4.2 核心類功能介紹

4.2.1 Volley.java

這個和 Volley 框架同名的類，其實是個工具類，作用是構建一個可用於添加網路請求的RequestQueue對象。
(1). 主要函數
Volley.java 有兩個重載的靜態方法。

public static RequestQueue newRequestQueue(Context context)

public static RequestQueue newRequestQueue(Context context, HttpStack stack)

第一個方法的實現調用了第二個方法，傳 HttpStack 參數為 null。
第二個方法中，如果 HttpStatck 參數為 null，則如果系統在 Gingerbread 及之後(即 API Level >= 9)，採用基於 HttpURLConnection 的 HurlStack，如果小於 9，採用基於 HttpClient 的 HttpClientStack。

if (stack == null) {
    if (Build.VERSION.SDK_INT >= 9) {
        stack = new HurlStack();
    } else {
        stack = new HttpClientStack(AndroidHttpClient.newInstance(userAgent));
    }
}

得到了 HttpStack,然後通過它構造一個代表網路（Network）的具體實現BasicNetwork。
接著構造一個代表緩存（Cache）的基於 Disk 的具體實現DiskBasedCache。
最後將網路（Network）對象和緩存（Cache）對象傳入構建一個 RequestQueue，啟動這個 RequestQueue，並返回。

Network network = new BasicNetwork(stack);
RequestQueue queue = new RequestQueue(new DiskBasedCache(cacheDir), network);
queue.start();
return queue;

我們平時大多採用Volly.newRequestQueue(context)的預設實現，構建 RequestQueue。
通過源碼可以看出，我們可以拋開 Volley 工具類構建自定義的 RequestQueue，採用自定義的HttpStatck，採用自定義的Network實現，採用自定義的 Cache 實現等來構建RequestQueue。
優秀框架的高可拓展性的魅力來源於此啊

(2). HttpURLConnection 和 AndroidHttpClient(HttpClient 的封裝)如何選擇及原因：
在 Froyo(2.2) 之前，HttpURLConnection 有個重大 Bug，調用 close() 函數會影響連接池，導致連接復用失效，所以在 Froyo 之前使用 HttpURLConnection 需要關閉 keepAlive。
另外在 Gingerbread(2.3) HttpURLConnection 預設開啟了 gzip 壓縮，提高了 HTTPS 的性能，Ice Cream Sandwich(4.0) HttpURLConnection 支持了請求結果緩存。
再加上 HttpURLConnection 本身 API 相對簡單，所以對 Android 來說，在 2.3 之後建議使用 HttpURLConnection，之前建議使用 AndroidHttpClient。

(3). 關於 User Agent
通過代碼我們發現如果是使用 AndroidHttpClient，Volley 還會將請求頭中的 User-Agent 欄位設置為 App 的 ${packageName}/${versionCode}，如果異常則使用 "volley/0"，不過這個獲取 User-Agent 的操作應該放到 if else 內部更合適。而對於 HttpURLConnection 卻沒有任何操作，為什麼呢？
如果用 Fiddler 或 Charles 對數據抓包我們會發現，我們會發現 HttpURLConnection 預設是有 User-Agent 的，類似：

Dalvik/1.6.0 (Linux; U; Android 4.1.1; Google Nexus 4 - 4.1.1 - API 16 - 768x1280_1 Build/JRO03S)

經常用 WebView 的同學會也許會發現似曾相識，是的，WebView 預設的 User-Agent 也是這個。實際在請求發出之前，會檢測 User-Agent 是否為空，如果不為空，則加上系統預設 User-Agent。在 Android 2.1 之後，我們可以通過

String userAgent = System.getProperty("http.agent");

得到系統預設的 User-Agent，Volley 如果希望自定義 User-Agent，可在自定義 Request 中重寫 getHeaders() 函數

@Override
public Map<String, String> getHeaders() throws AuthFailureError {
    // self-defined user agent
    Map<String, String> headerMap = new HashMap<String, String>();
    headerMap.put("User-Agent", "android-open-project-analysis/1.0");
    return headerMap;
}

4.2.2 Request.java

代表一個網路請求的抽象類。我們通過構建一個Request類的非抽象子類(StringRequest、JsonRequest、ImageRequest 或自定義)對象，並將其加入到·RequestQueue·中來完成一次網路請求操作。
Volley 支持 8 種 Http 請求方式 GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, PATCH
Request 類中包含了請求 url，請求請求方式，請求 Header，請求 Body，請求的優先順序等信息。

因為是抽象類，子類必須重寫的兩個方法。

abstract protected Response<T> parseNetworkResponse(NetworkResponse response);

子類重寫此方法，將網路返回的原生位元組內容，轉換成合適的類型。此方法會在工作線程中被調用。

abstract protected void deliverResponse(T response);

子類重寫此方法，將解析成合適類型的內容傳遞給它們的監聽回調。

以下兩個方法也經常會被重寫

public byte[] getBody()

重寫此方法，可以構建用於 POST、PUT、PATCH 請求方式的 Body 內容。

protected Map<String, String> getParams()

在上面getBody函數沒有被重寫情況下，此方法的返回值會被 key、value 分別編碼後拼裝起來轉換為位元組碼作為 Body 內容。

4.2.3 RequestQueue.java

Volley 框架的核心類，將請求 Request 加入到一個運行的RequestQueue中，來完成請求操作。

(1). 主要成員變數

RequestQueue 中維護了兩個基於優先順序的 Request 隊列，緩存請求隊列和網路請求隊列。
放在緩存請求隊列中的 Request，將通過緩存獲取數據；放在網路請求隊列中的 Request，將通過網路獲取數據。

private final PriorityBlockingQueue<Request<?>> mCacheQueue = new PriorityBlockingQueue<Request<?>>();
private final PriorityBlockingQueue<Request<?>> mNetworkQueue = new PriorityBlockingQueue<Request<?>>();

維護了一個正在進行中，尚未完成的請求集合。

private final Set<Request<?>> mCurrentRequests = new HashSet<Request<?>>();

維護了一個等待請求的集合，如果一個請求正在被處理並且可以被緩存，後續的相同 url 的請求，將進入此等待隊列。

private final Map<String, Queue<Request<?>>> mWaitingRequests = new HashMap<String, Queue<Request<?>>>();

(2). 啟動隊列

創建出 RequestQueue 以後，調用 start 方法，啟動隊列。

/**
 * Starts the dispatchers in this queue.
 */
public void start() {
    stop();  // Make sure any currently running dispatchers are stopped.
    // Create the cache dispatcher and start it.
    mCacheDispatcher = new CacheDispatcher(mCacheQueue, mNetworkQueue, mCache, mDelivery);
    mCacheDispatcher.start();

    // Create network dispatchers (and corresponding threads) up to the pool size.
    for (int i = 0; i < mDispatchers.length; i++) {
        NetworkDispatcher networkDispatcher = new NetworkDispatcher(mNetworkQueue, mNetwork,
                mCache, mDelivery);
        mDispatchers[i] = networkDispatcher;
        networkDispatcher.start();
    }
}

start 方法中，開啟一個緩存調度線程CacheDispatcher和 n 個網路調度線程NetworkDispatcher，這裡 n 預設為 4，存在優化的餘地，比如可以根據 CPU 核數以及網路類型計算更合適的併發數。
緩存調度線程不斷的從緩存請求隊列中取出 Request 去處理，網路調度線程不斷的從網路請求隊列中取出 Request 去處理。

(3). 加入請求

public <T> Request<T> add(Request<T> request);

流程圖如下：
加入請求流程圖

(4). 請求完成

void finish(Request<?> request)

Request 請求結束

(1). 首先從正在進行中請求集合mCurrentRequests中移除該請求。
(2). 然後查找請求等待集合mWaitingRequests中是否存在等待的請求，如果存在，則將等待隊列移除，並將等待隊列所有的請求添加到緩存請求隊列中，讓緩存請求處理線程CacheDispatcher自動處理。

(5). 請求取消

public void cancelAll(RequestFilter filter)
public void cancelAll(final Object tag)

取消當前請求集合中所有符合條件的請求。
filter 參數表示可以按照自定義的過濾器過濾需要取消的請求。
tag 表示按照Request.setTag設置好的 tag 取消請求，比如同屬於某個 Activity 的。

4.2.4 CacheDispatcher.java

一個線程，用於調度處理走緩存的請求。啟動後會不斷從緩存請求隊列中取請求處理，隊列為空則等待，請求處理結束則將結果傳遞給ResponseDelivery 去執行後續處理。當結果未緩存過、緩存失效或緩存需要刷新的情況下，該請求都需要重新進入NetworkDispatcher去調度處理。

(1). 成員變數

BlockingQueue<Request<?>> mCacheQueue 緩存請求隊列
BlockingQueue<Request<?>> mNetworkQueue 網路請求隊列
Cache mCache 緩存類，代表了一個可以獲取請求結果，存儲請求結果的緩存
ResponseDelivery mDelivery 請求結果傳遞類

(2). 處理流程圖

緩存調度線程處理流程圖

4.2.5 NetworkDispatcher.java

一個線程，用於調度處理走網路的請求。啟動後會不斷從網路請求隊列中取請求處理，隊列為空則等待，請求處理結束則將結果傳遞給 ResponseDelivery 去執行後續處理，並判斷結果是否要進行緩存。

(1). 成員變數

BlockingQueue<Request<?>> mQueue 網路請求隊列
Network mNetwork 網路類，代表了一個可以執行請求的網路
Cache mCache 緩存類，代表了一個可以獲取請求結果，存儲請求結果的緩存
ResponseDelivery mDelivery 請求結果傳遞類，可以傳遞請求的結果或者錯誤到調用者

(2). 處理流程圖

網路調度線程處理流程圖

4.2.6 Cache.java

緩存介面，代表了一個可以獲取請求結果，存儲請求結果的緩存。

(1). 主要方法：

public Entry get(String key); 通過 key 獲取請求的緩存實體
public void put(String key, Entry entry); 存入一個請求的緩存實體
public void remove(String key); 移除指定的緩存實體
public void clear(); 清空緩存

(2). 代表緩存實體的內部類 Entry

成員變數和方法
byte[] data 請求返回的數據（Body 實體）
String etag Http 響應首部中用於緩存新鮮度驗證的 ETag
long serverDate Http 響應首部中的響應產生時間
long ttl 緩存的過期時間
long softTtl 緩存的新鮮時間
Map<String, String> responseHeaders 響應的 Headers
boolean isExpired() 判斷緩存是否過期，過期緩存不能繼續使用
boolean refreshNeeded() 判斷緩存是否新鮮，不新鮮的緩存需要發到服務端做新鮮度的檢測

4.2.7 DiskBasedCache.java

繼承 Cache 類，基於 Disk 的緩存實現類。

(1). 主要方法：

public synchronized void initialize() 初始化，掃描緩存目錄得到所有緩存數據摘要信息放入記憶體。
public synchronized Entry get(String key) 從緩存中得到數據。先從摘要信息中得到摘要信息，然後讀取緩存數據文件得到內容。
public synchronized void put(String key, Entry entry) 將數據存入緩存內。先檢查緩存是否會滿，會則先刪除緩存中部分數據，然後再新建緩存文件。
private void pruneIfNeeded(int neededSpace) 檢查是否能再分配 neededSpace 位元組的空間，如果不能則刪除緩存中部分數據。
public synchronized void clear() 清空緩存。 public synchronized void remove(String key) 刪除緩存中某個元素。

(2). CacheHeader 類

CacheHeader 是緩存文件摘要信息，存儲在緩存文件的頭部，與上面的Cache.Entry相似。

4.2.8 NoCache.java

繼承 Cache 類，不做任何操作的緩存實現類，可將它作為構建RequestQueue的參數以實現一個不帶緩存的請求隊列。

4.2.9 Network.java

代表網路的介面，處理網路請求。
唯一的方法，用於執行特定請求。

public NetworkResponse performRequest(Request<?> request) throws VolleyError;

4.2.10 NetworkResponse.java

Network中方法 performRequest 的返回值，Request的 parseNetworkResponse(…) 方法入參，是 Volley 中用於內部 Response 轉換的一級。
封裝了網路請求響應的 StatusCode，Headers 和 Body 等。

(1). 成員變數

int statusCode Http 響應狀態碼
byte[] data Body 數據
Map<String, String> headers 響應 Headers
boolean notModified 表示是否為 304 響應
long networkTimeMs 請求耗時

(2). Volley 的內部 Response 轉換流程圖

Volley
從上到下表示從得到數據後一步步的處理，箭頭旁的註釋表示該步處理後的實體類。

4.2.11 BasicNetwork.java

實現 Network，Volley 中預設的網路介面實現類。調用HttpStack處理請求，並將結果轉換為可被ResponseDelivery處理的NetworkResponse。
主要實現了以下功能：
(1). 利用 HttpStack 執行網路請求。
(2). 如果 Request 中帶有實體信息，如 Etag,Last-Modify 等，則進行緩存新鮮度的驗證，並處理 304（Not Modify）響應。
(3). 如果發生超時，認證失敗等錯誤，進行重試操作，直到成功、拋出異常(不滿足重試策略等)結束。

4.2.12 HttpStack.java

用於處理 Http 請求，返回請求結果的介面。目前 Volley 中的實現有基於 HttpURLConnection 的 HurlStack 和 基於 Apache HttpClient 的 HttpClientStack。
唯一方法，執行請求

public HttpResponse performRequest(Request<?> request, Map<String, String> additionalHeaders)
        throws IOException, AuthFailureError;

執行 Request 代表的請求，第二個參數表示發起請求之前，添加額外的請求 Headers。

4.2.13 HttpClientStack.java

實現 HttpStack 介面，利用 Apache 的 HttpClient 進行各種請求方式的請求。
基本就是 org.apache.http 包下麵相關類的常見用法，不做詳解，不過與下麵 HttpURLConnection 做下對比就能發現 HttpURLConnection 的 API 相對簡單的多。

4.2.14 HurlStack.java

實現 HttpStack 介面，利用 Java 的 HttpURLConnection 進行各種請求方式的請求。

4.2.15 Response.java

封裝了經過解析後的數據，用於傳輸。並且有兩個內部介面 Listener 和 ErrorListener 分別可表示請求失敗和成功後的回調。
Response 的構造函數被私有化，而通過兩個函數名更易懂的靜態方法構建對象。

4.2.16 ByteArrayPool.java

byte[] 的回收池，用於 byte[] 的回收再利用，減少了記憶體的分配和回收。 主要通過一個元素長度從小到大排序的ArrayList作為 byte[] 的緩存，另有一個按使用時間先後排序的ArrayList屬性用於緩存滿時清理元素。

public synchronized void returnBuf(byte[] buf)

將用過的 byte[] 回收，根據 byte[] 長度按照從小到大的排序將 byte[] 插入到緩存中合適位置。

public synchronized byte[] getBuf(int len)

獲取長度不小於 len 的 byte[]，遍歷緩存，找出第一個長度大於傳入參數len的 byte[]，並返回；如果最終沒有合適的 byte[]，new 一個返回。

private synchronized void trim()

當緩存的 byte 超過預先設置的大小時，按照先進先出的順序刪除最早的 byte[]。

4.2.17 PoolingByteArrayOutputStream.java

繼承 ByteArrayOutputStream，原始 ByteArrayOutputStream 中用於接受寫入 bytes 的 buf，每次空間不足時便會 new 更大容量的 byte[]，而 PoolingByteArrayOutputStream 使用了 ByteArrayPool 作為 Byte[] 緩存來減少這種操作，從而提高性能。

4.2.18 HttpHeaderParser.java

Http header 的解析工具類，在 Volley 中主要作用是用於解析 Header 從而判斷返回結果是否需要緩存，如果需要返回 Header 中相關信息。
有三個方法

public static long parseDateAsEpoch(String dateStr)

解析時間，將 RFC1123 的時間格式，解析成 epoch 時間

public static String parseCharset(Map<String, String> headers)

解析編碼集，在 Content-Type 首部中獲取編碼集，如果沒有找到，預設返回 ISO-8859-1

public static Cache.Entry parseCacheHeaders(NetworkResponse response)

比較重要的方法，通過網路響應中的緩存控制 Header 和 Body 內容，構建緩存實體。如果 Header 的 Cache-Control 欄位含有no-cache或no-store表示不緩存，返回 null。
(1). 根據 Date 首部，獲取響應生成時間
(2). 根據 ETag 首部，獲取響應實體標簽
(3). 根據 Cache－Control 和 Expires 首部，計算出緩存的過期時間，和緩存的新鮮度時間

兩點需要說明下：
1.沒有處理Last-Modify首部，而是處理存儲了Date首部，併在後續的新鮮度驗證時，使用Date來構建If-Modified-Since。 這與 Http 1.1 的語義有些違背。
2.計算過期時間，Cache－Control 首部優先於 Expires 首部。

4.2.19 RetryPolicy.java

重試策略介面
有三個方法：

public int getCurrentTimeout();

獲取當前請求用時（用於 Log）

public int getCurrentRetryCount();

獲取已經重試的次數（用於 Log）

public void retry(VolleyError error) throws VolleyError;

確定是否重試，參數為這次異常的具體信息。在請求異常時此介面會被調用，可在此函數實現中拋出傳入的異常表示停止重試。

4.2.20 DefaultRetryPolicy.java

實現 RetryPolicy，Volley 預設的重試策略實現類。主要通過在 retry(…) 函數中判斷重試次數是否達到上限確定是否繼續重試。
其中mCurrentRetryCount變數表示已經重試次數。
mBackoffMultiplier表示每次重試之前的 timeout 該乘以的因數。
mCurrentTimeoutMs變數表示當前重試的 timeout 時間，會以mBackoffMultiplier作為因數累計前幾次重試的 timeout。

4.2.21 ResponseDelivery.java

請求結果的傳輸介面，用於傳遞請求結果或者請求錯誤。
有三個方法：

public void postResponse(Request<?> request, Response<?> response);

此方法用於傳遞請求結果，request 和 response 參數分別表示請求信息和返回結果信息。

public void postResponse(Request<?> request, Response<?> response, Runnable runnable);

此方法用於傳遞請求結果，併在完成傳遞後執行 Runnable。

public void postError(Request<?> request, VolleyError error);　

此方法用於傳輸請求錯誤。

4.2.22 ExecutorDelivery.java

請求結果傳輸介面具體實現類。
在 Handler 對應線程中傳輸緩存調度線程或者網路調度線程中產生的請求結果或請求錯誤，會在請求成功的情況下調用 Request.deliverResponse(…) 函數，失敗時調用 Request.deliverError(…) 函數。

4.2.23 StringRequest.java

繼承 Request 類,代表了一個返回值為 String 的請求。將網路返回的結果數據解析為 String 類型。通過構造函數的 listener 傳參，支持請求成功後的 onResponse(…) 回調。

4.2.24 JsonRequest.java

抽象類，繼承自 Request，代表了 body 為 JSON 的請求。提供了構建 JSON 請求參數的方法。

4.2.25 JsonObjectRequest.java

繼承自 JsonRequest，將網路返回的結果數據解析為 JSONObject 類型。

4.2.26 JsonArrayRequest.java

繼承自 JsonRequest，將網路返回的結果數據解析為 JSONArray 類型。

4.2.27 ImageRequest.java

繼承 Request 類，代表了一個返回值為 Image 的請求。將網路返回的結果數據解析為 Bitmap 類型。
可以設置圖片的最大寬度和最大高度，並計算出合適尺寸返回。每次最多解析一張圖片防止 OOM。

4.2.28 ImageLoader.java

封裝了 ImageRequst 的方便使用的圖片載入工具類。

1.可以設置自定義的ImageCache，可以是記憶體緩存，也可以是 Disk 緩存，將獲取的圖片緩存起來，重覆利用，減少請求。
2.可以定義圖片請求過程中顯示的圖片和請求失敗後顯示的圖片。
3.相同請求（相同地址，相同大小）只發送一個，可以避免重覆請求。
// TODO

4.2.29 NetworkImageView.java

利用 ImageLoader，可以載入網路圖片的 ImageView
有三個公開的方法：

public void setDefaultImageResId(int defaultImage)

設置預設圖片，載入圖片過程中顯示。

public void setErrorImageResId(int errorImage)

設置錯誤圖片，載入圖片失敗後顯示。

public void setImageUrl(String url, ImageLoader imageLoader)

設置網路圖片的 Url 和 ImageLoader，將利用這個 ImageLoader 去獲取網路圖片。

如果有新的圖片載入請求，會把這個 ImageView 上舊的載入請求取消。

4.2.30 ClearCacheRequest.java

用於人為清空 Http 緩存的請求。
添加到 RequestQueue 後能很快執行，因為優先順序很高，為Priority.IMMEDIATE。並且清空緩存的方法mCache.clear()寫在了isCanceled()方法體中，能最早的得到執行。

ClearCacheRequest 的寫法不敢苟同，目前看來唯一的好處就是可以將清空緩存操作也當做一個請求。而在isCanceled()中做清空操作本身就造成了歧義，不看源碼沒人知道在NetworkDispatcher run 方法迴圈的過程中，isCanceled()這個讀操作竟然做了可能造成緩存被清空。只能跟源碼的解釋一樣當做一個 Hack 操作。

4.2.31 Authenticator.java

身份認證介面，用於基本認證或者摘要認證。這個類是 Volley 用於和身份驗證打通的介面，比如 OAuth，不過目前的使用不是特別廣泛和 Volley 的內部結合也不是特別緊密。

4.2.32 AndroidAuthenticator.java

繼承 Authenticator，基於 Android AccountManager 的認證交互實現類。

4.2.33 VolleyLog.java

Volley 的 Log 工具類。

4.2.34 VolleyError.java

Volley 中所有錯誤異常的父類，繼承自 Exception，可通過此類設置和獲取 NetworkResponse 或者請求的耗時。

4.2.35 AuthFailureError.java

繼承自 VolleyError，代表請求認證失敗錯誤，如 RespondeCode 的 401 和 403。

4.2.36 NetworkError.java

繼承自 VolleyError，代表網路錯誤。

4.2.37 ParseError.java

繼承自 VolleyError，代表內容解析錯誤。

4.2.38 ServerError.java

繼承自 VolleyError，代表服務端錯誤。

4.2.39 TimeoutError.java

繼承自 VolleyError，代表請求超時錯誤。

4.2.40 NoConnectionError.java

繼承自 NetworkError，代表無法建立連接錯誤。

5. 雜談

5.1 關於 Http 緩存

Volley 構建了一套相對完整的符合 Http 語義的緩存機制。
優點和特點
(1). 根據Cache-Control和Expires首部來計算緩存的過期時間。如果兩個首部都存在情況下，以Cache-Control為準。
(2). 利用If-None-Match和If-Modified-Since對過期緩存或者不新鮮緩存，進行請求再驗證，並處理 304 響應，更新緩存。
(3). 預設的緩存實現，將緩存以文件的形式存儲在 Disk，程式退出後不會丟失。

我個人認為的不足之處
緩存的再驗證方面，在構建If-Modified-Since請求首部時，Volley 使用了服務端響應的Date首部，沒有使用Last-Modified首部。整個框架沒有使用Last-Modified首部。這與 Http 語義不符。

private void addCacheHeaders(Map<String, String> headers, Cache.Entry entry) {
    // If there's no cache entry, we're done.
    if (entry == null) {
        return;
    }

    if (entry.etag != null) {
        headers.put("If-None-Match", entry.etag);
    }

    if (entry.serverDate > 0) {
        Date refTime = new Date(entry.serverDate);
        headers.put("If-Modified-Since", DateUtils.formatDate(refTime));
    }
}

服務端根據請求時通過If-Modified-Since首部傳過來的時間，判斷資源文件是否在If-Modified-Since時間 以後 有改動，如果有改動，返回新的請求結果。如果沒有改動，返回 304 not modified。
Last-Modified代表了資源文件的最後修改時間。通常使用這個首部構建If-Modified-Since的時間。
Date代表了響應產生的時間，正常情況下Date時間在Last-Modified時間之後。也就是Date>=Last-Modified。
通過以上原理，既然Date>=Last-Modified。那麼我利用Date構建，也是完全正確的。

可能的問題出在服務端的 Http 實現上，如果服務端完全遵守 Http 語義，採用時間比較的方式來驗證If-Modified-Since，判斷伺服器資源文件修改時間是不是在If-Modified-Since之後。那麼使用Date完全正確。
可是有的服務端實現不是比較時間，而是直接的判斷伺服器資源文件修改時間，是否和If-Modified-Since所傳時間相等。這樣使用Date就不能實現正確的再驗證，因為Date的時間總不會和伺服器資源文件修改時間相等。

儘管使用Date可能出現的不正確情況，歸結於服務端沒有正確的實現 Http 語義。
但我還是希望 Volley 也能完全正確的實現 Http 語義，至少同時處理Last-Modified和Date,並且優先使用Last-Modified。

5.2 Bug

(1). BasicNetwork.performRequest(…)

如下代碼：

@Override
public NetworkResponse performRequest(Request<?> request) throws VolleyError {
    ……
    while (true) {
        ……
        try {
            ……
        } catch (IOException e) {
            int statusCode = 0;
            NetworkResponse networkResponse = null;
            ……
            if (responseContents != null) {
              ……
            } else {
                throw new NetworkError(networkResponse);
            }
        }
    }
}

BasicNetwork.performRequest(…) 最後的

throw new NetworkError(networkResponse);

應該是

throw new NetworkError(e);

更合理。

上面說的這些問題在新版本中已經修改了。

 

本文為 Android 開源項目源碼解析 中 Volley 部分  原文地址：http://a.codekk.com/detail/Android/grumoon/Volley%20%E6%BA%90%E7%A0%81%E8%A7%A3%E6%9E%90
項目地址：Volley，分析的版本：35ce778，Demo 地址：Volley Demo
分析者：grumoon，校對者：huxian99、Trinea，校對狀態：完成

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 厭煩了寫findViewById 試試ButterKnife吧
    先上官網 http://jakewharton.github.io/butterknife/ 和 https://github.com/JakeWharton/butterknife 配置開發環境 在代碼開始之前 先要將庫加入依賴 Eclipse 去官網手工下載 jar 包， 放到 libs目錄 或 ...
  • Swift與OC混編
    Swift一齣來就比較受人歡迎，但是還是有很多的第三方庫是不支持Swift的，個人也感覺Swift還有很長的路要走。 而且最近連Swift的創始人都離開蘋果公司了。。。。。。。。。 加入Swift用到了第三方的東西那怎麼辦呢，其實很簡單，Xcode會自動幫你創建一個橋接文件，用來連接Swift和OC ...
  • Setting 之dashboard 點擊跳轉流程
    設置的主界面的可以通過修改xml中的dashboard_categaries.xml 文件實現，在DashboardSummary.java 文件中的rebuildUI（）方法中將xml對應的實體類轉換成對應的view，具體細節可以看設置源碼。 一，dashboard_categaries中定義節點 ...
  • CoordinatorLayout使用筆記
    CoordinatorLayout的使用筆記 CollapsingToolbarLayout有兩個Children.ImageView用來顯示大圖.而Toolbar就是摺疊後看到的頂欄Toolbar. app:contentScrim="?attr/colorPrimary" ,Collapsing ...
  • 手機安全衛士——手機防盜頁面
    LostFindActivity.java 下邊是設置嚮導： BaseSetupActivity.java Setup1Activity.java styles.xml btn_green_selector.xml //狀態選擇器（selector）設置給view，點擊會有相應的效果 .9.png( ...
  • 轉載：記憶體泄露與記憶體溢出的區別
    記憶體溢出 out of memory，是指程式在申請記憶體時，沒有足夠的記憶體空間供其使用，出現out of memory；比如申請了一個integer,但給它存了long才能存下的數，那就是記憶體溢出。 記憶體泄露 memory leak，是指程式在申請記憶體後，無法釋放已申請的記憶體空間，一次記憶體泄露危害可 ...
  • iOS自定義視圖- SJTextView
    ### 需求：1. textView 需要placeholder用來提示輸入2. textView 要做字數限制 3. textView 禁止表情符號的輸入### 思考：因為需求比較通用，便想通過自定義SJTextView來實現：1. placeholder 通過在textView上添加一個透明的l... ...
  • Say Hello to ConstraintLayout
    `ConstraintLayout`讓你可以在很平的view結構(沒有多層佈局嵌套)中構建一個複雜的佈局結構. 有點像`RelativeLayout`, 所有的view都是根據它和兄弟View和父layout的關係佈局的, 但是它比`RelativeLayout`要更加靈活, 在Layout Edi... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類