okhttp的簡單介紹（二）之簡單封裝

• 前一篇文章簡單的介紹了okhttp的簡單使用，okhttp的簡單介紹（一）：http://blog.csdn.net/wuyinlei/article/details/50579564

  相信使用還是很好使用的。

• 但是，怎麼說呢，我們應該不想，每次使用的時候都去重新寫一遍代碼，或者是複制代碼，這樣不僅或降低效率，而且還會是代碼備援。
• 這個時候，采用封裝就可以解決我們的問題了，把相同的代碼，封裝到一起，對外提供一個調用的接口，每次調用的時候，我們隻需要調用接口，傳入資料，就可以了，我們完全不用去理會他内部邏輯是怎麼處理的
• 那好的，既然已經知道了怎麼去做，那麼我們就開始吧。

我們想要實作的結果：

//在這裡我們直接調用暴露出來的接口，傳入需要的參數，就行了，減少了代碼量
 OkHttpManager.getAsync(Contants.ASYNC_URL, new OkHttpManager.DataCallBack() {
            @Override
            public void requestFailure(Request request, IOException e) {

            }

            @Override
            public void requestSuccess(String result) throws Exception {
            //在這裡我們可以直接去指派，因為我們在内部已經做了異步處理，不用擔心在子線程中擷取資料，然後在UI線程中更改UI了。
                tvtext.setText(result);
            }
           

1、Okhttp的單例實作以及配置

/**
     * 靜态執行個體
     */
    private static OkHttpManager sOkHttpManager;

    /**
     * okhttpclient執行個體
     */
    private OkHttpClient mClient;

    /**
     * 單例模式  擷取OkHttpManager執行個體
     *
     * @return
     */
    public static OkHttpManager getInstance() {

        if (sOkHttpManager == null) {
            sOkHttpManager = new OkHttpManager();
        }
        return sOkHttpManager;
    }


    /**
     * 構造方法
     */
    private OkHttpManager() {

        mClient = new OkHttpClient();

        /**
         * 在這裡直接設定連接配接逾時.讀取逾時，寫入逾時
         */
        mClient.newBuilder().connectTimeout(, TimeUnit.SECONDS);
        mClient.newBuilder().readTimeout(, TimeUnit.SECONDS);
        mClient.newBuilder().writeTimeout(, TimeUnit.SECONDS);
}
           

對外提供GET同步請求和内部邏輯處理

/**
     * 對外提供的get方法,同步的方式
     *
     * @param url 傳入的位址
     * @return
     */
    public static Response getSync(String url) {

        //通過擷取到的執行個體來調用内部方法
        return sOkHttpManager.inner_getSync(url);
    }

    /**
     * GET方式請求的内部邏輯處理方式，同步的方式
     *
     * @param url
     * @return
     */
    private Response inner_getSync(String url) {
        Request request = new Request.Builder().url(url).build();
        Response response = null;
        try {
            //同步請求傳回的是response對象
            response = mClient.newCall(request).execute();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return response;
    }
           

3、對外提供的同步擷取資料的方法和内部處理

/**
     * 對外提供的同步擷取String的方法
     *
     * @param url
     * @return
     */
    public static String getSyncString(String url) {
        return sOkHttpManager.inner_getSyncString(url);
    }


    /**
     * 同步方法
     */
    private String inner_getSyncString(String url) {
        String result = null;
        try {
            /**
             * 把取得到的結果轉為字元串，這裡最好用string()
             */
            result = inner_getSync(url).body().string();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return result;
    }
           

4、異步請求做的處理

• 在這裡我們對回調Callback進行了處理，改成我們自定義的接口

/**
     * 資料回調接口
     */
    public interface DataCallBack {
        //請求失敗
        void requestFailure(Request request, IOException e);

        //請求成功
        void requestSuccess(String result) throws Exception;
    }
           

然後自定義了兩個方法

• 一個是請求失敗：

/**
     * 分發失敗的時候調用
     *
     * @param request
     * @param e
     * @param callBack
     */
    private void deliverDataFailure(final Request request, final IOException e, final DataCallBack callBack) {
        /**
         * 在這裡使用異步處理
         */
        mHandler.post(new Runnable() {
            @Override
            public void run() {
                if (callBack != null) {
                    callBack.requestFailure(request, e);
                }
            }
        });
    }
           

一個是請求成功：

/**
     * 分發成功的時候調用
     *
     * @param result
     * @param callBack
     */
    private void deliverDataSuccess(final String result, final DataCallBack callBack) {
        /**
         * 在這裡使用異步線程處理
         */
        mHandler.post(new Runnable() {
            @Override
            public void run() {
                if (callBack != null) {
                    try {
                        callBack.requestSuccess(result);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }
        });
    }
           

5、異步請求邏輯處理

//-------------------------異步的方式請求資料--------------------------
    public static void getAsync(String url, DataCallBack callBack) {
        getInstance().inner_getAsync(url, callBack);
    }

    /**
     * 内部邏輯請求的方法
     *
     * @param url
     * @param callBack
     * @return
     */
    private void inner_getAsync(String url, final DataCallBack callBack) {
        final Request request = new Request.Builder().url(url).build();

        mClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                deliverDataFailure(request, e, callBack);
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                String result = null;
                try {
                    result = response.body().string();
                } catch (IOException e) {
                    deliverDataFailure(request, e, callBack);
                }
                deliverDataSuccess(result, callBack);
            }
        });
    }
           

6、表單送出邏輯處理

//-------------------------送出表單--------------------------

    public static void postAsync(String url, Map<String, String> params, DataCallBack callBack) {
        getInstance().inner_postAsync(url, params, callBack);
    }

    private void inner_postAsync(String url, Map<String, String> params, final DataCallBack callBack) {

        RequestBody requestBody = null;
        if (params == null) {
            params = new HashMap<>();
        }

        /**
         * 如果是3.0之前版本的，建構表單資料是下面的一句
         */
        //FormEncodingBuilder builder = new FormEncodingBuilder();

        /**
         * 3.0之後版本
         */
        FormBody.Builder builder = new FormBody.Builder();

        /**
         * 在這對添加的參數進行周遊，map周遊有四種方式，如果想要了解的可以網上查找
         */
        for (Map.Entry<String, String> map : params.entrySet()) {
            String key = map.getKey().toString();
            String value = null;
            /**
             * 判斷值是否是空的
             */
            if (map.getValue() == null) {
                value = "";
            } else {
                value = map.getValue();
            }
            /**
             * 把key和value添加到formbody中
             */
            builder.add(key, value);
        }
        requestBody = builder.build();
        //結果傳回
        final Request request = new Request.Builder().url(url).post(requestBody).build();
        mClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                deliverDataFailure(request, e, callBack);
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                String result = response.body().string();
                deliverDataSuccess(result, callBack);
            }


        });
    }
           

7、檔案下載下傳邏輯處理

//-------------------------檔案下載下傳--------------------------
    public static void downloadAsync(String url, String desDir, DataCallBack callBack) {
        getInstance().inner_downloadAsync(url, desDir, callBack);
    }

    /**
     * 下載下傳檔案的内部邏輯處理類
     *
     * @param url      下載下傳位址
     * @param desDir   目标位址
     * @param callBack
     */
    private void inner_downloadAsync(final String url, final String desDir, final DataCallBack callBack) {
        final Request request = new Request.Builder().url(url).build();
        mClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                deliverDataFailure(request, e, callBack);
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {

                /**
                 * 在這裡進行檔案的下載下傳處理
                 */
                InputStream inputStream = null;
                FileOutputStream fileOutputStream = null;
                try {
                    //檔案名和目标位址
                    File file = new File(desDir, getFileName(url));
                    //把請求回來的response對象裝換為位元組流
                    inputStream = response.body().byteStream();
                    fileOutputStream = new FileOutputStream(file);
                    int len = ;
                    byte[] bytes = new byte[];
                    //循環讀取資料
                    while ((len = inputStream.read(bytes)) != -) {
                        fileOutputStream.write(bytes, , len);
                    }
                    //關閉檔案輸出流
                    fileOutputStream.flush();
                    //調用分發資料成功的方法
                    deliverDataSuccess(file.getAbsolutePath(), callBack);
                } catch (IOException e) {
                    //如果失敗，調用此方法
                    deliverDataFailure(request, e, callBack);
                    e.printStackTrace();
                } finally {
                    if (inputStream != null) {
                        inputStream.close();
                    }
                    if (fileOutputStream != null) {
                        fileOutputStream.close();
                    }

                }
            }

        });
    }

    /**
     * 根據檔案url擷取檔案的路徑名字
     *
     * @param url
     * @return
     */
    private String getFileName(String url) {
        int separatorIndex = url.lastIndexOf("/");
                String path = (separatorIndex < ) ? url : url.substring(separatorIndex + , url.length());
        return path;
    }
           

實作效果是一樣的，但是代碼結構清晰許多哈：

這樣，就完成了簡單的一個請求工具類的封裝。這裡的異步請求處理，我隻是傳回了字元串，如果想傳回的直接是個對象，這個還得需要處理。在這由于知識尚淺，尚不能完成對象的傳回。我們看到上面的，其實也就是遵循了okhttp的GET，POST請求的邏輯，在次基礎上，我們增加了一些方法，來完成我們想要的功能。下面上傳代碼，有點多，大家擔待點哈：

package com.example.okhttpdemo;

import android.os.Handler;
import android.os.Looper;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.FormBody;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;


/**
 * Created by 若蘭 on 2016/1/23.
 * 一個懂得了程式設計樂趣的小白，希望自己
 * 能夠在這個道路上走的很遠，也希望自己學習到的
 * 知識可以幫助更多的人,分享就是學習的一種樂趣
 * QQ:1069584784
 * csdn:http://blog.csdn.net/wuyinlei
 */

public class OkHttpManager {

    /**
     * 靜态執行個體
     */
    private static OkHttpManager sOkHttpManager;

    /**
     * okhttpclient執行個體
     */
    private OkHttpClient mClient;

    /**
     * 因為我們請求資料一般都是子線程中請求，在這裡我們使用了handler
     */
    private Handler mHandler;

    /**
     * 構造方法
     */
    private OkHttpManager() {

        mClient = new OkHttpClient();

        /**
         * 在這裡直接設定連接配接逾時.讀取逾時，寫入逾時
         */
        mClient.newBuilder().connectTimeout(, TimeUnit.SECONDS);
        mClient.newBuilder().readTimeout(, TimeUnit.SECONDS);
        mClient.newBuilder().writeTimeout(, TimeUnit.SECONDS);

        /**
         * 如果是用的3.0之前的版本  使用以下直接設定連接配接逾時.讀取逾時，寫入逾時
         */

        //client.setConnectTimeout(10, TimeUnit.SECONDS);
        //client.setWriteTimeout(10, TimeUnit.SECONDS);
        //client.setReadTimeout(30, TimeUnit.SECONDS);


        /**
         * 初始化handler
         */
        mHandler = new Handler(Looper.getMainLooper());
    }


    /**
     * 單例模式  擷取OkHttpManager執行個體
     *
     * @return
     */
    public static OkHttpManager getInstance() {

        if (sOkHttpManager == null) {
            sOkHttpManager = new OkHttpManager();
        }
        return sOkHttpManager;
    }

    //-------------------------同步的方式請求資料--------------------------

    /**
     * 對外提供的get方法,同步的方式
     *
     * @param url 傳入的位址
     * @return
     */
    public static Response getSync(String url) {

        //通過擷取到的執行個體來調用内部方法
        return sOkHttpManager.inner_getSync(url);
    }

    /**
     * GET方式請求的内部邏輯處理方式，同步的方式
     *
     * @param url
     * @return
     */
    private Response inner_getSync(String url) {
        Request request = new Request.Builder().url(url).build();
        Response response = null;
        try {
            //同步請求傳回的是response對象
            response = mClient.newCall(request).execute();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return response;
    }

    /**
     * 對外提供的同步擷取String的方法
     *
     * @param url
     * @return
     */
    public static String getSyncString(String url) {
        return sOkHttpManager.inner_getSyncString(url);
    }


    /**
     * 同步方法
     */
    private String inner_getSyncString(String url) {
        String result = null;
        try {
            /**
             * 把取得到的結果轉為字元串，這裡最好用string()
             */
            result = inner_getSync(url).body().string();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return result;
    }

    //-------------------------異步的方式請求資料--------------------------
    public static void getAsync(String url, DataCallBack callBack) {
        getInstance().inner_getAsync(url, callBack);
    }

    /**
     * 内部邏輯請求的方法
     *
     * @param url
     * @param callBack
     * @return
     */
    private void inner_getAsync(String url, final DataCallBack callBack) {
        final Request request = new Request.Builder().url(url).build();

        mClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                deliverDataFailure(request, e, callBack);
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                String result = null;
                try {
                    result = response.body().string();
                } catch (IOException e) {
                    deliverDataFailure(request, e, callBack);
                }
                deliverDataSuccess(result, callBack);
            }
        });
    }


    /**
     * 分發失敗的時候調用
     *
     * @param request
     * @param e
     * @param callBack
     */
    private void deliverDataFailure(final Request request, final IOException e, final DataCallBack callBack) {
        /**
         * 在這裡使用異步處理
         */
        mHandler.post(new Runnable() {
            @Override
            public void run() {
                if (callBack != null) {
                    callBack.requestFailure(request, e);
                }
            }
        });
    }

    /**
     * 分發成功的時候調用
     *
     * @param result
     * @param callBack
     */
    private void deliverDataSuccess(final String result, final DataCallBack callBack) {
        /**
         * 在這裡使用異步線程處理
         */
        mHandler.post(new Runnable() {
            @Override
            public void run() {
                if (callBack != null) {
                    try {
                        callBack.requestSuccess(result);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }
        });
    }

    /**
     * 資料回調接口
     */
    public interface DataCallBack {
        void requestFailure(Request request, IOException e);

        void requestSuccess(String result) throws Exception;
    }

    //-------------------------送出表單--------------------------

    public static void postAsync(String url, Map<String, String> params, DataCallBack callBack) {
        getInstance().inner_postAsync(url, params, callBack);
    }

    private void inner_postAsync(String url, Map<String, String> params, final DataCallBack callBack) {

        RequestBody requestBody = null;
        if (params == null) {
            params = new HashMap<>();
        }

        /**
         * 如果是3.0之前版本的，建構表單資料是下面的一句
         */
        //FormEncodingBuilder builder = new FormEncodingBuilder();

        /**
         * 3.0之後版本
         */
        FormBody.Builder builder = new FormBody.Builder();

        /**
         * 在這對添加的參數進行周遊，map周遊有四種方式，如果想要了解的可以網上查找
         */
        for (Map.Entry<String, String> map : params.entrySet()) {
            String key = map.getKey().toString();
            String value = null;
            /**
             * 判斷值是否是空的
             */
            if (map.getValue() == null) {
                value = "";
            } else {
                value = map.getValue();
            }
            /**
             * 把key和value添加到formbody中
             */
            builder.add(key, value);
        }
        requestBody = builder.build();
        //結果傳回
        final Request request = new Request.Builder().url(url).post(requestBody).build();
        mClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                deliverDataFailure(request, e, callBack);
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                String result = response.body().string();
                deliverDataSuccess(result, callBack);
            }


        });
    }


    //-------------------------檔案下載下傳--------------------------
    public static void downloadAsync(String url, String desDir, DataCallBack callBack) {
        getInstance().inner_downloadAsync(url, desDir, callBack);
    }

    /**
     * 下載下傳檔案的内部邏輯處理類
     *
     * @param url      下載下傳位址
     * @param desDir   目标位址
     * @param callBack
     */
    private void inner_downloadAsync(final String url, final String desDir, final DataCallBack callBack) {
        final Request request = new Request.Builder().url(url).build();
        mClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                deliverDataFailure(request, e, callBack);
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {

                /**
                 * 在這裡進行檔案的下載下傳處理
                 */
                InputStream inputStream = null;
                FileOutputStream fileOutputStream = null;
                try {
                    //檔案名和目标位址
                    File file = new File(desDir, getFileName(url));
                    //把請求回來的response對象裝換為位元組流
                    inputStream = response.body().byteStream();
                    fileOutputStream = new FileOutputStream(file);
                    int len = ;
                    byte[] bytes = new byte[];
                    //循環讀取資料
                    while ((len = inputStream.read(bytes)) != -) {
                        fileOutputStream.write(bytes, , len);
                    }
                    //關閉檔案輸出流
                    fileOutputStream.flush();
                    //調用分發資料成功的方法
                    deliverDataSuccess(file.getAbsolutePath(), callBack);
                } catch (IOException e) {
                    //如果失敗，調用此方法
                    deliverDataFailure(request, e, callBack);
                    e.printStackTrace();
                } finally {
                    if (inputStream != null) {
                        inputStream.close();
                    }
                    if (fileOutputStream != null) {
                        fileOutputStream.close();
                    }

                }
            }

        });
    }

    /**
     * 根據檔案url擷取檔案的路徑名字
     *
     * @param url
     * @return
     */
    private String getFileName(String url) {
        int separatorIndex = url.lastIndexOf("/");
        String path = (separatorIndex < ) ? url : url.substring(separatorIndex + , url.length());
        return path;
    }

}