1. 程式人生 > >Okhttp封裝、網絡層擴展

Okhttp封裝、網絡層擴展

rri name 插件 oci 選擇 game ram content oat

一、概述

首先在這裏本片文章是以網絡通信封裝為主,而app開發首先重要就是網絡通信,而如今主流的async、volley、okhttp等,阿麽這麽網絡庫怎樣能做到更好封裝、更好的切換,從而不影響業務層的代碼,而本文就是基於這個思路,從而封裝了okhttp,並能支持封裝切換到async、或者volley,後期會支持這兩個庫的全部特性。並在調用時候無影響。當前版本號2.6。github地址:

https://github.com/apple317/HttpClientUtils

眼下支持

  • 一般的get請求 支持
  • 一般的post請求 支持文本、表單、表單文件、單個文件操作 支持
  • 基於Http Post的文件上傳(類似表單) 支持
  • 文件上傳進度 支持
  • 下載文件進度 支持
  • 支持url關閉網絡請求 支持
  • 支持session的保持 支持
  • 支持取消某個請求 支持
  • 支持數據異步刷新操作
  • 支持取消tag請求、支持url取消請求 支持
  • 支持HEAD 支持
  • 支持自簽名站點https的訪問,提供方法設置下證書即可 不支持
  • DELETE、PATCH、PUT 支持
  • 增加網絡配置、請求過程抽離 支持
  • 增加gson解析。建議增加插件gsonformat來生成解析對象,傳入解析類方法setParse
  • 增加url表識來區分請求 支持

二、引用註意

  • Android Studio

    使用前,對於Android Studio的用戶,能夠選擇加入:

    compile project(‘:HttpClientUtils‘)

三、使用說明

初始化配置

 HttpConfiguration.Builder configuration=new HttpConfiguration.Builder(getApplicationContext());
        configuration.connectTimeout(2000);
        configuration.retryOnConnectionFailure(true);
        configuration.readTimeout(2000);
        configuration.writeTimeout(2000);
        configuration.diskCacheSize(1000 * 1024);
        configuration.diskCacheDir(getCacheDir());
        BaseHttpClient.getBaseClient().init(configuration.build());
裏面設置超時、讀寫時間、緩沖路徑等

Get傳入方法

 /**
     * 普通參數請求方式
     * url 傳入網絡地址
     * put傳入值
     * tag設置tag
     */
    public void getParam(View view) {
        BaseHttpClient.getBaseClient().newBuilder()
                .url("http://api.dianping.com/v1/metadata/get_cities_with_deals")
                .put("appkey", "56065429")
                .setParse(UserBean.class)
                .put("sign", "AF24BF8A3F31D22D25422BCDD86AA322F43B5BAB")
                .setTag("deals").build().execute(new HttpCallback() {
            @Override
            public void onSuccess(String content, BaseHttpClient object, Object parse) {
                //刷新ui操作
            }

            @Override
            public void onError(Throwable error, BaseHttpClient client) {

            }
        });
    }

post文本上傳

在demo中PostActivity中的postStringData方法:

 /**
     * post上傳字符串
     * addUrl傳入url地址
     * put傳入參數能夠
     * apple_txt 這個是專門用來傳入文本上傳的,請註意
     */
    public void postStringData(View view) {
        /**
         * 第一種寫法
         */
        BaseHttpClient.getBaseClient().newBuilder().url("url")
                .content("你好好好").method(METHOD.POST_STRING)
                .build().execute(new HttpCallback() {
            @Override
            public void onSuccess(String content, BaseHttpClient object, Object parse) {
                //刷新ui
            }

            @Override
            public void onError(Throwable error, BaseHttpClient client) {

            }
        });
    }

post普通表單提交

在demo中PostActivity中的postData方法:
/**
     * 普通post請求數據
     * 默認以表單提交
     * addUrl傳入url地址
     * put傳入參數能夠
     *setTag 設置tag
     */
    public void postData(View view) {
        /**
         * 第一種寫法
         */
        BaseHttpClient.getBaseClient().newBuilder()
                .url("url")
                .put("device_id", "1236716")
                .setTag("postactivity").put("os", "2")
                .put("version", "2.1.0").
                put("mobile", "13621937708").method(METHOD.POST_FORM)
                .build().execute(new HttpCallback() {
            @Override
            public void onSuccess(String content, BaseHttpClient object, Object parse) {
                //刷新UI
            }
            @Override
            public void onError(Throwable error, BaseHttpClient client) {

            }
        });
    }





Post表單文件上傳

在demo中PostActivity中的postFormFile方法:

/**
     * post
     * 表單文件上傳
     * 默認以表單提交
     * addUrl傳入url地址
     * put傳入參數能夠
     *setTag 設置tag
     * put 傳入logo為文件上傳定義接口名稱 value:為文件對象
     * setBaseParams 通過這種傳入參數對象
     * 上傳文件onProgress 會返回當前網絡上傳的進度
     * POST_FORM 是普通表單提交
     */
    public void postFormFile(View view) {
        try {
            File file=new File("path");
            ArrayList<File> arrayList=new ArrayList<File>();
            arrayList.add(file);
//            File file = new File(Environment.getExternalStorageDirectory()
//                    , "4cc75752fa532553bf7b6f7e00f26db8.png");
            BaseHttpClient.getBaseClient().newBuilder()
                    .url("url")
                    .put("game", "lol")
                    .put("logo", arrayList)
                    .put("token","ee595bd5078a6e67a110c6bd8828c8e2a2388c12")
                    .put("version", "2.1.0")
                    .put("device_id","867905026687709")
                    .put("os","2")
                    .method(METHOD.POST_FORM_FILE).build()
                    .execute(new HttpCallback() {
                        @Override
                        public void onSuccess(String content, BaseHttpClient object, Object parse) {
                               //刷新ui
                        }

                        @Override
                        public void onError(Throwable error, BaseHttpClient client) {

                        }
                    });
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

文件上傳進度

在demo中PostActivity中postFormFileProgress方法:
 /**
     * post
     * 表單文件上傳
     * 默認以表單提交
     * addUrl傳入url地址
     * put傳入參數能夠
     *setTag 設置tag
     * put 傳入logo為文件上傳定義接口名稱 value:為文件對象 也能夠為文件數組對象
     * setBaseParams 通過這種傳入參數對象
     * 類型一定要傳入POST_FORM_PROGRESS
     * 上傳文件onProgress 會返回當前網絡上傳的進度
     */
    public void postFormFileProgress(View view) {
        try {
            File file = new File(Environment.getExternalStorageDirectory()
                    , "4cc75752fa532553bf7b6f7e00f26db8.png");
            BaseHttpClient.getBaseClient().newBuilder().url("url")
                    .put("game", "lol")
                    .put("logo", file)
                    .put("token","ee595bd5078a6e67a110c6bd8828c8e2a2388c12")
                    .put("version", "2.1.0")
                    .put("device_id","867905026687709")
                    .put("os","2")
                    .method(METHOD.POST_FORM_PROGRESS).build()
                    .execute(new UploadCallback() {
                        @Override
                        public void onSuccess(String content, BaseHttpClient object, Object parse) {

                        }

                        @Override
                        public void onError(Throwable error, BaseHttpClient client) {

                        }

                        @Override
                        public void uploadProgress(long bytesRead, long contentLength, boolean done) {
                            mProgressBar.setProgress((int) (100 * (float)bytesRead * 1.0f / contentLength));
                        }
                    });
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
文件下載進度

在demo中DownFileActivity中的downData方法:
/**
     * addUrl 加入url地址
     * put傳入參數能夠
     *setTag 設置tag
     * downName 下載文件命名
     * downDir 下載文件文件夾 假設不傳會默認生成一個getCacheDirectory
     * DownEntity 下載返回數據實體:
     * public String name;//名稱
     public String path;//保存地址
     public String url;
     public int httpCode;//http網絡狀態
     //下載是否完畢
     public boolean statue;//下載是否完畢
     public long currentByte;//下載當前字節數
     public long totalByte;//下載總字節數
     public boolean isExecuted;//下載是否運行
     public String dir;//下載文件夾

     public boolean isCanceled;//下載是否取消
     public String message;//下載返回消息
     * @param view
     */
    public void downData(View view){
        /**
         * 第一種寫法
         */
        BaseHttpClient.getBaseClient().newBuilder().url("http://112.65.235.160/vlive.qqvideo.tc.qq.com/m0019469p4a.mp4?

vkey=4C7F305D62ABA38AF8BF474C40A0DF9700C8F07BF29BE26D76F17F8A7E73B9FEB1424CC479C4C863BFBDD095AA5EBE49A0CDE3EAEB32E2AD0C009E7C5B37521C0912AF6905C70C601471E664777B9C38C726B03E8D193D62&br=34&platform=2&fmt=msd&sdtfrom=v3010&type=mp4&locid=89489e75-bb18-40e4-989b-89d6b34adf32&size=56306437&ocid=1362567084") .downName("apple_nba").method(METHOD.DOWNLOAD_FILE).build().execute(new DownCallback() { @Override public void downProgress(DownEntity entity) { Log.i("HU", "======bytes===" + entity.currentByte + "==contenLength==" + entity.totalByte); id_progress.setProgress((int) (100 * (float) entity.currentByte * 1.0f / entity.totalByte)); txt_content.setText("當前下載的文件文件夾是"+entity.path+"文件名:"+entity.name+"網絡返回code"+entity.httpCode+"===服務端返回消息=="+entity.message); } }); }



技術分享

取消單個網絡請求

1.第一種方式通過url要關閉

BaseHttpClient.getBaseClient().cancelTag("url");

2.另外一種方式通過傳入tag來關閉

BaseHttpClient.getBaseClient()
        .setTag("deals")

mParams.setTag("tag");

取消tag網絡請求

比方,在請求中傳入tag對象,銷魂時候能夠統一銷毀同一tag對象訪問
@Override
protected void onDestroy()
{
    super.onDestroy();
     //能夠取消同一個tag的
     BaseHttpClient.getBaseClient(getApplicationContext()).cancelTag("tag對象");
}

HEAD請求傳入

 ConcurrentHashMap<String, String> headMap=new ConcurrentHashMap<String, String>();
        headMap.put("device","1231231241");
        BaseHttpClient.getBaseClient().newBuilder()
                .url("http://api.dianping.com/v1/metadata/get_cities_with_deals")
                .put("appkey", "56065429")
                .setParse(UserBean.class)
                .setHeadMap(headMap)
                .put("sign", "AF24BF8A3F31D22D25422BCDD86AA322F43B5BAB")
                .setTag("deals").build().execute(new HttpCallback() {
            @Override
            public void onSuccess(String content, BaseHttpClient object, Object parse) {
                UserBean userBean=(UserBean)parse;
                txt_content.setText(userBean.getCities().get(0) + "type===" );
            }

            @Override
            public void onError(Throwable error, BaseHttpClient client) {

            }
        });

Okhttp封裝、網絡層擴展