android volley封裝及源碼解析

来源:http://www.cnblogs.com/ychengyong/archive/2016/10/09/5942613.html
-Advertisement-
Play Games

1.簡單使用volley 2.封裝VolleyManager 完整代碼：https://github.com/snailycy/volley_manager 註意，volley裡面的請求隊列建議使用單例，因為每次實例化ReqeustQueue並start()時，會創建1個緩存線程和4個網路請求線程， ...


1.簡單使用volley

Volley.newRequestQueue(this).add(new StringRequest(Request.Method.GET, "http://api.wumeijie.net/list", new Response.Listener<String>() {
    @Override
    public void onResponse(String response) {
        //TODO 處理響應數據
    }
}, new Response.ErrorListener() {
    @Override
    public void onErrorResponse(VolleyError error) {
        //TODO 處理請求失敗情況
    }
}));

2.封裝VolleyManager

完整代碼：https://github.com/snailycy/volley_manager

註意，volley裡面的請求隊列建議使用單例，因為每次實例化ReqeustQueue並start()時，會創建1個緩存線程和4個網路請求線程，多次調用start()會創建多餘的被interrupt的線程，造成資源浪費

import com.android.volley.AuthFailureError;
import com.android.volley.DefaultRetryPolicy;
import com.android.volley.Request;
import com.android.volley.RequestQueue;
import com.android.volley.Response;
import com.android.volley.toolbox.JsonObjectRequest;
import com.android.volley.toolbox.StringRequest;
import com.android.volley.toolbox.Volley;

import org.json.JSONObject;

import java.util.HashMap;
import java.util.Map;

public class VolleyManager {
    private static RequestQueue requestQueue;
    //超時時間 30s
    private final static int TIME_OUT = 30000;

    private static RequestQueue getRequestQueue() {
        if (requestQueue == null) {
            synchronized (VolleyManager.class) {
                if (requestQueue == null) {
                    //使用全局context對象
                    requestQueue = Volley.newRequestQueue(MyApplication.getContext());
                }
            }
        }
        return requestQueue;
    }

    private static <T> void addRequest(RequestQueue requestQueue, Request<T> request) {
        request.setShouldCache(true);
        request.setRetryPolicy(new DefaultRetryPolicy(TIME_OUT,
                DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
                DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
        requestQueue.add(request);
    }

    public static void sendJsonObjectRequest(int method, String url,
                                             JSONObject params,
                                             final Response.Listener<JSONObject> listener,
                                             final Response.ErrorListener errorListener) {
        try {
            JsonObjectRequest jsonObjectRequest = new JsonObjectRequest(method,
                    url, params, listener, errorListener) {
                @Override
                public Map<String, String> getHeaders() throws AuthFailureError {
                    Map<String, String> headers = new HashMap<>();
                    headers.put("accept-encoding", "utf-8");
                    return headers;
                }
            };
            addRequest(getRequestQueue(), jsonObjectRequest);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void sendStringRequest(int method, String url,
                                         final Map<String, String> params,
                                         final Response.Listener<String> listener,
                                         final Response.ErrorListener errorListener) {
        try {
            StringRequest stringRequest = new StringRequest(method, url, listener, errorListener) {
                @Override
                protected Map<String, String> getParams() throws AuthFailureError {
                    return params;
                }
            };
            addRequest(getRequestQueue(), stringRequest);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

封裝完了，使用起來也非常簡單

//使用StringRequest
HashMap<String, String> params = new HashMap<>();
params.put("params1", "xixi");
VolleyManager.sendStringRequest(Request.Method.GET,
        "http://api.wumeijie.net/list", params,
        new Response.Listener<String>() {
            @Override
            public void onResponse(String response) {
                //TODO 處理響應數據
            }
        }, new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                //TODO 處理請求失敗情況
            }
        });

或者

//使用JsonObjectRequest
JSONObject params = new JSONObject();
try {
    params.put("params1", "xixi");
} catch (JSONException e) {
    e.printStackTrace();
}
VolleyManager.sendJsonObjectRequest(Request.Method.GET,
        "http://api.wumeijie.net/list", params,
        new Response.Listener<JSONObject>() {
            @Override
            public void onResponse(JSONObject response) {
                //TODO 處理響應數據
            }
        }, new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                //TODO 處理請求失敗情況
            }
        });

3.源碼分析

3.1 Volley在創建RequestQueue時，會先創建一個HttpStack對象，該對象在系統版本<=9時，是由實現類HurlStack創建，具體是用HttpURLConnection來實現網路請求，在系統版本>9時，是由實現類HttpClientStack創建，使用的是HttpClient來實現網路請求
源碼如下：（Volley類中newRequestQueue方法）

    public static RequestQueue newRequestQueue(Context context, HttpStack stack) {
        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 {
                // Prior to Gingerbread, HttpUrlConnection was unreliable.
                // See: http://android-developers.blogspot.com/2011/09/androids-http-clients.html
                stack = new HttpClientStack(AndroidHttpClient.newInstance(userAgent));
            }
        }

        Network network = new BasicNetwork(stack);

        RequestQueue queue = new RequestQueue(new DiskBasedCache(cacheDir), network);
        queue.start();

        return queue;
    }

3.2 創建RequestQueue，主要是創建了1個緩存線程和4個網路請求線程，這5個線程共用1個請求隊列，共用1個緩存對象，共用1個ResponseDelivery
源碼如下：（請求隊列RequestQueue類中start方法）

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();
    }
}

3.3 緩存線程run方法中，主要是一個死迴圈，不斷的從緩存隊列中取出請求對象，如果該請求對象緩存丟失或者不需要緩存或者需要刷新緩存數據，則加入到請求隊列中，否則，直接解析緩存後通過ResponseDelivery對象中的handler post到主線程中執行響應回調介面
源碼如下：（緩存線程CacheDispatcher類中run方法）

@Override
public void run() {
    if (DEBUG) VolleyLog.v("start new dispatcher");
    Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);

    // Make a blocking call to initialize the cache.
    mCache.initialize();

    while (true) {
        try {
            // Get a request from the cache triage queue, blocking until
            // at least one is available.
            final Request<?> request = mCacheQueue.take();
            request.addMarker("cache-queue-take");

            // If the request has been canceled, don't bother dispatching it.
            if (request.isCanceled()) {
                request.finish("cache-discard-canceled");
                continue;
            }

            // Attempt to retrieve this item from cache.
            Cache.Entry entry = mCache.get(request.getCacheKey());
            if (entry == null) {
                request.addMarker("cache-miss");
                // Cache miss; send off to the network dispatcher.
                mNetworkQueue.put(request);
                continue;
            }

            // If it is completely expired, just send it to the network.
            if (entry.isExpired()) {
                request.addMarker("cache-hit-expired");
                request.setCacheEntry(entry);
                mNetworkQueue.put(request);
                continue;
            }

            // We have a cache hit; parse its data for delivery back to the request.
            request.addMarker("cache-hit");
            Response<?> response = request.parseNetworkResponse(
                    new NetworkResponse(entry.data, entry.responseHeaders));
            request.addMarker("cache-hit-parsed");

            if (!entry.refreshNeeded()) {
                // Completely unexpired cache hit. Just deliver the response.
                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.
                request.addMarker("cache-hit-refresh-needed");
                request.setCacheEntry(entry);

                // Mark the response as intermediate.
                response.intermediate = true;

                // 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) {
                            // Not much we can do about this.
                        }
                    }
                });
            }

        } catch (InterruptedException e) {
            // We may have been interrupted because it was time to quit.
            if (mQuit) {
                return;
            }
            continue;
        }
    }
}

3.4 網路線程run方法中，主要是一個死迴圈，不斷的從請求隊列中取出請求對象，然後根據系統版本使用HttpStack對象來進行網路請求（包括設置請求參數，請求頭，請求方法等信息），最終返回一個HttpResponse對象，接著就是解析響應數據，處理緩存情況，最後通過ResponseDelivery對象中的handler post到主線程中執行響應回調介面
源碼如下：（網路請求線程NetWorkDispatcher類中run方法）

@Override
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);
        }
    }
}

3.5 當步驟3.4中執行

NetworkResponse networkResponse = mNetwork.performRequest(request);

時，會將請求分發給不同版本的網路請求實現類，這裡以HurlStack為例，請求最終分發到HurlStack中的performRequest方法執行
源碼如下：（HurlStack類中performRequest方法）

@Override
public HttpResponse performRequest(Request<?> request, Map<String, String> additionalHeaders)
        throws IOException, AuthFailureError {
    String url = request.getUrl();
    HashMap<String, String> map = new HashMap<String, String>();
    map.putAll(request.getHeaders());
    map.putAll(additionalHeaders);
    if (mUrlRewriter != null) {
        String rewritten = mUrlRewriter.rewriteUrl(url);
        if (rewritten == null) {
            throw new IOException("URL blocked by rewriter: " + url);
        }
        url = rewritten;
    }
    URL parsedUrl = new URL(url);
    HttpURLConnection connection = openConnection(parsedUrl, request);
    for (String headerName : map.keySet()) {
        connection.addRequestProperty(headerName, map.get(headerName));
    }
    setConnectionParametersForRequest(connection, request);
    // Initialize HttpResponse with data from the HttpURLConnection.
    ProtocolVersion protocolVersion = new ProtocolVersion("HTTP", 1, 1);
    int responseCode = connection.getResponseCode();
    if (responseCode == -1) {
        // -1 is returned by getResponseCode() if the response code could not be retrieved.
        // Signal to the caller that something was wrong with the connection.
        throw new IOException("Could not retrieve response code from HttpUrlConnection.");
    }
    StatusLine responseStatus = new BasicStatusLine(protocolVersion,
            connection.getResponseCode(), connection.getResponseMessage());
    BasicHttpResponse response = new BasicHttpResponse(responseStatus);
    response.setEntity(entityFromConnection(connection));
    for (Entry<String, List<String>> header : connection.getHeaderFields().entrySet()) {
        if (header.getKey() != null) {
            Header h = new BasicHeader(header.getKey(), header.getValue().get(0));
            response.addHeader(h);
        }
    }
    return response;
}

3.6 執行完步驟3.5後，拿到一個響應對象HttpResponse，接著步驟3.4解析響應對象：

Response<?> response = request.parseNetworkResponse(networkResponse);

，執行響應回調：

mDelivery.postResponse(request, response);

這個mDelivery（ExecutorDelivery類型）就是在創建RequestQueue時創建的ResponseDelivery對象，主要負責回調響應介面
註：ExecutorDelivery implements ResponseDelivery
源碼如下：（ExecutorDelivery類中postResponse方法）

@Override
public void postResponse(Request<?> request, Response<?> response, Runnable runnable) {
    request.markDelivered();
    request.addMarker("post-response");
    mResponsePoster.execute(new ResponseDeliveryRunnable(request, response, runnable));
}

ExecutorDelivery屬性mResponsePoster具體實現有兩種方式，這裡使用的是handler實現
源碼如下：（ExecutorDelivery類的構造方法）

public ExecutorDelivery(final Handler handler) {
    // Make an Executor that just wraps the handler.
    mResponsePoster = new Executor() {
        @Override
        public void execute(Runnable command) {
            handler.post(command);
        }
    };
}

註：這個構造方法傳進來的Handler對象拿的是主線程中的Looper對象

volley源碼：https://android.googlesource.com/platform/frameworks/volley


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • cmake ios終端下執行提示錯誤 iOS version not found, tested: [5.0;5.1;6.0;6.1;7.0;8.3]
    在新的mac下check代碼後,執行創建ios工程的sh腳本,在終端提示 ios version not found 提示： 沿著提示發現，前面的是列印錯誤的,後面的才是出錯的問題,iphone.cmake內部錯誤地方如下圖 在執行命令的時候找不到ios sdk version 註意：後面的9.1 ...
  • Android 手機衛士--導航界面1的佈局編寫
    本文地址：http://www.cnblogs.com/wuyudong/p/5943005.html，轉載請註明出處。 本文實現導航界面1的佈局的實現，效果如下圖所示： 首先分析所使用的佈局樣式： 對應的activity_setup1.xml佈局文件內容如下： 最後還剩下右下角的佈局還沒有實現，將 ...
  • Android stdio Apktool源碼編譯
    Android Apktool源碼編譯 標簽（空格分隔）： Android Apktool 源碼編譯 需求 習慣NetBeans調試smali需要用Apktool反編譯apk，需要用 d的參數才能生成.java文件。下載最新的Apktool.jar,運行後提示smalidebugging已經從Apk ...
  • iOS開發常用代碼塊（第二彈）
    GCD定時器 圖片上繪製文字 查找一個視圖的所有子視圖 計算文件大小 UIView的設置部分圓角 計算字元串字元長度，一個漢字算兩個字元 防止滾動視圖手勢覆蓋側滑手勢 去掉導航欄返回的標題 字元串中是否含有中文 dispatch_group的使用 UITextField每四位加一個空格，實現代理 獲 ...
  • iOS10 升級相容必備參考
    最近提交審核不通過，再iOS10上運行崩潰 。然後需要處理崩潰的問題，晚上找了一下，整理收集起來。 方便後續查看使用。 參考： http://blog.csdn.net/gbking/article/details/52587149 http://www.cnblogs.com/xiaoc1314/ ...
  • Android 急速發佈項目到 JitPack
    轉載請標明出處： http://www.cnblogs.com/zhaoyanjun/p/5942616.html 出自[趙彥軍博客] 2016/10/09 前言：以前寫過一篇 Android studio 使用Gradle發佈Android開源項目到JCenter 總結 ，這篇文章主要介紹如何把項 ...
  • 自定義控制項——開關按鈕ToggleButton
    實現一個類似於ToggleButton的開關按鈕 效果圖： 資源圖片： 1.自定義控制項類 2.xml中引用 以上，將Demo運行到模擬器上即可。 圖解： ...
  • Android 手機衛士--設置界面&功能列表界面跳轉邏輯處理
    在《Android 手機衛士--md5加密過程》中已經實現了加密類，這裡接著實現手機防盜功能 本文地址：http://www.cnblogs.com/wuyudong/p/5941959.html，轉載請註明出處。 手機防盜業務邏輯分析 輸入密碼成功後，根據是否設置完成四個導航界面決定跳轉到導航界面 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類