Volley的基本使用
Volley 是 Google开发的一个网络请求框架，可以让你更加简单并且快速的访问网络数据。Volley库的网络请求都是异步的，不必担心异步处理问题。
Volley请求网路都是基于请求队列的，只要把请求放置在请求队列中就可以了。请求队列会依次进行请求。创建请求队列的方式如下所示：
RequestQueue mQueue = Volley.newRequestQueue(getApplicationContext());
如果一个应用的网络请求不是很复杂，那么通常一个请求队列（对应于Application）就可以，也可以一个Activity对应一个网络请求队列。
对应这个请求队列，可以放StringRequest、StringRequest、ImageRequest进去。
- StringRequest
StringRequest返回的数据就是String 类型的。
下面是使用Get请求访问百度。
RequestQueue mQueue = Volley.newRequestQueue(getApplicationContext());
String url = "https://www.baidu.com";
StringRequest stringRequest = new StringRequest(Request.Method.GET, url, new Response.Listener() {
@Override
public void onResponse(String response) {
System.out.println("response:" + response);
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
System.out.println("error:" + error.getMessage());
}
});
mQueue.add(stringRequest);
如果想要使用post请求访问一个url的话，那么修改为如下：
RequestQueue mQueue = Volley.newRequestQueue(getApplicationContext());
String url = "https://www.baidu.com";
StringRequest stringRequest = new StringRequest(Request.Method.POST, url, new Response.Listener() {
@Override
public void onResponse(String response) {
System.out.println("response:" + response);
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
System.out.println("error:" + error.getMessage());
}
}) {
@Override
protected Map getParams() throws AuthFailureError {
Map map = new HashMap();
map.put("params1", "value1");
map.put("params2", "value2");
return map;
}
};
mQueue.add(stringRequest);
}
});
因为Request并没有类似setParams()的方法，所以要使用post设置参数的话要重写getParams()方法。
- JsonRequest
有时候为了返回的数据为Json数据，那么就可以使用JsonRequest来进行访问。同样的访问方式和StringRequest一样。
RequestQueue mQueue = Volley.newRequestQueue(getApplicationContext());
String url = "http://api.12355.net/common/district/getDistrictByType?page=1&rows=100&type=1&parentDid=440000&_=1507512923786";
JsonObjectRequest jsonObjectRequest = new JsonObjectRequest(Request.Method.GET, url, null,
new Response.Listener() {
@Override
public void onResponse(JSONObject response) {
System.out.println("response:" + response);
//用json 解析了
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
System.out.println("error:" + error.getMessage());
}
});
mQueue.add(jsonObjectRequest);
当访问的不是返回Json数据的时候就会输出：
System.out: error:org.json.JSONException: Value
- ImageRequest
这个是用来加载图片的，但是现在已经过时了，用法也十分类似。
RequestQueue mQueue = Volley.newRequestQueue(getApplicationContext());
String url = "http://img3.redocn.com/tupian/20150421/xiaohuakafeikafeibeibiankuangsucai_4013296.jpg";
ImageRequest imageRequest = new ImageRequest(url, new Response.Listener() {
@Override
public void onResponse(Bitmap response) {
mIvImageRequest.setImageBitmap(response);
}
}, 0, 0, Bitmap.Config.RGB_565, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
System.out.println("error:" + error.getMessage());
}
});
mQueue.add(imageRequest);
源码解析
使用Volley之前首先要创建的就是请求队列RequestQueue，那么就从这个开始入手。
RequestQueue mQueue = Volley.newRequestQueue(getApplicationContext());
点进源码到 Volley.java
public static RequestQueue newRequestQueue(Context context) {
return newRequestQueue(context, (BaseHttpStack) null);
}
这个就转到了另一个重载中
public static RequestQueue newRequestQueue(Context context, BaseHttpStack stack) {
BasicNetwork network;
if (stack == null) {
if (Build.VERSION.SDK_INT >= 9) { //注 1
network = new BasicNetwork(new HurlStack());
} else {
String userAgent = "volley/0";
try {
String packageName = context.getPackageName();
PackageInfo info = context.getPackageManager().getPackageInfo(packageName, 0);
userAgent = packageName + "/" + info.versionCode;
} catch (NameNotFoundException e) {
}
network = new BasicNetwork(
new HttpClientStack(AndroidHttpClient.newInstance(userAgent)));
}
} else {
network = new BasicNetwork(stack);
}
return newRequestQueue(context, network);
}
注1 ： 上面判断Android的版本是否大于或等于2.3，如果大于2.3则调用HttpUrlConnection的HurlStack，否则就使用HttpClient的HttpClientStack。
接下来就是下一个重载
private static RequestQueue newRequestQueue(Context context, Network network) {
File cacheDir = new File(context.getCacheDir(), DEFAULT_CACHE_DIR);
RequestQueue queue = new RequestQueue(new DiskBasedCache(cacheDir), network);
queue.start();
return queue;
}
这里就是创建出相对应的RequestQueue并调用start()方法
public void start() {
stop();
//注 1
mCacheDispatcher = new CacheDispatcher(mCacheQueue, mNetworkQueue, mCache, mDelivery);
mCacheDispatcher.start();
//注 2
for (int i = 0; i < mDispatchers.length; i++) {
NetworkDispatcher networkDispatcher = new NetworkDispatcher(mNetworkQueue, mNetwork,
mCache, mDelivery);
mDispatchers[i] = networkDispatcher;
networkDispatcher.start();
}
}
注1 ： CacheDispatcher是缓存调度线程，并调用了start()方法。
注2 ： NetworkDispatcher 是网络调度线程。在for循环中调用了NetworkDispatcher 的start()方法。
/** Number of network request dispatcher threads to start. */
private static final int DEFAULT_NETWORK_THREAD_POOL_SIZE = 4;
mDispatchers.length的长度默认是4，默认开启了4个网络调度线程，再加上1个缓存调度线程，就有5个线程在后台运行并等待请求的到来。
按照Volley的使用，接下来我们就会创建各种Request（上面的StringRequest、JsonRequest、ImageRequest均为Request的子类），并调用RequestQueue的add()方法。
public Request add(Request request) {
//将请求标记为此队列，并将其添加到当前请求队列中。
request.setRequestQueue(this);
synchronized (mCurrentRequests) {
mCurrentRequests.add(request);
}
//按照添加的顺序处理请求。
request.setSequence(getSequenceNumber());
request.addMarker("add-to-queue");
//如果请求不可缓存，请跳过缓存队列并直接进入网络。
if (!request.shouldCache()) {
mNetworkQueue.add(request);
return request;
}
mCacheQueue.add(request);
return request;
}
从上面的add()方法可以看出来他并没有进行请求网络，而是把这个请求放置他该放置的地方。
在后台的网络调度线程和缓存调度线程会不断的轮询各自的请求队列，若发现有请求任务则开始执行。
CacheDispatcher 缓存调度线程
那么接下来就要看看 CacheDispatcher 缓存调度线程了。在上面我们可以知道了CacheDispatcher被调用了start()方法，那么就看一下CacheDispatcher 里面的run()方法。
@Override
public void run() {
.....
while (true) {
try {
//获取缓存队列中的一个请求，当没有请求时会阻塞直到有至少一个请求
final Request request = mCacheQueue.take();
request.addMarker("cache-queue-take");
//如果请求已经取消，则将请求停止，并读取下一个请求
if (request.isCanceled()) {
request.finish("cache-discard-canceled");
continue;
}
// 查看是否有缓存的响应
Cache.Entry entry = mCache.get(request.getCacheKey());
//如果缓存响应为空，那么就把该请求加入到网络队列
if (entry == null) {
request.addMarker("cache-miss");
if (!mWaitingRequestManager.maybeAddToWaitingRequests(request)) {
mNetworkQueue.put(request);
}
continue;
}
// 如果缓存过期，同样将他放置到网络队列上
if (entry.isExpired()) {
request.addMarker("cache-hit-expired");
request.setCacheEntry(entry);
if (!mWaitingRequestManager.maybeAddToWaitingRequests(request)) {
mNetworkQueue.put(request);
}
continue;
}
// 缓存命中，解析其数据以传送回请求。
request.addMarker("cache-hit");
Response response = request.parseNetworkResponse(
new NetworkResponse(entry.data, entry.responseHeaders));
request.addMarker("cache-hit-parsed");
if (!entry.refreshNeeded()) {
// 如果entry数据不需要刷新，则使用mDelivery将响应传递出去
mDelivery.postResponse(request, response);
} else {
// Soft-expired cache hit. We can deliver the cached response,
// but we need to also send the request to the network for
// refreshing.
//缓存的数据需要再次更新，那么现将缓存数据返回给用户，接着通过主线程发起同步数据请求
//虽然被缓存命中，但数据轻微过期。我们可以将缓存响应数据传递分发，但我们同样需要将请求发送到mNetworkQueue去刷新、更新。
request.addMarker("cache-hit-refresh-needed");
request.setCacheEntry(entry);
response.intermediate = true;
if (!mWaitingRequestManager.maybeAddToWaitingRequests(request)) {
// Post the intermediate response back to the user and have
// the delivery then forward the request along to the network.
mDelivery.postResponse(request, response, new Runnable() {
@Override
public void run() {
try {
mNetworkQueue.put(request);
} catch (InterruptedException e) {
// Restore the interrupted status
Thread.currentThread().interrupt();
}
}
});
} else {
// request has been added to list of waiting requests
// to receive the network response from the first request once it returns.
mDelivery.postResponse(request, response);
}
}
} catch (InterruptedException e) {
// We may have been interrupted because it was time to quit.
if (mQuit) {
return;
}
}
}
}
首先从缓存队列中取出请求，判断是否被取消，如果没有被取消就判断是否有缓存响应，如果有缓存响应且没有过期，就进行解析并回调给主线程，如果没有响应或者有响应但过期就加入网络调度线程队列。
NetworkDispatcher 网络调度线程
当RequestQueue.start()的时候，NetworkDispatcher 这个线程也会开始start
public void run() {
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
while (true) {
long startTimeMs = SystemClock.elapsedRealtime();
Request request;
try {
//从队列里面取出请求
request = mQueue.take();
} catch (InterruptedException e) {
if (mQuit) {
return;
}
continue;
}
try {
request.addMarker("network-queue-take");
// 请求是否被取消
if (request.isCanceled()) {
request.finish("network-discard-cancelled");
request.notifyListenerResponseNotUsable();
continue;
}
addTrafficStatsTag(request);
// 请求网络
NetworkResponse networkResponse = mNetwork.performRequest(request);
request.addMarker("network-http-complete");
// If the server returned 304 AND we delivered a response already,
// we're done -- don't deliver a second identical response.
if (networkResponse.notModified && request.hasHadResponseDelivered()) {
request.finish("not-modified");
request.notifyListenerResponseNotUsable();
continue;
}
// 在线程池解析响应
Response response = request.parseNetworkResponse(networkResponse);
request.addMarker("network-parse-complete");
// 将响应写入缓存
// TODO: Only update cache metadata instead of entire record for 304s.
if (request.shouldCache() && response.cacheEntry != null) {
mCache.put(request.getCacheKey(), response.cacheEntry);
request.addMarker("network-cache-written");
}
// Post the response back.
request.markDelivered();
mDelivery.postResponse(request, response);
request.notifyListenerResponseReceived(response);
.....
}
network = new BasicNetwork(stack);
如果没有被取消，那么接下来就是网络请求了
NetworkResponse networkResponse = mNetwork.performRequest(request);
而这时的 mNetwork 就是在Volley.java文件下的newRequestQueue方法中初始化的
查看BasicNetwork中的 performRequest()方法
public NetworkResponse performRequest(Request request) throws VolleyError {
long requestStart = SystemClock.elapsedRealtime();
while (true) {
HttpResponse httpResponse = null;
byte[] responseContents = null;
List responseHeaders = Collections.emptyList();
try {
// 收集请求头
Map additionalRequestHeaders =
getCacheHeaders(request.getCacheEntry());
//请求网络
httpResponse = mBaseHttpStack.executeRequest(request, additionalRequestHeaders);
int statusCode = httpResponse.getStatusCode();
....
}
从上面可以知道performRequest() 方法中实际访问网络的就是
mBaseHttpStack.executeRequest(request, additionalRequestHeaders);
在创建 mNetwork 的时候，我们已经为 mBaseHttpStack 赋值呢。 mBaseHttpStack，还记得上面所说的 ： 判断Android的版本是否大于或等于2.3，如果大于2.3则调用HttpUrlConnection的HurlStack，否则就使用HttpClient的HttpClientStack。那么这时候的 mBaseHttpStack 要么为 HttpUrlConnection的HurlStack ，要么为 HttpClient的HttpClientStack 。
网络请求就会根据不同的情况使用不同的种类进行网络访问。
既然访问完了就要进行回调了。那么此时我们又要回到 NetworkDispatcher 的run () 方法上面 。
从请求完成后的代码，我们可以看到的是将请求写入缓存，然后就将响应发出。而发出响应的关键就是：
mDelivery.postResponse(request, response);
在 NetworkDispatcher 中的 mDelivery 也是个接口而已 ， 而这个的初始化 也在
RequestQueue的构造函数中。
public RequestQueue(Cache cache, Network network, int threadPoolSize) {
this(cache, network, threadPoolSize,
new ExecutorDelivery(new Handler(Looper.getMainLooper())));
}
所以查看 ExecutorDelivery 这个类中的postResponse() 方法。注意传递给ExecutorDelivery的参数为主线程的Handler。所以后面回调的就会在主线程中。
@Override
public void postResponse(Request request, Response response, Runnable runnable) {
request.markDelivered();
request.addMarker("post-response");
mResponsePoster.execute(new ResponseDeliveryRunnable(request, response, runnable));
}
然后继续查看 ResponseDeliveryRunnable 里面的 run() 方法。
public void run() {
// If this request has canceled, finish it and don't deliver.
if (mRequest.isCanceled()) {
mRequest.finish("canceled-at-delivery");
return;
}
// 回调
if (mResponse.isSuccess()) {
mRequest.deliverResponse(mResponse.result);
} else {
mRequest.deliverError(mResponse.error);
}
.....
}
从上面就可以很清楚的看到，成功的时候将调用 mRequest.deliverResponse(mResponse.result);在这里 mRequest 是 Request 这个抽象类的对象，而要查看相对deliverResponse的方法的实现就是 StringRequest 或JsonRequest等Request子类。
假设 StringRequest ： 那么查看其deliverResponse()方法
@Override
protected void deliverResponse(String response) {
if (mListener != null) {
mListener.onResponse(response);
}
}
最后将调用 mListener.onResponse(response); ，而这个方法就是我们在创建StringRequest时传进去的方法。
最后总结一下为下图所示：