Volley源码解析

Vollley简介

先来看Volley是怎么使用的

public class VolleyActivity extends Activity {
    private static final String TAG = "VolleyActivity";
    TextView hello;
    RequestQueue mQueue;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_volley);
        mQueue = Volley.newRequestQueue(VolleyActivity.this);
        hello = (TextView) findViewById(R.id.hello);
        StringRequest stringRequest = new StringRequest("http://www.weather.com.cn/data/sk/101010100.html",
                new Response.Listener<String>() {
                    @Override
                    public void onResponse(String response) {
                        Log.d(TAG, response);
                        hello.setText(response);
                    }
                }, new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                Log.e(TAG, error.getMessage(), error);
            }
        });
        mQueue.add(stringRequest);
    }
}

在第行new了一个RequestQueue，点击newRequestQueue，追踪到以下代码

    public static RequestQueue newRequestQueue(Context context, HttpStack stack, int maxDiskCacheBytes) {
        File cacheDir = new File(context.getCacheDir(), DEFAULT_CACHE_DIR);

        String userAgent = "volley/0";
        try {
            String packageName = context.getPackageName();
            PackageInfo info = context.getPackageManager().getPackageInfo(packageName, 0);
            userAgent = packageName + "/" + info.versionCode;
        } catch (NameNotFoundException e) {
        }

        if (stack == null) {
            if (Build.VERSION.SDK_INT >= 9) {
                stack = new HurlStack();
            } else {
               ...
            }
        }

        Network network = new BasicNetwork(stack);

        RequestQueue queue;
        if (maxDiskCacheBytes <= -1)
        {
            // No maximum size specified
            queue = new RequestQueue(new DiskBasedCache(cacheDir), network);
        }
        else
        ...

        queue.start();

        return queue;
    }

可以看到生成了一个RequestQueue，构造方法里有两个参数，暂时先别管。并且开始了start方法

点击进入RequestQueue的构造方法，追踪到

    public RequestQueue(Cache cache, Network network, int threadPoolSize,
            ResponseDelivery delivery) {
        mCache = cache;
        mNetwork = network;
        mDispatchers = new NetworkDispatcher[threadPoolSize];
        mDelivery = delivery;
    }

threadPoolSize默认是4。点击进入NetworkDispatcher，发现它是Thread的子类。进入RequestQueue的start方法

     /**
     * Starts the dispatchers in this queue.
     */
    public void start() {
        stop();  // Make sure any currently running dispatchers are stopped.
        // Create the cache dispatcher and start it.
        mCacheDispatcher = new CacheDispatcher(mCacheQueue, mNetworkQueue, mCache, mDelivery);
        mCacheDispatcher.start();

        // Create network dispatchers (and corresponding threads) up to the pool size.
        for (int i = 0; i < mDispatchers.length; i++) {
            NetworkDispatcher networkDispatcher = new NetworkDispatcher(mNetworkQueue, mNetwork,
                    mCache, mDelivery);
            mDispatchers[i] = networkDispatcher;
            networkDispatcher.start();
        }
    }

CacheDispatcher和NetworkDispatcher一样，也是Thread的子类。下面我们看一下NetworkDispatcher的run方法看看做了什么

public void run() {
        Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
        while (true) {
            long startTimeMs = SystemClock.elapsedRealtime();
            Request<?> request;
            try {
                // Take a request from the queue.
                request = mQueue.take();
            } catch (InterruptedException e) {
                // We may have been interrupted because it was time to quit.
                if (mQuit) {
                    return;
                }
                continue;
            }

            try {
                request.addMarker("network-queue-take");

                // If the request was cancelled already, do not perform the
                // network request.
                if (request.isCanceled()) {
                    request.finish("network-discard-cancelled");
                    continue;
                }

                addTrafficStatsTag(request);

                // Perform the network 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");
                    continue;
                }

                // Parse the response here on the worker thread.
                Response<?> response = request.parseNetworkResponse(networkResponse);
                request.addMarker("network-parse-complete");

                // Write to cache if applicable.
                // 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);
            } catch (VolleyError volleyError) {
                volleyError.setNetworkTimeMs(SystemClock.elapsedRealtime() - startTimeMs);
                parseAndDeliverNetworkError(request, volleyError);
            } catch (Exception e) {
                VolleyLog.e(e, "Unhandled exception %s", e.toString());
                VolleyError volleyError = new VolleyError(e);
                volleyError.setNetworkTimeMs(SystemClock.elapsedRealtime() - startTimeMs);
                mDelivery.postError(request, volleyError);
            }
        }
    }

可以看到有个while循环，首先从mQueue取出一个request，失败的话会检测mQuit，为真就退出。

request.addMarker("network-queue-take");

这里看起来是给request加了个tag，进入addMarker方法
看到

if (MarkerLog.ENABLED) {
            mEventLog.add(tag, Thread.currentThread().getId());
        }

  /** An event log tracing the lifetime of this request; for debugging. */
    private final MarkerLog mEventLog = MarkerLog.ENABLED ? new MarkerLog() : null;

从mEventLog的注释就可以看出是为了方便调试，给每一个request new一个追踪事件周期的event log

进入MarkerLog类里

        private final List<Marker> mMarkers = new ArrayList<Marker>();

        /** Adds a marker to this log with the specified name. */
        public synchronized void add(String name, long threadId) {
        ...

            mMarkers.add(new Marker(name, threadId, SystemClock.elapsedRealtime()));
        }

可以发现在mMarkers里追加了一条Marker，我们再返回到NetworkDispatcher的run方法

               if (request.isCanceled()) {
                    request.finish("network-discard-cancelled");
                    continue;
                }

检测该request是不是已被取消，继续往下

addTrafficStatsTag(request);

点击进入addTrafficStatsTag，发现是检测当前apk是不是大于14，如果是的话会给该线程附加一个tag，这个tag是该request的url的host的hash值，至于附加的作用，注释写的是

Set active tag to use when accounting traffic originating from the current thread. Only one active tag per thread is supported.

大致意思貌似是统计该线程的流量，继续返回到NetworkDispatcher的run方法

                // Perform the network request.
                NetworkResponse networkResponse = mNetwork.performRequest(request);
                request.addMarker("network-http-complete");

这个就不用解释了

if (networkResponse.notModified && request.hasHadResponseDelivered()) {
                    request.finish("not-modified");
                    continue;
                }

当服务器返回304并且之前已经处理过该request时，会continue

// Parse the response here on the worker thread.
                Response<?> response = request.parseNetworkResponse(networkResponse);

这里是进行解析，为了了解为何需要解析，我们先进入StringRequest的parseNetworkResponse方法里，看看做了什么

    @Override
    protected Response<String> parseNetworkResponse(NetworkResponse response) {
        String parsed;
        try {
            parsed = new String(response.data, HttpHeaderParser.parseCharset(response.headers));
        } 
        ...
        return Response.success(parsed, HttpHeaderParser.parseCacheHeaders(response));
    }

parsed是经过对应返回头编码解析后的String，parseCacheHeaders方法是生成该response的Cache.Entry，里面代码比较长，不过比较简单，里面存了response的诸多信息：

        Cache.Entry entry = new Cache.Entry();
        entry.data = response.data;
        entry.etag = serverEtag;
        entry.softTtl = softExpire;
        entry.ttl = finalExpire;
        entry.serverDate = serverDate;
        entry.lastModified = lastModified;
        entry.responseHeaders = headers;

再返回到NetworkDispatcher的run方法

                // Write to cache if applicable.
                // 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的mResponseDelivered标为true，最终把结果回调。其中我们注意一下

mCache.put(request.getCacheKey(), response.cacheEntry);

这个mCache是NetworkDispatcher的构造方法传参传进来的，他的真实定义其实是在Volley.java里面的

File cacheDir = new File(context.getCacheDir(), DEFAULT_CACHE_DIR);
...
new DiskBasedCache(cacheDir)

进入DiskBasedCache，发现cacheDir是一个根目录，最大缓存为5M