OkHttpUtils - 封裝了okhttp的網絡框架

jopen 8年前發布 | 840K 次閱讀 Android開發 移動開發 OkHttpUtils - Java - GitHub

OkHttpUtils

OkHttpUtils - 封裝了okhttp的網絡框架，目前Get，Post的請求已經完成，支持大文件上傳下載，上傳進度回調，下載進度回調，表單上傳（多文件和多參數一起上傳），鏈式調用，整合Gson，自動解析返回對象，支持Https和自簽名證書，支持cookie自動管理，后期將要實現的功能，統一的上傳管理和下載管理。該項目是根據：https://github.com/hongyangAndroid/okhttp-utils 和 https://github.com/pengjianbo/OkHttpFinal 修改而成，喜歡原作的可以去使用。同時歡迎大家下載體驗本項目，如果使用過程中遇到什么問題，歡迎反饋。

用法

  • Android Studio

使用前，對于Android Studio的用戶，可以選擇添加:

compile project(':okhttputils')
  • Eclipse

自行copy源碼。

注意

使用的okhttp的版本是最新的3.0版本，和以前的2.x的版本可能會存在沖突，整合了Gson，提供了自定Callback，可以按照泛型，自行解析返回結果：

compile 'com.android.support:support-annotations:23.1.1'
    compile 'com.squareup.okhttp3:okhttp:3.0.0-RC1'
    compile 'com.google.code.gson:gson:2.5'

目前支持

  • 一般的get請求
  • 一般的post請求
  • 基于Http Post的文件上傳（類似表單）
  • 多文件和多參數同時上傳
  • 大文件下載和下載進度回調
  • 大文件上傳和上傳進度回調
  • 支持session的保持
  • 支持自簽名網站https的訪問，提供方法設置下證書就行
  • 支持根據Tag取消請求
  • 支持自定義泛型Callback，自動根據泛型返回對象

即將實現

  • 統一的文件上傳管理
  • 統一的文件下載管理
  • 采用線程池或者volley對普通請求進行管理

用法示例

1.普通的GET請求，根據泛型Bean返回值也是Bean

private void getJson() {
        OkHttpUtils.get("http://192.168.1.111:8080/UploadServer/ResponseJson")//
                .tag(this)//
                .params("ppppppp", "ppp")//
                .headers("hhhhhhh", "hhh")//
                .execute(new MyBeanCallBack<Bean>() {
                    @Override
                    public void onResponse(Bean bean) {
                        System.out.println("onResponse:" + bean);
                    }
                });
    }

2.普通的POST請求，根據泛型Bean返回值也是Bean

private void responseJson() {
        OkHttpUtils.post("http://192.168.1.111:8080/UploadServer/ResponseJson")//
                .tag(this)//
                .params("ppppppp", "ppp")//
                .headers("hhhhhhh", "hhh")//
                .execute(new MyBeanCallBack<Bean>() {
                    @Override
                    public void onResponse(Bean bean) {
                        System.out.println("onResponse:" + bean);
                    }
                });
    }

3.普通Post，直接上傳String類型的文本

不建議這么用，該方法上傳字符串會清空實體中其他所有的參數，但頭信息不清除，例如本例中的 params 參數不會上傳

private void postString() {
        OkHttpUtils.post("http://192.168.1.111:8080/UploadServer/UploadString")//
                .tag(this)//
                .params("ppppppp", "ppp")//
                .headers("hhhhhhh", "hhh")//
                .content("asdfasdfad這是文本這是文本aasfesr")//
                .mediaType(PostRequest.MEDIA_TYPE_PLAIN)//
                .execute(new MyBeanCallBack<String>() {
                    @Override
                    public void onResponse(String s) {
                        System.out.println("onResponse:" + s);
                    }
                });
    }

如果要上傳Json，把上面的 mediaType 改為 .mediaType(PostRequest.MEDIA_TYPE_JSON)

4.表單Post，同時上傳多文件和多參數（推薦使用）

private void uploadFile() {
        OkHttpUtils.post("http://192.168.1.111:8080/UploadServer/UploadFile")//
                .tag(this)//
                .headers("aaa", "111")
                .headers("bbb", "222")
                .params("ccc", "333")
                .params("ddd", "444")
                .params("file1", new File(Environment.getExternalStorageDirectory() + "/DCIM/Camera/IMG_20151225_155549.jpg"))//
                .params("file2", new File(Environment.getExternalStorageDirectory() + "/DCIM/Camera/IMG_20160109_010308.jpg"))//
                .params("file3", new File(Environment.getExternalStorageDirectory() + "/video/splash.avi"))//
                .execute(new MyBeanCallBack<String>() {
                    @Override
                    public void onResponse(String s) {
                        System.out.println("onResponse:" + s);
                    }
                });
    }

其中文件的key，相當于表單中<input type="file" name="File1"/>的name屬性。

5.下載文件，get和post都可以，這里使用post演示

OkHttpUtils.post("http://192.168.1.111:8080/UploadServer/DownloadFile")//
                .tag(this)//
                .params("ppppppp", "ppp")//
                .headers("hhhhhhh", "hhh")//
                .execute(new MyFileCallBack(Environment.getExternalStorageDirectory() + "/video", "bbb.avi") {
                    @Override
                    public void onResponse(File response) {
                        System.out.println("onResponse:" + response);
                    }
                });

具體FileCallBack內部實現的下載進度監聽，自行看代碼

6.根據tag取消請求

目前對于支持的方法都添加了最后一個參數Object tag，取消則通過OkHttpUtils.cancel(tag)執行。

例如：在Activity中，當Activity銷毀取消請求，可以在onDestory里面統一取消。

@Override
    protected void onDestroy() {
        super.onDestroy();
        OkHttpUtils.getInstance().cancelTag(this);
    }

7.自定義CallBack

目前內部提供的包含BeanCallBack, StringCallBack, FileCallBack, BitmapCallback，可以根據自己的需求去自定義Callback

其中BeanCallBack使用比較多，它支持傳遞一個泛型，將返回的Response對象解析成需要的類型并且返回，目前支持：

  • 一般的 JavaBean
  • 字符串 String
  • 集合泛型 List<Bean>
  • 集合泛型 Map<Bean>

以下是實現代碼

public abstract class BeanCallBack<T> extends AbsCallback<T> {
        @Override
        public T parseNetworkResponse(Response response) throws Exception {
            Type type = this.getClass().getGenericSuperclass();
            if (type instanceof ParameterizedType) {
                //如果用戶寫了泛型，就會進入這里，否者不會執行
                ParameterizedType parameterizedType = (ParameterizedType) type;
                Type beanType = parameterizedType.getActualTypeArguments()[0];
                if (beanType == String.class) {
                    //如果是String類型，直接返回字符串
                    return (T) response.body().string();
                } else {
                    //如果是 Bean List Map ，則解析完后返回
                    return new Gson().fromJson(response.body().string(), beanType);
                }
            } else {
                //如果沒有寫泛型，直接返回Response對象
                return (T) response;
            }
        }
    }

通過parseNetworkResponse回調的response進行解析，該方法運行在子線程，所以可以進行任何耗時操作

8.上傳下載的進度顯示

public abstract class AbsCallback<T> {
        /** Post執行上傳過程中的進度回調，get請求不回調，UI線程 */
        public void upProgress(long currentSize, long totalSize, float progress) {
        }

        /** 執行下載過程中的進度回調，UI線程 */
        public void downloadProgress(long currentSize, long totalSize, float progress) {
        }
    }

callback回調中有upProgress 和 downloadProgress 方法，直接復寫即可，在 get 請求中， upProgress 方法不會執行。

9.同步的請求

Response response = OkHttpUtils.get("http://www.baidu.com")//
                .tag(this)//
                .headers("aaa", "111")//
                .params("bbb", "222").execute();

execute方法不傳入callback即為同步的請求，返回Response對象，需要自己解析

10.全局配置

可以在Application中，通過：

try {
        OkHttpUtils.debug(true, "MyOkHttp");
        OkHttpUtils.getInstance()//
                .setConnectTimeout(OkHttpUtils.DEFAULT_MILLISECONDS)//
                .setReadTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS)//
                .setCertificates(new Buffer().writeUtf8(CER_12306).inputStream())//
                .setWriteTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS);
    } catch (Exception e) {
        e.printStackTrace();
    }

然后調用 OkHttpUtils 的各種set方法。

11.為單個請求設置超時

比如涉及到文件的需要設置讀寫等待時間多一點。

private void responseJsonArray() {
        OkHttpUtils.post("http://192.168.1.111:8080/UploadServer/ResponseJsonArray")//
                .tag(this)//
                .connTimeOut(2000)
                .writeTimeOut(3000)
                .readTimeOut(4000)
                .params("ppppppp", "ppp")//
                .headers("hhhhhhh", "hhh")//
                .execute(new MyBeanCallBack<List<Bean>>() {
                    @Override
                    public void onResponse(List<Bean> beans) {
                        System.out.println("onResponse:" + beans);
                    }
                });
    }

12.自簽名網站https的訪問

非常簡單，拿到xxx.cert的證書，然后調用

OkHttpUtils.getInstance().setCertificates(inputstream);

建議使用方式，例如我的證書放在assets目錄：

try {
        OkHttpUtils.getInstance()
               .setCertificates(getAssets().open("srca.cer"), getAssets().open("aaa.cer"))//
    } catch (Exception e) {
        e.printStackTrace();
    }

項目地址： https://github.com/jeasonlzy0216/OkHttpUtils

 本文由用戶 jopen 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
 轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！