[转]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界面自动旋转功能