Android Volley库源码简析(HTTP Request部分)

移动开发 Android
可以看出,Volley源码放置得较为杂乱,不同功能模块的类并没有归到不同的包中。相比之下UIL的源码结构较为规范和合理。

目源码的目录树:

  1. [android] 
  2. ┗━[volley] 
  3. ┣━AuthFailureError.java 
  4. ┣━Cache.java 
  5. ┣━CacheDispatcher.java 
  6. ┣━DefaultRetryPolicy.java 
  7. ┣━ExecutorDelivery.java 
  8. ┣━InternalUtils.java 
  9. ┣━Network.java 
  10. ┣━NetworkDispatcher.java 
  11. ┣━NetworkError.java 
  12. ┣━NetworkResponse.java 
  13. ┣━NoConnectionError.java 
  14. ┣━ParseError.java 
  15. ┣━RedirectError.java 
  16. ┣━Request.java 
  17. ┣━RequestQueue.java 
  18. ┣━Response.java 
  19. ┣━ResponseDelivery.java 
  20. ┣━RetryPolicy.java 
  21. ┣━ServerError.java 
  22. ┣━TimeoutError.java 
  23. ┣━[toolbox] 
  24. ┃ ┣━AndroidAuthenticator.java 
  25. ┃ ┣━Authenticator.java 
  26. ┃ ┣━BasicNetwork.java 
  27. ┃ ┣━ByteArrayPool.java 
  28. ┃ ┣━ClearCacheRequest.java 
  29. ┃ ┣━DiskBasedCache.java 
  30. ┃ ┣━HttpClientStack.java 
  31. ┃ ┣━HttpHeaderParser.java 
  32. ┃ ┣━HttpStack.java 
  33. ┃ ┣━HurlStack.java 
  34. ┃ ┣━ImageLoader.java 
  35. ┃ ┣━ImageRequest.java 
  36. ┃ ┣━JsonArrayRequest.java 
  37. ┃ ┣━JsonObjectRequest.java 
  38. ┃ ┣━JsonRequest.java 
  39. ┃ ┣━NetworkImageView.java 
  40. ┃ ┣━NoCache.java 
  41. ┃ ┣━PoolingByteArrayOutputStream.java 
  42. ┃ ┣━RequestFuture.java 
  43. ┃ ┣━StringRequest.java 
  44. ┃ ┗━Volley.java 
  45. ┣━VolleyError.java 
  46. ┗━VolleyLog.java 

可以看出,Volley源码放置得较为杂乱,不同功能模块的类并没有归到不同的包中。相比之下UIL的源码结构较为规范和合理。

 

从常用case入手,推断其项目架构

 

官网上给出的最简单的使用例子如下所示:

final TextView mTextView = (TextView) findViewById(R.id.text);

 

  1. // 1. 新建一个Queue 
  2. RequestQueue queue = Volley.newRequestQueue(this); 
  3. String url ="http://www.google.com"
  4.  
  5. // 2. 新建一个Request,写好listener 
  6. StringRequest stringRequest = new StringRequest(Request.Method.GET, url, 
  7. new Response.Listener<String>() { 
  8. @Override 
  9. public void onResponse(String response) { 
  10. // Display the first 500 characters of the response string. 
  11. mTextView.setText("Response is: "+ response.substring(0,500)); 
  12. }, new Response.ErrorListener() { 
  13. @Override 
  14. public void onErrorResponse(VolleyError error) { 
  15. mTextView.setText("That didn't work!"); 
  16. }); 
  17. // 3. 将Request放到Queue里面执行 
  18. queue.add(stringRequest); 
  19.  
  20. 结合下面这张图: 
  21.  
  22. 架构图 
  23.  
  24. 我们可以大致了解Volley的使用方法(见注释)和内部结构。下面就这个usecase展开进行源码级别的简述。 
  25. Volley类 
  26.  
  27. Volley类提供了4个静态方法来方便用户新建Queue。其中: 
  28.  
  29. public static RequestQueue newRequestQueue(Context context) { 
  30. return newRequestQueue(context, null); 
  31.  
  32. 一句最终会调用: 
  33.  
  34. // 传入 context,stack=null,maxDiskCacheBytes=-1 
  35. public static RequestQueue newRequestQueue(Context context, HttpStack stack, int maxDiskCacheBytes) { 
  36. File cacheDir = new File(context.getCacheDir(), DEFAULT_CACHE_DIR); 
  37.  
  38. String userAgent = "volley/0"//1. 设置userAgent 
  39. try { 
  40. String packageName = context.getPackageName(); 
  41. PackageInfo info = context.getPackageManager().getPackageInfo(packageName, 0); 
  42. userAgent = packageName + "/" + info.versionCode; 
  43. catch (NameNotFoundException e) { 
  44.  
  45. if (stack == null) { 
  46. if (Build.VERSION.SDK_INT >= 9) { //2. 选择用哪个httpclient 
  47. stack = new HurlStack(); 
  48. else { 
  49. // Prior to Gingerbread, HttpUrlConnection was unreliable. 
  50. // See: http://android-developers.blogspot.com/2011/09/androids-http-clients.html 
  51. stack = new HttpClientStack(AndroidHttpClient.newInstance(userAgent)); 
  52.  
  53. Network network = new BasicNetwork(stack); 
  54.  
  55. RequestQueue queue; 
  56. if (maxDiskCacheBytes <= -1
  57. // No maximum size specified 
  58. queue = new RequestQueue(new DiskBasedCache(cacheDir), network); //3. 新建Queue 
  59. else 
  60. // Disk cache size specified 
  61. queue = new RequestQueue(new DiskBasedCache(cacheDir, maxDiskCacheBytes), network); 
  62.  
  63. queue.start();// 4. 传入Queue 
  64.  
  65. return queue; 

 

值得注意的是:

Volley会根据SDK的version来决定使用java.net.HttpURLConnection(Build.VERSION.SDK_INT >= 9)还是org.apache.http.client.HttpClient

新建Queue后,Queue马上会被start。

 

  1.  stack类负责发送request(com.android.volley.Request)和获取response(org.apache.http.HttpResponse),network类负责分析和处理response,包装成NetworkResponse(com.android.volley.NetworkResponse)。 
  2.  
  3. 我们首先忽略掉network相关的细节,看一下queue的实现和request的调度策略。 
  4. RequestQueue 
  5.  
  6. 先来看一下RequestQueue的构造方法: 
  7.  
  8. public RequestQueue(Cache cache, Network network) { 
  9. this(cache, network, DEFAULT_NETWORK_THREAD_POOL_SIZE); 

 

调用:

 

  1. public RequestQueue(Cache cache, Network network, int threadPoolSize) { 
  2. this(cache, network, threadPoolSize, 
  3. new ExecutorDelivery(new Handler(Looper.getMainLooper()))); 
  4.  
  5. 这里出现了一个新面孔ExecutorDelivery,根据字面意思可以猜测它是负责将请求的结果分发到主线程上,或者在主线程上执行回调(listener)。继续调用: 
  6.  
  7. public RequestQueue(Cache cache, Network network, int threadPoolSize, 
  8. ResponseDelivery delivery) { 
  9. mCache = cache; 
  10. mNetwork = network; 
  11. mDispatchers = new NetworkDispatcher[threadPoolSize]; 
  12. mDelivery = delivery; 

 

这里又出现了一个新面孔NetworkDispatcher。留意到threadPoolSize这个数组长度参数的字面意义,结合上面的Volley架构图,猜想NetworkDispatcher是一个work thread,循环等待并通过network执行在Queue上的request。

RequestQueue被实例化后,便调用其start()方法:

 

  1. public void start() { 
  2. stop(); // Make sure any currently running dispatchers are stopped. 
  3. // Create the cache dispatcher and start it. 
  4. mCacheDispatcher = new CacheDispatcher(mCacheQueue, mNetworkQueue, mCache, mDelivery); 
  5. mCacheDispatcher.start(); 
  6.  
  7. // Create network dispatchers (and corresponding threads) up to the pool size. 
  8. for (int i = 0; i < mDispatchers.length; i++) { 
  9. NetworkDispatcher networkDispatcher = new NetworkDispatcher(mNetworkQueue, mNetwork, 
  10. mCache, mDelivery); 
  11. mDispatchers[i] = networkDispatcher; 
  12. networkDispatcher.start(); 
  13.  
  14. 相应地有: 
  15.  
  16. public void stop() { 
  17. if (mCacheDispatcher != null) { 
  18. mCacheDispatcher.quit(); 
  19. for (int i = 0; i < mDispatchers.length; i++) { 
  20. if (mDispatchers[i] != null) { 
  21. mDispatchers[i].quit(); 

 

这里的逻辑很简单:

开始之前停止所有旧的任务(即interrupt所有worker thread)。

启动一个负责cache的worker thread。

启动n个负责network的worker thread。

worker thread开始不断地等待来自Queue的request。

Request

接下来执行queue.add(stringRequest); ,一个request被加入到queue中,代码如下所示:

 

  1. public <T> Request<T> add(Request<T> request) { 
  2. // Tag the request as belonging to this queue and add it to the set of current requests. 
  3. request.setRequestQueue(this); 
  4. synchronized (mCurrentRequests) { 
  5. mCurrentRequests.add(request); 
  6.  
  7. // Process requests in the order they are added. 
  8. request.setSequence(getSequenceNumber()); 
  9. request.addMarker("add-to-queue"); // marker用来指示request当前的状态,实际上是用来打log 
  10.  
  11. // If the request is uncacheable, skip the cache queue and go straight to the network. 
  12. if (!request.shouldCache()) { 
  13. mNetworkQueue.add(request); 
  14. return request; 
  15.  
  16. // Insert request into stage if there's already a request with the same cache key in flight. 
  17. synchronized (mWaitingRequests) { 
  18. String cacheKey = request.getCacheKey(); 
  19. if (mWaitingRequests.containsKey(cacheKey)) { 
  20. // There is already a request in flight. Queue up. 
  21. Queue<Request<?>> stagedRequests = mWaitingRequests.get(cacheKey); 
  22. if (stagedRequests == null) { 
  23. stagedRequests = new LinkedList<Request<?>>(); 
  24. stagedRequests.add(request); 
  25. mWaitingRequests.put(cacheKey, stagedRequests); 
  26. if (VolleyLog.DEBUG) { 
  27. VolleyLog.v("Request for cacheKey=%s is in flight, putting on hold.", cacheKey); 
  28. else { 
  29. // Insert 'null' queue for this cacheKey, indicating there is now a request in 
  30. // flight. 
  31. mWaitingRequests.put(cacheKey, null); 
  32. mCacheQueue.add(request); 
  33. return request; 

 

这里的逻辑是:

对新加进来的request进行一些设置。

如果不需要cache,那么把request直接加到network queue中。

根据key检查request是否正在执行。如果是,则将其放入到waiting链表中。猜想当request完成的时候会调用某个方法将key在waiting链表中删除,然后依次执行waiting的request。如果否,则将其加入cache queue中。

CacheDispatcher

假设该uri访问是***次执行,那么对应的request会被放到cache queue中。cache worker thread(cache dispatcher)发现cache queue中存在request,会马上将其dequeue并执行。我们来看一下CacheDispatcher的run方法:

  1. public class CacheDispatcher extends Thread { 
  2.  
  3. private final Cache mCache; // 一开始传入了“new DiskBasedCache(cacheDir)” 
  4.  
  5. ... 
  6.  
  7. public void quit() { 
  8. mQuit = true
  9. interrupt(); 
  10.  
  11. @Override 
  12. public void run() { 
  13. if (DEBUG) VolleyLog.v("start new dispatcher"); 
  14. Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND); 
  15.  
  16. // Make a blocking call to initialize the cache. 
  17. mCache.initialize(); 
  18.  
  19. Request<?> request; 
  20. while (true) { 
  21. // release previous request object to avoid leaking request object when mQueue is drained. 
  22. request = null//确保***一个request做完后能及时回收内存。 
  23. try { 
  24. // Take a request from the queue. 
  25. request = mCacheQueue.take(); // 堵塞 
  26. catch (InterruptedException e) { 
  27. // We may have been interrupted because it was time to quit. 
  28. if (mQuit) { 
  29. return// 退出点 
  30. continue
  31. try { 
  32. request.addMarker("cache-queue-take"); 
  33.  
  34. // If the request has been canceled, don't bother dispatching it. 
  35. if (request.isCanceled()) { 
  36. request.finish("cache-discard-canceled"); 
  37. continue
  38.  
  39. // miss cache则直接将request放到network queue中 
  40. Cache.Entry entry = mCache.get(request.getCacheKey()); 
  41. if (entry == null) { 
  42. request.addMarker("cache-miss"); 
  43. // Cache miss; send off to the network dispatcher. 
  44. mNetworkQueue.put(request); 
  45. continue
  46.  
  47. // cache 过期了,直接将request放到network queue中 
  48. if (entry.isExpired()) { 
  49. request.addMarker("cache-hit-expired"); 
  50. request.setCacheEntry(entry); 
  51. mNetworkQueue.put(request); 
  52. continue
  53.  
  54. // 将cache中的data包装成一个response 
  55. request.addMarker("cache-hit"); 
  56. Response<?> response = request.parseNetworkResponse( 
  57. new NetworkResponse(entry.data, entry.responseHeaders)); 
  58. request.addMarker("cache-hit-parsed"); 
  59.  
  60. if (!entry.refreshNeeded()) { 
  61. // cache不需要刷新,直接将response交给delivery 
  62. mDelivery.postResponse(request, response); 
  63. else { 
  64. // cache需要刷新。现将旧的内容返回,同时将request放进network queue。 
  65. request.addMarker("cache-hit-refresh-needed"); 
  66. request.setCacheEntry(entry); 
  67.  
  68. // Mark the response as intermediate. 
  69. response.intermediate = true
  70.  
  71. // Post the intermediate response back to the user and have 
  72. // the delivery then forward the request along to the network. 
  73. final Request<?> finalRequest = request; 
  74. mDelivery.postResponse(request, response, new Runnable() { 
  75. @Override 
  76. public void run() { 
  77. try { 
  78. mNetworkQueue.put(finalRequest); 
  79. catch (InterruptedException e) { 
  80. // Not much we can do about this. 
  81. }); 
  82. catch (Exception e) { 
  83. VolleyLog.e(e, "Unhandled exception %s", e.toString()); 

 

接下来看一下mDelivery.postResponse这个方法。

 

ExecutorDelivery

 

从上文得知,mDelivery是一个ExecutorDelivery的实例(在新建RequestQueue时传入)。

ExecutorDelivery的初始化代码如下所示:

  1. public ExecutorDelivery(final Handler handler) { 
  2. // Make an Executor that just wraps the handler. 
  3. mResponsePoster = new Executor() { // java.util.concurrent.Executor; 
  4. @Override 
  5. public void execute(Runnable command) { 
  6. handler.post(command); 
  7. }; 

关于java.util.concurrent.Executor可以看这篇文章,这里就不展开了。

postResponse代码如下所示:

  1. @Override 
  2. public void postResponse(Request<?> request, Response<?> response, Runnable runnable) { 
  3. request.markDelivered(); //标记为已分发 
  4. request.addMarker("post-response"); 
  5. mResponsePoster.execute(new ResponseDeliveryRunnable(request, response, runnable)); // 在初始化时传入的handler中执行ResponseDeliveryRunnable 
  6.  
  7. ResponseDeliveryRunnable是ExecutorDelivery的一个子类,负责根据request的不同结果调用对应的listener方法: 
  8.  
  9. @SuppressWarnings("rawtypes"
  10. private class ResponseDeliveryRunnable implements Runnable { 
  11.  
  12. private final Request mRequest; 
  13. private final Response mResponse; 
  14. private final Runnable mRunnable; 
  15.  
  16. public ResponseDeliveryRunnable(Request request, Response response, Runnable runnable) { 
  17. mRequest = request; 
  18. mResponse = response; 
  19. mRunnable = runnable; 
  20.  
  21. @SuppressWarnings("unchecked"
  22. @Override 
  23. public void run() { // 在主线程中执行 
  24. // If this request has canceled, finish it and don't deliver. 
  25. if (mRequest.isCanceled()) { 
  26. mRequest.finish("canceled-at-delivery"); // 会调用 RequestQueue的finish方法 
  27. return
  28.  
  29. // Deliver a normal response or error, depending. 
  30. if (mResponse.isSuccess()) { 
  31. mRequest.deliverResponse(mResponse.result); //调用 listener的onResponse(response) 
  32. else { 
  33. mRequest.deliverError(mResponse.error); 
  34.  
  35. // If this is an intermediate response, add a marker, otherwise we're done 
  36. // and the request can be finished. 
  37. if (mResponse.intermediate) { 
  38. mRequest.addMarker("intermediate-response"); 
  39. else { 
  40. mRequest.finish("done"); 
  41.  
  42. // If we have been provided a post-delivery runnable, run it. 
  43. if (mRunnable != null) { 
  44. mRunnable.run(); 

接下来我们回头看看NetworkDispatcher对network queue的处理。

 

NetworkDispatcher

 

NetworkDispatcher的源码如下所示:

  1. public class NetworkDispatcher extends Thread { 
  2.  
  3. private final Network mNetwork; // BasicNetwork实例 
  4.  
  5. ... 
  6.  
  7. private final BlockingQueue<Request<?>> mQueue; // network queue 
  8.  
  9. ... 
  10.  
  11. public void quit() { 
  12. mQuit = true
  13. interrupt(); 
  14.  
  15. @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH) 
  16. private void addTrafficStatsTag(Request<?> request) { // 方便统计Volley的网络流量 
  17. ... 
  18.  
  19. @Override 
  20. public void run() { 
  21. Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND); 
  22. Request<?> request; 
  23. while (true) { 
  24. long startTimeMs = SystemClock.elapsedRealtime(); 
  25. // release previous request object to avoid leaking request object when mQueue is drained. 
  26. request = null
  27. try { 
  28. //1. 堵塞读取network queue中的request 
  29. request = mQueue.take(); 
  30. catch (InterruptedException e) { 
  31. // We may have been interrupted because it was time to quit. 
  32. if (mQuit) { 
  33. return
  34. continue
  35.  
  36. try { 
  37. request.addMarker("network-queue-take"); 
  38.  
  39. // If the request was cancelled already, do not perform the 
  40. // network request. 
  41. if (request.isCanceled()) { 
  42. request.finish("network-discard-cancelled"); 
  43. continue
  44.  
  45. addTrafficStatsTag(request); 
  46.  
  47. //2. 在network对象中堵塞执行request 
  48. NetworkResponse networkResponse = mNetwork.performRequest(request); 
  49. request.addMarker("network-http-complete"); 
  50.  
  51. // If the server returned 304 AND we delivered a response already, 
  52. // we're done -- don't deliver a second identical response. 
  53. if (networkResponse.notModified && request.hasHadResponseDelivered()) { // 304表示资源未被修改 
  54. request.finish("not-modified"); 
  55. continue
  56.  
  57. //3. 将NetworkResponse转成Response 
  58. Response<?> response = request.parseNetworkResponse(networkResponse); 
  59. request.addMarker("network-parse-complete"); 
  60.  
  61. // Write to cache if applicable. 
  62. // TODO: Only update cache metadata instead of entire record for 304s. 
  63. if (request.shouldCache() && response.cacheEntry != null) { 
  64. // 4. Response放到cache中 
  65. mCache.put(request.getCacheKey(), response.cacheEntry); 
  66. request.addMarker("network-cache-written"); 
  67.  
  68. //5. 通过Delivery回调结果 
  69. request.markDelivered(); 
  70. mDelivery.postResponse(request, response); 
  71. catch (VolleyError volleyError) { 
  72. volleyError.setNetworkTimeMs(SystemClock.elapsedRealtime() - startTimeMs); 
  73. parseAndDeliverNetworkError(request, volleyError); 
  74. catch (Exception e) { 
  75. VolleyLog.e(e, "Unhandled exception %s", e.toString()); 
  76. VolleyError volleyError = new VolleyError(e); 
  77. volleyError.setNetworkTimeMs(SystemClock.elapsedRealtime() - startTimeMs); 
  78. mDelivery.postError(request, volleyError); 
  79.  
  80. private void parseAndDeliverNetworkError(Request<?> request, VolleyError error) { 
  81. error = request.parseNetworkError(error); 
  82. mDelivery.postError(request, error); 

 

NetworkDispatcher的处理流程和CacheDispatcher差不多,见注释。TrafficStats的介绍可以看这里。

上述代码的关键在于mNetwork.performRequest(request)和request.parseNetworkResponse(networkResponse)这两个调用。

 

 

  1. Network 
  2.  
  3. Network是一个接口,只有一个performRequest(Request<?> request)方法: 
  4.  
  5. public interface Network { 
  6.  
  7. public NetworkResponse performRequest(Request<?> request) throws VolleyError; 
  8.  

 

 

本文例子中Network的实现类是BasicNetwork:

  1. public class BasicNetwork implements Network { 
  2. protected static final boolean DEBUG = VolleyLog.DEBUG; 
  3. private static int SLOW_REQUEST_THRESHOLD_MS = 3000
  4. private static int DEFAULT_POOL_SIZE = 4096
  5. protected final HttpStack mHttpStack; 
  6. protected final ByteArrayPool mPool; 
  7.  
  8. public BasicNetwork(HttpStack httpStack) { 
  9. // If a pool isn't passed in, then build a small default pool that will give us a lot of 
  10. // benefit and not use too much memory. 
  11. this(httpStack, new ByteArrayPool(DEFAULT_POOL_SIZE)); 
  12. ... 
  13.  
  14. 注意到BasicNetwork的两个关键的成员:mHttpStack和mPool,和对apache依赖: 
  15.  
  16. import org.apache.http.Header; 
  17. import org.apache.http.HttpEntity; 
  18. import org.apache.http.HttpResponse; 
  19. import org.apache.http.HttpStatus; 
  20. import org.apache.http.StatusLine; 

 

可我们先来看一下performRequest()的执行流程:

 

  1. public NetworkResponse performRequest(Request<?> request) throws VolleyError { 
  2. long requestStart = SystemClock.elapsedRealtime(); 
  3. while (true) { 
  4. // 依赖 org.apache.http.HttpResponse 
  5. HttpResponse httpResponse = null
  6. byte[] responseContents = null
  7. Map<String, String> responseHeaders = Collections.emptyMap(); 
  8. try { 
  9. // 1. 生成header 
  10. Map<String, String> headers = new HashMap<String, String>(); 
  11. addCacheHeaders(headers, request.getCacheEntry()); 
  12. // 2. 通过httpstack发起请求。注意‘发起请求’这个动作不在request中进行,request只是保存着请求的信息。 
  13. httpResponse = mHttpStack.performRequest(request, headers); 
  14. // 3. 获得请求结果的一些信息 
  15. StatusLine statusLine = httpResponse.getStatusLine(); 
  16. int statusCode = statusLine.getStatusCode(); 
  17.  
  18. responseHeaders = convertHeaders(httpResponse.getAllHeaders()); 
  19. // 4. 通过statusCode(304)来判断是否可以直接使用cache 
  20. if (statusCode == HttpStatus.SC_NOT_MODIFIED) { 
  21.  
  22. Entry entry = request.getCacheEntry(); 
  23. if (entry == null) { 
  24. return new NetworkResponse(HttpStatus.SC_NOT_MODIFIED, null
  25. responseHeaders, true
  26. SystemClock.elapsedRealtime() - requestStart); 
  27.  
  28. // 从cache中取出data,返回新的NetworkResponse 
  29. entry.responseHeaders.putAll(responseHeaders); 
  30. return new NetworkResponse(HttpStatus.SC_NOT_MODIFIED, entry.data, 
  31. entry.responseHeaders, true
  32. SystemClock.elapsedRealtime() - requestStart); 
  33.  
  34. // 5. 通过statusCode通过判断是否需要重定向 
  35. if (statusCode == HttpStatus.SC_MOVED_PERMANENTLY || statusCode == HttpStatus.SC_MOVED_TEMPORARILY) { 
  36. String newUrl = responseHeaders.get("Location"); 
  37. request.setRedirectUrl(newUrl); 
  38.  
  39. // 6. 取出reponse中的data,为字节数组 
  40. // Some responses such as 204s do not have content. We must check. 
  41. if (httpResponse.getEntity() != null) { 
  42. // 通过entityToBytes从outputstream中读取数据,throws IOException 
  43. responseContents = entityToBytes(httpResponse.getEntity()); 
  44. else { 
  45. // Add 0 byte response as a way of honestly representing a 
  46. // no-content request. 
  47. responseContents = new byte[0]; 
  48.  
  49. // if the request is slow, log it. 
  50. long requestLifetime = SystemClock.elapsedRealtime() - requestStart; 
  51. logSlowRequests(requestLifetime, request, responseContents, statusLine); 
  52.  
  53. if (statusCode < 200 || statusCode > 299) { 
  54. throw new IOException(); 
  55. return new NetworkResponse(statusCode, responseContents, responseHeaders, false
  56. SystemClock.elapsedRealtime() - requestStart); 
  57. catch (SocketTimeoutException e) { 
  58. attemptRetryOnException("socket", request, new TimeoutError()); 
  59. catch (ConnectTimeoutException e) { 
  60. attemptRetryOnException("connection", request, new TimeoutError()); 
  61. catch (MalformedURLException e) { 
  62. throw new RuntimeException("Bad URL " + request.getUrl(), e); 
  63. catch (IOException e) { 
  64. // 7. 如果entityToBytes方法throw了IOException 
  65. int statusCode = 0
  66. NetworkResponse networkResponse = null
  67. if (httpResponse != null) { 
  68. statusCode = httpResponse.getStatusLine().getStatusCode(); 
  69. else { 
  70. throw new NoConnectionError(e); 
  71. if (statusCode == HttpStatus.SC_MOVED_PERMANENTLY || 
  72. statusCode == HttpStatus.SC_MOVED_TEMPORARILY) { 
  73. VolleyLog.e("Request at %s has been redirected to %s", request.getOriginUrl(), request.getUrl()); 
  74. else { 
  75. VolleyLog.e("Unexpected response code %d for %s", statusCode, request.getUrl()); 
  76. // 如果reponseContent有数据 
  77. if (responseContents != null) { 
  78. networkResponse = new NetworkResponse(statusCode, responseContents, 
  79. responseHeaders, false, SystemClock.elapsedRealtime() - requestStart); 
  80. // 那么根据statusCode执行重试 
  81. if (statusCode == HttpStatus.SC_UNAUTHORIZED || 
  82. statusCode == HttpStatus.SC_FORBIDDEN) { 
  83. attemptRetryOnException("auth"
  84. request, new AuthFailureError(networkResponse)); 
  85. else if (statusCode == HttpStatus.SC_MOVED_PERMANENTLY || 
  86. statusCode == HttpStatus.SC_MOVED_TEMPORARILY) { 
  87. attemptRetryOnException("redirect"
  88. request, new RedirectError(networkResponse)); 
  89. else { 
  90. // TODO: Only throw ServerError for 5xx status codes. 
  91. throw new ServerError(networkResponse); 
  92. else { 
  93. throw new NetworkError(e); 

attemptRetryOnException()代码如下所示:

 

  1. private static void attemptRetryOnException(String logPrefix, Request<?> request, 
  2.  
  3. VolleyError exception) throws VolleyError { 
  4.  
  5. RetryPolicy retryPolicy = request.getRetryPolicy(); 
  6.  
  7. int oldTimeout = request.getTimeoutMs(); 

 

  1. try { 
  2. // 关键语句 
  3. retryPolicy.retry(exception); 
  4. catch (VolleyError e) { 
  5. request.addMarker( 
  6. String.format("%s-timeout-giveup [timeout=%s]", logPrefix, oldTimeout)); 
  7. throw e; 
  8. request.addMarker(String.format("%s-retry [timeout=%s]", logPrefix, oldTimeout)); 

RetryPolicy是一个接口:

  1. public interface RetryPolicy { 
  2. public int getCurrentTimeout(); 
  3. public int getCurrentRetryCount(); 
  4. public void retry(VolleyError error) throws VolleyError; 

如没有特殊指定,request中的RetryPolicy为DefaultRetryPolicy,其retry方法实现如下:

  1. public void retry(VolleyError error) throws VolleyError { 
  2. mCurrentRetryCount++; 
  3. mCurrentTimeoutMs += (mCurrentTimeoutMs * mBackoffMultiplier); 
  4. if (!hasAttemptRemaining()) { 
  5. throw error; 

如果还没超出重试次数上限,那么不会抛出异常,并返回到performRequest()的while循环中。接下来分析一下BaseNetwork的entityToBytes()方法:

  1. private byte[] entityToBytes(HttpEntity entity) throws IOException, ServerError { 
  2. // 1. 新建PoolingByteArrayOutputStream 
  3. PoolingByteArrayOutputStream bytes = 
  4. new PoolingByteArrayOutputStream(mPool, (int) entity.getContentLength()); 
  5. byte[] buffer = null
  6. try { 
  7. InputStream in = entity.getContent(); 
  8. if (in == null) { 
  9. throw new ServerError(); 
  1. // 2. 在字节池中取出1024字节buffer 
  2. buffer = mPool.getBuf(1024); 
  3. int count; 
  4. // 3. 从entity的inputStream中读出数据到buffer 
  5. while ((count = in.read(buffer)) != -1) { 
  6. // 将buffer写到PoolingByteArrayOutputStream中 
  7. bytes.write(buffer, 0, count); 
  8. // 4. 将所有数据返回 
  9. return bytes.toByteArray(); 
  10. finally { 
  11. try { 
  12. // Close the InputStream and release the resources by "consuming the content". 
  13. entity.consumeContent(); 
  14. catch (IOException e) { 
  15. // This can happen if there was an exception above that left the entity in 
  16. // an invalid state. 
  17. VolleyLog.v("Error occured when calling consumingContent"); 
  18. // 5. 归还buffer到字节池 
  19. mPool.returnBuf(buffer); 
  20. bytes.close(); 
  21.  
  22. 执行步骤见代码注释。这里不对ByteArrayPool类和PoolingByteArrayOutputStream展开。 
  23. HttpStack 
  24.  
  25. HttpStack是一个接口,仅负责将request发送出去: 
  26.  
  27. public interface HttpStack { 
  28. public HttpResponse performRequest(Request<?> request, Map<String, String> additionalHeaders) 
  29. throws IOException, AuthFailureError; 

从最开始的对Volley类的分析可知,SDK version > 9的情况下使用HurlStack(java.net.HttpURLConnection),否则使用HttpClientStack(org.apache.http.client.HttpClient)。

stack各自实现了performRequest()方法,在内部正式发起了http请求。具体的用法参考各自的api文档,这里不详细展开了。

 

Request

 

Request类主要是保存着该次请求的参数和该次请求当前的状态,本身不含有请求相关的行为:

  1. public abstract class Request<T> implements Comparable<Request<T>> { 
  2.  
  3. ... 
  4.  
  5. public interface Method { 
  6. int DEPRECATED_GET_OR_POST = -1
  7. int GET = 0
  8. int POST = 1
  9. int PUT = 2
  10. int DELETE = 3
  11. int HEAD = 4
  12. int OPTIONS = 5
  13. int TRACE = 6
  14. int PATCH = 7
  15.  
  16. ... 
  17.  
  18. private final int mMethod; 
  19. private final String mUrl; 
  20. private String mRedirectUrl; 
  21. private String mIdentifier; 
  22. private final int mDefaultTrafficStatsTag; 
  23. private Response.ErrorListener mErrorListener; 
  24. private Integer mSequence; 
  25. private RequestQueue mRequestQueue; 
  26. private boolean mShouldCache = true
  27. private boolean mCanceled = false
  28. private boolean mResponseDelivered = false
  29. private RetryPolicy mRetryPolicy; 
  30.  
  31. ... 

下面再来分析一下request.parseNetworkResponse(networkResponse)这个方法。以StringRequest为例:

  1. @Override 
  2. protected Response<String> parseNetworkResponse(NetworkResponse response) { 
  3. String parsed; 
  4. try { 
  5. parsed = new String(response.data, HttpHeaderParser.parseCharset(response.headers)); 
  6. catch (UnsupportedEncodingException e) { 
  7. parsed = new String(response.data); 
  8. return Response.success(parsed, HttpHeaderParser.parseCacheHeaders(response)); 
  9.  
  10. 可以看到它只是简单地将data转换成string,然后返回一个success的response。 
  11.  
  12. 而JsonObjectRequest的实现如下: 
  13.  
  14. @Override 
  15. protected Response<JSONObject> parseNetworkResponse(NetworkResponse response) { 
  16. try { 
  17. String jsonString = new String(response.data, 
  18. HttpHeaderParser.parseCharset(response.headers, PROTOCOL_CHARSET)); 
  19. return Response.success(new JSONObject(jsonString), 
  20. HttpHeaderParser.parseCacheHeaders(response)); 
  21. catch (UnsupportedEncodingException e) { 
  22. return Response.error(new ParseError(e)); 
  23. catch (JSONException je) { 
  24. return Response.error(new ParseError(je)); 

它现将data转换成string,然后再生成一个JSONObject返回。

 

总结

 

综上,Volley的大致框架如下所述:

一个RequestQueue中包含两个内部queue,分别是cache queue和network queue。还有一个cache dispatcher和n个network dispatcher,它们都继承成于Thread,分别负责执行缓存和网络请求。还有一个delivery,负责分发请求结果。

cache dispatcher在独立的线程上运行。cache dispatcher循环等待、取出并执行cache queue中的request。把结果交给delivery。

N个network dispatcher分别在独立的线程上运行。network dispatcher循环等待、取出并执行network queue中的request。把结果交给delivery和添加到cache中。

delivery负责在主线程上将结果传给相应的listener回调。

 

 

 

责任编辑:chenqingxiang 来源: legendmohe博客
相关推荐

2011-10-28 11:22:06

Android 4.0

2011-06-23 09:42:54

Android Mar应用商店Android

2011-07-12 14:04:58

2017-02-21 16:40:16

Android垃圾回收内存泄露

2010-09-08 16:25:39

SIP协议栈

2010-09-10 09:52:44

开源协议栈

2009-06-08 21:25:29

Java声音技术

2010-09-13 16:58:13

2010-05-07 12:39:05

SQL Server负载均衡

2022-06-04 16:11:14

勒索软件加密Nokoyawa

2011-07-22 11:05:15

光纤通信

2010-06-21 14:05:08

Linux APM

2009-08-13 15:48:57

C#指针

2011-07-20 10:20:04

2023-03-17 16:26:25

开源鸿蒙蓝牙能力

2010-04-19 12:28:57

2010-04-12 15:39:37

无线接入技术应用

2013-12-05 10:13:25

iOS图标

2011-12-14 13:14:05

2012-11-21 20:58:07

一体机专家集成系统PureSystems
点赞
收藏

51CTO技术栈公众号