[轉]Volley的功能及設置
olley提供了優美的框架，使android程序網絡訪問更容易、更快。android
Volley抽象實現了底層的HTTP Client庫，咱們不需關注HTTP Client細節，專一於寫出更加漂亮、乾淨的RESTful HTTP請求。git
Volley請求會異步執行，不阻擋主線程。緩存
Volley提供的功能
封裝了異步的RESTful請求API服務器
一個優雅and穩健的請求隊列cookie
一個可擴展的架構，使開發者能實現自定義的請求和響應處理機制網絡
能使用外部Http Client庫架構
緩存策略app
自定義的網絡圖像加載視圖（NetworkImageView，ImageLoader等）框架
爲何使用異步Http請求
Android中要求HTTP請求異步執行，若是在主線程執行HTTP請求，可能會拋出 android.os.NetworkOnMainThreadException 異常。阻塞主線程有一些嚴重的後果，它阻礙UI渲染，用戶體驗不流 暢，它可能會致使可怕的ANR（Application Not Responding）。要避免這些陷阱，做爲一個開發者，應該始終確保HTTP請求是在一個不一樣的線程異步
怎樣使用Volley
一、安裝和使用Volley庫
二、使用請求隊列
三、異步的JSON、String請求
四、取消請求
五、重試失敗的請求，自定義請求超時
六、設置請求頭（HTTP headers）
七、使用Cookies
八、錯誤處理
1.安裝和使用Volley庫
引入Volley很是簡單，首先，從git庫先克隆一個下來：
git clone https://android.googlesource.com/platform/frameworks/volley
而後編譯爲jar包，再把jar包放到本身的工程的libs目錄。
2.使用請求隊列
Volley的全部請求都放在一個隊列，而後進行處理，這裏是你如何將建立一個請求隊列：
RequestQueue mRequestQueue = Volley.newRequestQueue(this); // 'this' is Context
理想的狀況是把請求隊列集中放到一個地方，最好是初始化應用程序類中初始化請求隊列，下面類作到了這一點：
public class ApplicationController extends Application { /**
* Log or request TAG */
public static final String TAG = "VolleyPatterns"; /**
* Global request queue for Volley */
private RequestQueue mRequestQueue; /**
* A singleton instance of the application class for easy access in other places */
private static ApplicationController sInstance;
@Override public void onCreate() { super.onCreate(); // initialize the singleton
sInstance = this;
} /**
* @return ApplicationController singleton instance */
public static synchronized ApplicationController getInstance() { return sInstance;
} /**
* @return The Volley Request queue, the queue will be created if it is null */
public RequestQueue getRequestQueue() { // lazy initialize the request queue, the queue instance will be // created when it is accessed for the first time
if (mRequestQueue == null) {
mRequestQueue = Volley.newRequestQueue(getApplicationContext());
} return mRequestQueue;
} /**
* Adds the specified request to the global queue, if tag is specified
* then it is used else Default TAG is used.
*
* @param req
* @param tag */
public <T> void addToRequestQueue(Request<T> req, String tag) { // set the default tag if tag is empty
req.setTag(TextUtils.isEmpty(tag) ? TAG : tag);
VolleyLog.d("Adding request to queue: %s", req.getUrl());
getRequestQueue().add(req);
} /**
* Adds the specified request to the global queue using the Default TAG.
*
* @param req
* @param tag */
public <T> void addToRequestQueue(Request<T> req) { // set the default tag if tag is empty req.setTag(TAG);
getRequestQueue().add(req);
} /**
* Cancels all pending requests by the specified TAG, it is important
* to specify a TAG so that the pending/ongoing requests can be cancelled.
*
* @param tag */
public void cancelPendingRequests(Object tag) { if (mRequestQueue != null) {
mRequestQueue.cancelAll(tag);
}
}
}
3.異步的JSON、String請求
Volley提供瞭如下的實用工具類進行異步HTTP請求：
JsonObjectRequest — To send and receive JSON Object from the Server
JsonArrayRequest — To receive JSON Array from the Server
StringRequest — To retrieve response body as String (ideally if you intend to parse the response by yourself)
JsonObjectRequest
這個類能夠用來發送和接收JSON對象。這個類的一個重載構造函數容許設置適當的請求方法（DELETE，GET，POST和PUT）。若是您正在使用一個RESTful服務端，可使用這個類。下面的示例顯示如何使GET和POST請求
GET請求：
final String URL = "/volley/resource/12";// pass second argument as "null" for GET requestsJsonObjectRequest req = new JsonObjectRequest(URL, null, new Response.Listener<JSONObject>() {
@Override public void onResponse(JSONObject response) { try {
VolleyLog.v("Response:%n %s", response.toString(4));
} catch (JSONException e) {
e.printStackTrace();
}
}
}, new Response.ErrorListener() {
@Override public void onErrorResponse(VolleyError error) {
VolleyLog.e("Error: ", error.getMessage());
}
});// add the request object to the queue to be executedApplicationController.getInstance().addToRequestQueue(req);
POST請求：
final String URL = "/volley/resource/12";// Post params to be sent to the serverHashMap<String, String> params = new HashMap<String, String>();
params.put("token", "AbCdEfGh123456");
JsonObjectRequest req = new JsonObjectRequest(URL, new JSONObject(params), new Response.Listener<JSONObject>() {
@Override public void onResponse(JSONObject response) { try {
VolleyLog.v("Response:%n %s", response.toString(4));
} catch (JSONException e) {
e.printStackTrace();
}
}
}, new Response.ErrorListener() {
@Override public void onErrorResponse(VolleyError error) {
VolleyLog.e("Error: ", error.getMessage());
}
});// add the request object to the queue to be executedApplicationController.getInstance().addToRequestQueue(req);
JsonArrayRequest
這個類能夠用來接受 JSON Arrary，不支持JSON Object。這個類如今只支持 HTTP GET。因爲支持GET，你能夠在URL的後面加上請求參數。類的構造函數不支持請求參數
final String URL = "/volley/resource/all?count=20";
JsonArrayRequest req = new JsonArrayRequest(URL, new Response.Listener<JSONArray> () {
@Override public void onResponse(JSONArray response) { try {
VolleyLog.v("Response:%n %s", response.toString(4));
} catch (JSONException e) {
e.printStackTrace();
}
}
}, new Response.ErrorListener() {
@Override public void onErrorResponse(VolleyError error) {
VolleyLog.e("Error: ", error.getMessage());
}
});// add the request object to the queue to be executedApplicationController.getInstance().addToRequestQueue(req);
StringRequest
這個類能夠用來從服務器獲取String，若是想本身解析請求響應可使用這個類，例如返回xml數據。它還可使用重載的構造函數定製請求
final String URL = "/volley/resource/recent.xml";
StringRequest req = new StringRequest(URL, new Response.Listener<String>() {
@Override public void onResponse(String response) {
VolleyLog.v("Response:%n %s", response);
}
}, new Response.ErrorListener() {
@Override public void onErrorResponse(VolleyError error) {
VolleyLog.e("Error: ", error.getMessage());
}
});// add the request object to the queue to be executedApplicationController.getInstance().addToRequestQueue(req);
4.取消請求
Volley提供了強大的API取消未處理或正在處理的請求。取消請求最簡單的方法是調用請求隊列cancelAll（tag）的方法，前提是你在添加請求時設置了標記。這樣就能使標籤標記的請求掛起。
給請求設置標籤：
request.setTag("My Tag");
使用ApplicationController添加使用了標籤的請求到隊列中：
ApplicationController.getInstance().addToRequestQueue(request, "My Tag");
取消全部指定標記的請求：
mRequestQueue.cancelAll("My Tag");
5.重試失敗的請求，自定義請求超時
Volley中沒有指定的方法來設置請求超時時間，能夠設置RetryPolicy 來變通實現。DefaultRetryPolicy類有個initialTimeout參數，能夠設置超時時間。要確保最大重試次數爲1，以保證超時後不從新請求。
Setting Request Timeout
request.setRetryPolicy(new DefaultRetryPolicy(20 * 1000, 1, 1.0f));
設置請求頭（HTTP headers） 若是你想失敗後從新請求（因超時），您能夠指定使用上面的代碼，增長重試次數。注意最後一個參數，它容許你指定一個退避乘數能夠用來實現「指數退避」來從RESTful服務器請求數據。
有時候須要給HTTP請求添加額外的頭信息，一個經常使用的例子是添加 「Authorization」到HTTP 請求的頭信息。Volley請求類提供了一個 getHeaers（）的方法，重載這個方法能夠自定義HTTP 的頭信息。
添加頭信息：
JsonObjectRequest req = new JsonObjectRequest(URL, new JSONObject(params), new Response.Listener<JSONObject>() {
@Override public void onResponse(JSONObject response) { // handle response }
}, new Response.ErrorListener() {
@Override public void onErrorResponse(VolleyError error) { // handle error }
}) {
@Override public Map<String, String> getHeaders() throws AuthFailureError {
HashMap<String, String> headers = new HashMap<String, String>();
headers.put("CUSTOM_HEADER", "Yahoo");
headers.put("ANOTHER_CUSTOM_HEADER", "Google"); return headers;
}
};
6.使用Cookies
Volley中沒有直接的API來設置cookies，Volley的設計理念就是提供乾淨、簡潔的API來實現RESTful HTTP請求，不提供設置cookies是合理的。
下面是修改後的ApplicationController類，這個類修改了getRequestQueue()方法，包含了 設置cookie方法，這些修改仍是有些粗糙
// http client instanceprivate DefaultHttpClient mHttpClient;public RequestQueue getRequestQueue() { // lazy initialize the request queue, the queue instance will be // created when it is accessed for the first time
if (mRequestQueue == null) { // Create an instance of the Http client.
// We need this in order to access the cookie store
mHttpClient = new DefaultHttpClient(); // create the request queue
mRequestQueue = Volley.newRequestQueue(this, new HttpClientStack(mHttpClient));
} return mRequestQueue;
}/**
* Method to set a cookie */public void setCookie() {
CookieStore cs = mHttpClient.getCookieStore(); // create a cookie
cs.addCookie(new BasicClientCookie2("cookie", "spooky"));
}// add the cookie before adding the request to the queuesetCookie();// add the request to the queuemRequestQueue.add(request);
7.錯誤處理
正如前面代碼看到的，在建立一個請求時，須要添加一個錯誤監聽onErrorResponse。若是請求發生異常，會返回一個VolleyError實例。
如下是Volley的異常列表：
AuthFailureError：若是在作一個HTTP的身份驗證，可能會發生這個錯誤。
NetworkError：Socket關閉，服務器宕機，DNS錯誤都會產生這個錯誤。
NoConnectionError：和NetworkError相似，這個是客戶端沒有網絡鏈接。
ParseError：在使用JsonObjectRequest或JsonArrayRequest時，若是接收到的JSON是畸形，會產生異常。
SERVERERROR：服務器的響應的一個錯誤，最有可能的4xx或5xx HTTP狀態代碼。
TimeoutError：Socket超時，服務器太忙或網絡延遲會產生這個異常。默認狀況下，Volley的超時時間爲2.5秒。若是獲得這個錯誤可使用RetryPolicy。
可使用一個簡單的Help類根據這些異常提示相應的信息：
public class VolleyErrorHelper { /**
* Returns appropriate message which is to be displayed to the user
* against the specified error object.
*
* @param error
* @param context
* @return
*/
public static String getMessage(Object error, Context context) { if (error instanceof TimeoutError) { return context.getResources().getString(R.string.generic_server_down);
} else if (isServerProblem(error)) { return handleServerError(error, context);
} else if (isNetworkProblem(error)) { return context.getResources().getString(R.string.no_internet);
} return context.getResources().getString(R.string.generic_error);
}
/**
* Determines whether the error is related to network
* @param error
* @return
*/
private static boolean isNetworkProblem(Object error) { return (error instanceof NetworkError) || (error instanceof NoConnectionError);
} /**
* Determines whether the error is related to server
* @param error
* @return
*/
private static boolean isServerProblem(Object error) { return (error instanceof ServerError) || (error instanceof AuthFailureError);
} /**
* Handles the server error, tries to determine whether to show a stock message or to
* show a message retrieved from the server.
*
* @param err
* @param context
* @return
*/
private static String handleServerError(Object err, Context context) {
VolleyError error = (VolleyError) err;
NetworkResponse response = error.networkResponse;
if (response != null) { switch (response.statusCode) { case 404: case 422: case 401: try { // server might return error like this { "error": "Some error occured" } // Use "Gson" to parse the result
HashMap<String, String> result = new Gson().fromJson(new String(response.data), new TypeToken<Map<String, String>>() {
}.getType()); if (result != null && result.containsKey("error")) { return result.get("error");
}
} catch (Exception e) {
e.printStackTrace();
} // invalid request
return error.getMessage(); default: return context.getResources().getString(R.string.generic_server_down);
}
} return context.getResources().getString(R.string.generic_error);
}
}
總結：
Volley是一個很是好的庫，你能夠嘗試使用一下，它會幫助你簡化網絡請求，帶來更多的益處。
我也但願更加全面的介紹Volley，之後可能會介紹使用volley加載圖像的內容，歡迎關注
- 1. STM32 讀寫保護功能及設置
- 2. git經常使用功能及設置
- 3. idea常用功能及設置
- 4. nginx的功能及配置
- 5. volley 實現驗證碼功能
- 6. IDEA設置導包功能
- 7. PHPStorm 常用功能設置
- 8. jqGrid常用功能設置
- 9. Win10設置分屏功能
- 10. Unity 設置Android端設備UI界面自動旋轉功能
- 更多相關文章...
- • MySQL 5.7的新特性（新功能） - MySQL教程
- • Spring Bean的配置及常用屬性 - Spring教程
- • IntelliJ IDEA代碼格式化設置
- • Flink 數據傳輸及反壓詳解
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. STM32 讀寫保護功能及設置
- 2. git經常使用功能及設置
- 3. idea常用功能及設置
- 4. nginx的功能及配置
- 5. volley 實現驗證碼功能
- 6. IDEA設置導包功能
- 7. PHPStorm 常用功能設置
- 8. jqGrid常用功能設置
- 9. Win10設置分屏功能
- 10. Unity 設置Android端設備UI界面自動旋轉功能