Android的HTTP類庫Volley入門學習教程

1. 什麼是Volley
我們平時在開發Android應用的時候不可避免地都需要用到網絡技術，而多數情況下應用程序都會使用HTTP協議來發送和接收網絡數據。Android系統中主要提供了兩種方式來進行HTTP通信，HttpURLConnection和HttpClient，幾乎在任何項目的代碼中我們都能看到這兩個類的身影，使用率非常高。

不過HttpURLConnection和HttpClient的用法還是稍微有些復雜的，如果不進行適當封裝的話，很容易就會寫出不少重復代碼。於是乎，一些Android網絡通信框架也就應運而生，比如說AsyncHttpClient，它把HTTP所有的通信細節全部封裝在了內部，我們只需要簡單調用幾行代碼就可以完成通信操作了。再比如Universal-Image-Loader，它使得在界面上顯示網絡圖片的操作變得極度簡單，開發者不用關心如何從網絡上獲取圖片，也不用關心開啟線程、回收圖片資源等細節，Universal-Image-Loader已經把一切都做好了。

Android開發團隊也是意識到了有必要將HTTP的通信操作再進行簡單化，於是在2013年Google I/O大會上推出了一個新的網絡通信框架——Volley。Volley可是說是把AsyncHttpClient和Universal-Image-Loader的優點集於了一身，既可以像AsyncHttpClient一樣非常簡單地進行HTTP通信，也可以像Universal-Image-Loader一樣輕松加載網絡上的圖片。除了簡單易用之外，Volley在性能方面也進行了大幅度的調整，它的設計目標就是非常適合去進行數據量不大，但通信頻繁的網絡操作，而對於大數據量的網絡操作，比如說下載文件等，Volley的表現就會非常糟糕。
1.1. Volley引入的背景
在以前，我們可能面臨如下很多麻煩的問題。

比如以前從網上下載圖片的步驟可能是這樣的流程：

• 在ListAdapter#getView()裡開始圖像的讀取。
• 通過AsyncTask等機制使用HttpURLConnection從服務器去的圖片資源
• 在AsyncTask#onPostExecute()裡設置相應ImageView的屬性。
• 而在Volley下，只需要一個函數即可，詳細見後面的例子。

再比如，屏幕旋轉的時候，有時候會導致再次從網絡取得數據。為了避免這種不必要的網絡訪問，我們可能需要自己寫很多針對各種情況的處理，比如cache什麼的。

再有，比如ListView的時候，我們滾動過快，可能導致有些網絡請求返回的時候，早已經滾過了當時的位置，根本沒必要顯示在list裡了，雖然我們可以通過ViewHolder來保持url等來實現防止兩次取得，但是那些已經沒有必須要的數據，還是會浪費系統的各種資源。

1.2. Volley提供的功能
簡單來說，它提供了如下的便利功能：

• JSON，圖像等的異步下載；
• 網絡請求的排序（scheduling）
• 網絡請求的優先級處理
• 緩存
• 多級別取消請求
• Activity和生命周期的聯動（Activity結束時同時取消所有網絡請求）

2. 使用前的准備

引入Volley非常簡單，首先，從git庫先克隆一個下來：

git clone https://android.googlesource.com/platform/frameworks/volley 

然後編譯為jar包，再在自己的工程裡import進來。

注意，這個庫要求最低SDK版本為Froyo，即至少要設置android:minSdkVersion為8以上。

3.使用例子
下面簡單看看如何使用Volley

3.1. 最簡單的get請求
這個例子很簡單，從網絡取得JSON對象，然後打印出來。

mQueue = Volley.newRequestQueue(getApplicationContext()); 
mQueue.add(new JsonObjectRequest(Method.GET, url, null, 
   new Listener() { 
    @Override 
    public void onResponse(JSONObject response) { 
     Log.d(TAG, "response : " + response.toString()); 
    } 
   }, null)); 
mQueue.start(); 

3.2. 給ImageView設置圖片源

// imageView是一個ImageView實例 
// ImageLoader.getImageListener的第二個參數是默認的圖片resource id 
// 第三個參數是請求失敗時候的資源id，可以指定為0 
ImageListener listener = ImageLoader.getImageListener(imageView, android.R.drawable.ic_menu_rotate, android.R.drawable.ic_delete); 
mImageLoader.get(url, listener); 

ImageLoader的方法都需要從主線程裡來調用。

3.3. 使用NetworkImageView

Volley提供了一個新的控件NetworkImageView來代替傳統的ImageView，這個控件的圖片屬性可以通過

mImageView.setImageUrl(url, imageLoader) 

來設定。而且，這個控件在被從父控件detach的時候，會自動取消網絡請求的，即完全不用我們擔心相關網絡請求的生命周期問題。
示例代碼如下：

mImageLoader = new ImageLoader(mRequestQueue, new BitmapLruCache()); 
... ... 
 
if(holder.imageRequest != null) { 
 holder.imageRequest.cancel(); 
} 
holder.imageRequest = mImageLoader.get(BASE_UR + item.image_url, holder.imageView, R.drawable.loading, R.drawable.error); 

 

注意，這裡使用的不是ImageView控件，而是Volley新提供的com.android.volley.NetworkImageView。

另外，注意這裡：

mImageLoader = new ImageLoader(mRequestQueue, new BitmapLruCache()); 

ImageLoader構造函數的第二個參數是一個ImageCache的實例（嚴格來說，是實現ImageCache接口的某具體類的實例）
ImageCache的定義如下（在ImageLoader.java裡）：

/** 
 * Simple cache adapter interface. If provided to the ImageLoader, it 
 * will be used as an L1 cache before dispatch to Volley. Implementations 
 * must not block. Implementation with an LruCache is recommended. 
 */ 
public interface ImageCache { 
 public Bitmap getBitmap(String url); 
 public void putBitmap(String url, Bitmap bitmap); 
} 

下面的網址一個lru的cache實現例子，請參考：
https://github.com/suwa-yuki/VolleySample/blob/master/src/jp/classmethod/android/sample/volley/BitmapCache.java

3.4 StringRequest的用法
發起一條HTTP請求，然後接收HTTP響應。首先需要獲取到一個RequestQueue對象，可以調用如下方法獲取到：

RequestQueue mQueue = Volley.newRequestQueue(context); 

注意這裡拿到的RequestQueue是一個請求隊列對象，它可以緩存所有的HTTP請求，然後按照一定的算法並發地發出這些請求。RequestQueue內部的設計就是非常合適高並發的，因此我們不必為每一次HTTP請求都創建一個RequestQueue對象，這是非常浪費資源的，基本上在每一個需要和網絡交互的Activity中創建一個RequestQueue對象就足夠了。

接下來為了要發出一條HTTP請求，我們還需要創建一個StringRequest對象，如下所示：

StringRequest stringRequest = new StringRequest("http://www.baidu.com", 
      new Response.Listener<String>() { 
       @Override 
       public void onResponse(String response) { 
        Log.d("TAG", response); 
       } 
      }, new Response.ErrorListener() { 
       @Override 
       public void onErrorResponse(VolleyError error) { 
        Log.e("TAG", error.getMessage(), error); 
       } 
      }); 

可以看到，這裡new出了一個StringRequest對象，StringRequest的構造函數需要傳入三個參數，第一個參數就是目標服務器的URL地址，第二個參數是服務器響應成功的回調，第三個參數是服務器響應失敗的回調。其中，目標服務器地址我們填寫的是百度的首頁，然後在響應成功的回調裡打印出服務器返回的內容，在響應失敗的回調裡打印出失敗的詳細信息。

最後，將這個StringRequest對象添加到RequestQueue裡面就可以了，如下所示：

mQueue.add(stringRequest); 
另外，由於Volley是要訪問網絡的，因此不要忘記在你的AndroidManifest.xml中添加如下權限：

<uses-permission android:name="android.permission.INTERNET" /> 

好了，就是這麼簡單，如果你現在運行一下程序，並發出這樣一條HTTP請求，就會看到LogCat中會打印出如下圖所示的數據。

沒錯，百度返回給我們的就是這樣一長串的HTML代碼，雖然我們看起來會有些吃力，但是浏覽器卻可以輕松地對這段HTML代碼進行解析，然後將百度的首頁展現出來。

這樣的話，一個最基本的HTTP發送與響應的功能就完成了。你會發現根本還沒寫幾行代碼就輕易實現了這個功能，主要就是進行了以下三步操作：

(1). 創建一個RequestQueue對象。

(2). 創建一個StringRequest對象。

(3). 將StringRequest對象添加到RequestQueue裡面。

不過大家都知道，HTTP的請求類型通常有兩種，GET和POST，剛才我們使用的明顯是一個GET請求，那麼如果想要發出一條POST請求應該怎麼做呢？StringRequest中還提供了另外一種四個參數的構造函數，其中第一個參數就是指定請求類型的，我們可以使用如下方式進行指定：

StringRequest stringRequest = new StringRequest(Method.POST, url,  listener, errorListener); 
可是這只是指定了HTTP請求方式是POST，那麼我們要提交給服務器的參數又該怎麼設置呢？很遺憾，StringRequest中並沒有提供設置POST參數的方法，但是當發出POST請求的時候，Volley會嘗試調用StringRequest的父類——Request中的getParams()方法來獲取POST參數，那麼解決方法自然也就有了，我們只需要在StringRequest的匿名類中重寫getParams()方法，在這裡設置POST參數就可以了，代碼如下所示：

StringRequest stringRequest = new StringRequest(Method.POST, url, listener, errorListener) { 
 @Override 
 protected Map<String, String> getParams() throws AuthFailureError { 
  Map<String, String> map = new HashMap<String, String>(); 
  map.put("params1", "value1"); 
  map.put("params2", "value2"); 
  return map; 
 } 
}; 

你可能會說，每次都這樣用起來豈不是很累？連個設置POST參數的方法都沒有。但是不要忘記，Volley是開源的，只要你願意，你可以自由地在裡面添加和修改任何的方法，輕松就能定制出一個屬於你自己的Volley版本。

3.5 JsonRequest的用法
學完了最基本的StringRequest的用法，我們再來進階學習一下JsonRequest的用法。類似於StringRequest，JsonRequest也是繼承自Request類的，不過由於JsonRequest是一個抽象類，因此我們無法直接創建它的實例，那麼只能從它的子類入手了。JsonRequest有兩個直接的子類，JsonObjectRequest和JsonArrayRequest，從名字上你應該能就看出它們的區別了吧？一個是用於請求一段JSON數據的，一個是用於請求一段JSON數組的。

至於它們的用法也基本上沒有什麼特殊之處，先new出一個JsonObjectRequest對象，如下所示：

JsonObjectRequest jsonObjectRequest = new JsonObjectRequest("http://m.weather.com.cn/data/101010100.html", null, 
  new Response.Listener<JSONObject>() { 
   @Override 
   public void onResponse(JSONObject response) { 
    Log.d("TAG", response.toString()); 
   } 
  }, new Response.ErrorListener() { 
   @Override 
   public void onErrorResponse(VolleyError error) { 
    Log.e("TAG", error.getMessage(), error); 
   } 
  }); 

可以看到，這裡我們填寫的URL地址是http://m.weather.com.cn/data/101010100.html，這是中國天氣網提供的一個查詢天氣信息的接口，響應的數據就是以JSON格式返回的，然後我們在onResponse()方法中將返回的數據打印出來。

最後再將這個JsonObjectRequest對象添加到RequestQueue裡就可以了，如下所示：

mQueue.add(jsonObjectRequest); 

這樣當HTTP通信完成之後，服務器響應的天氣信息就會回調到onResponse()方法中，並打印出來。現在運行一下程序，發出這樣一條HTTP請求，就會看到LogCat中會打印出如下圖所示的數據。

3.6. 使用自己定制的request

我們也可以通過繼承Request根據自己的需求來定制自己的request

@Override 
protected Response parseNetworkResponse(NetworkResponse response) { 
 try { 
  String json = new String( 
    response.data, HttpHeaderParser.parseCharset(response.headers)); 
  return Response.success( 
    gson.fromJson(json, clazz), HttpHeaderParser.parseCacheHeaders(response)); 
 } catch (UnsupportedEncodingException e) { 
  return Response.error(new ParseError(e)); 
 } catch (JsonSyntaxException e) { 
  return Response.error(new ParseError(e)); 
 } 
} 

這段代碼節選自： https://gist.github.com/ficusk/5474673

裡面使用的gson（com.google.gson.Gson）是JSON的序列化和反序列化的庫，可以在JSON和java model object之間進行轉換。

以下是使用自定制request的例子：

mRequestQueue.add( new GsonRequest(url, ListResponse.class, null, 
 new Listener() { 
  public void onResponse(ListResponse response) { 
   appendItemsToList(response.item); 
   notifyDataSetChanged(); 
  } 
 } 
} 

4. Volley的架構設計

Volley使用了線程池來作為基礎結構，主要分為主線程，cache線程和network線程。
主線程和cache線程都只有一個，而NetworkDispatcher線程可以有多個，這樣能解決比並行問題。如下圖:

如果在一個Activity裡面啟動了網絡請求，而在這個網絡請求還沒返回結果的時候，如果Activity被結束了，則我們需要寫如下代碼作為防守：

@Override public void onPostExecute(Result r) { 
 if (getActivity() == null) { 
  return; 
 } 
 // ... 
} 

Activity被終止之後，如果繼續使用其中的Context等，除了無辜的浪費CPU，電池，網絡等資源，有可能還會導致程序crash，所以，我們需要處理這種一場情況。

使用Volley的話，我們可以在Activity停止的時候，同時取消所有或部分未完成的網絡請求。

Volley裡所有的請求結果會返回給主進程，如果在主進程裡取消了某些請求，則這些請求將不會被返回給主線程。
比如，可以針對某些個request做取消操作：

@Override 
public void onStop() { 
 for (Request <?> req : mInFlightRequests) { 
  req.cancel(); 
 } 
 ... 
} 

或者，取消這個隊列裡的所有請求：

@Override pubic void onStop() { 
 mRequestQueue.cancelAll(this); 
 ... 
} 

也可以根據RequestFilter或者Tag來終止某些請求：

@Override public void onStop() { 
 mRequestQueue.cancelAll( new RequestFilter() {}) 
 ... 
 // or 
 mRequestQueue.cancelAll(new Object()); 
 ... 

5.總結

從演講的例子來看，Volley應該是簡化了網絡通信的一些開發，特別是針對如下兩種情況：

• JSON對象
• 圖片加載

但是這個東西也有不實用的地方，比如大數據（large payloads ），流媒體，這些case，還需要使用原始的方法，比如Download Manager等。

總之，如果你要編寫網絡程序，是不是可以考慮開始使用Volley呢？