RxEasyHttp網絡庫請求數據（三）

時間 2019-12-10

原文原文鏈接

github源碼地址：https://github.com/zhou-you/RxEasyHttp

請求數據

網絡請求，採用鏈式調用，支持一點到底。java

入口方法

/**
     * get請求
     */
    public static GetRequest get(String url);

    /**
     * post請求和文件上傳
     */
    public static PostRequest post(String url);

    /**
     * delete請求
     */
    public static DeleteRequest delete(String url) ;

    /**
     * 自定義請求
     */
    public static CustomRequest custom();

    /**
     * 文件下載
     */
    public static DownloadRequest downLoad(String url) ;

    /**
     * put請求
     */
    public static PutRequest put(String url);

通用功能配置

1.包含一次普通請求全部能配置的參數，真實使用時不須要配置這麼多，按本身的須要選擇性的使用便可<br/>
2.如下配置所有是單次請求配置，不會影響全局配置，沒有配置的仍然是使用全局參數。<br/>
3.爲單個請求設置超時，好比涉及到文件的須要設置讀寫等待時間多一點。<br/>
完整參數GET示例：android

EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
                .baseUrl("http://www.xxxx.com")//設置url
                .writeTimeOut(30*1000)//局部寫超時30s,單位毫秒
                .readTimeOut(30*1000)//局部讀超時30s,單位毫秒
                .connectTimeout(30*1000)//局部鏈接超時30s,單位毫秒
                .headers(new HttpHeaders("header1","header1Value"))//添加請求頭參數
                .headers("header2","header2Value")//支持添加多個請求頭同時添加
                .headers("header3","header3Value")//支持添加多個請求頭同時添加
                .params("param1","param1Value")//支持添加多個參數同時添加
                .params("param2","param2Value")//支持添加多個參數同時添加
                //.addCookie(new CookieManger(this).addCookies())//支持添加Cookie
                .cacheTime(300)//緩存300s 單位s
                .cacheKey("cachekey")//緩存key
                .cacheMode(CacheMode.CACHEANDREMOTE)//設置請求緩存模式
                //.okCache()//使用模式緩存模式時，走Okhttp緩存
                .cacheDiskConverter(new GsonDiskConverter())//GSON-數據轉換器
                //.certificates()添加證書
                .retryCount(5)//本次請求重試次數
                .retryDelay(500)//本次請求重試延遲時間500ms
                .addInterceptor(Interceptor)//添加攔截器
                .okproxy()//設置代理
                .removeHeader("header2")//移除頭部header2
                .removeAllHeaders()//移除所有請求頭
                .removeParam("param1")
                .accessToken(true)//本次請求是否追加token
                .timeStamp(false)//本次請求是否攜帶時間戳
                .sign(false)//本次請求是否須要簽名
                .syncRequest(true)//是不是同步請求，默認異步請求。true:同步請求
                .execute(new CallBack<SkinTestResult>() {
                    @Override
                    public void onStart() {
                        //開始請求
                    }

                    @Override
                    public void onCompleted() {
                       //請求完成
                    }

                    @Override
                    public void onError(ApiException e) {
                      //請求錯誤
                    }

                    @Override
                    public void onSuccess(SkinTestResult response) {
                      //請求成功
                    }
                });

url

Url能夠經過初始化配置的時候傳入EasyHttp.getInstance().setBaseUrl("http://www.xxx.com");
入口方法傳入： EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult").baseUrl("http://www.xxxx.com")
若是入口方法中傳入的url含有http或者https,則不會拼接初始化設置的baseUrl.
例如：EasyHttp.get("http://www.xxx.com/v1/app/chairdressing/skinAnalyzePower/skinTestResult")則setBaseUrl()和baseUrl()傳入的baseurl都不會被拼接。git

http請求參數

兩種設置方式
.params(HttpParams params)
.params("param1","param1Value")//添加參數鍵值對github

HttpParams params = new HttpParams();
params.put("appId", AppConstant.APPID);
.addCommonParams(params)//設置全局公共參數json

http請求頭

.headers(HttpHeaders headers)
.headers("header2","header2Value")//添加參數鍵值對api

.addCommonHeaders(headers)//設置全局公共頭緩存

普通網絡請求

支持get/post/delete/put等
鏈式調用的終點請求的執行方式有：execute(Class<T> clazz) 、execute(Type type)、execute(CallBack<T> callBack)三種方式，都是針對標準的ApiResult服務器

execute(CallBack<T> callBack)

1.EasyHttp（推薦）
示例：cookie

方式一：
 //EasyHttp.post("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
 EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
                .readTimeOut(30 * 1000)//局部定義讀超時
                .writeTimeOut(30 * 1000)
                .connectTimeout(30 * 1000)
                .params("name","張三")
                .timeStamp(true)
                .execute(new SimpleCallBack<SkinTestResult>() {
                    @Override
                    public void onError(ApiException e) {
                        showToast(e.getMessage());
                    }

                    @Override
                    public void onSuccess(SkinTestResult response) {
                        if (response != null) showToast(response.toString());
                    }
                });

2.手動建立請求對象網絡

//GetRequest 、PostRequest、DeleteRequest、PutRequest
 GetRequest request = new GetRequest("/v1/app/chairdressing/skinAnalyzePower/skinTestResult");
        request.readTimeOut(30 * 1000)//局部定義讀超時
                .params("param1", "param1Value1")
                .execute(new SimpleCallBack<SkinTestResult>() {
                    @Override
                    public void onError(ApiException e) {

                    }

                    @Override
                    public void onSuccess(SkinTestResult response) {

                    }
                });

execute(Class<T> clazz)和execute(Type type)

execute(Class<T> clazz)和execute(Type type)功能基本同樣，execute(Type type)主要是針對集合不能直接傳遞Class

EasyHttp.get(url)
                .params("param1", "paramValue1")
                .execute(SkinTestResult.class)//很是簡單直接傳目標class
                //.execute(new TypeToken<List<SectionItem>>() {}.getType())//Type類型
                .subscribe(new BaseSubscriber<SkinTestResult>() {
                    @Override
                    public void onError(ApiException e) {
                        showToast(e.getMessage());
                    }

                    @Override
                    public void onNext(SkinTestResult skinTestResult) {
                        showToast(skinTestResult.toString());
                    }
                });

請求返回Subscription

網絡請求會返回Subscription對象，方便取消網絡請求

Subscription subscription = EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
                .params("param1", "paramValue1")
                .execute(new SimpleCallBack<SkinTestResult>() {
                    @Override
                    public void onError(ApiException e) {
                        showToast(e.getMessage());
                    }

                    @Override
                    public void onSuccess(SkinTestResult response) {
                        showToast(response.toString());
                    }
                });

        //在須要取消網絡請求的地方調用,通常在onDestroy()中
        //EasyHttp.cancelSubscription(subscription);

帶有進度框的請求

帶有進度框的請求，能夠設置對話框消失是否自動取消網絡和自定義對話框功能，具體參數做用請看請求回調講解

方式一：ProgressDialogCallBack

ProgressDialogCallBack帶有進度框的請求，能夠設置對話框消失是否自動取消網絡和自定義對話框功能，具體參數做用請看自定義CallBack講解

IProgressDialog mProgressDialog = new IProgressDialog() {
            @Override
            public Dialog getDialog() {
                ProgressDialog dialog = new ProgressDialog(MainActivity.this);
                dialog.setMessage("請稍候...");
                return dialog;
            }
        };
        EasyHttp.get("/v1/app/chairdressing/")
                .params("param1", "paramValue1")
                .execute(new ProgressDialogCallBack<SkinTestResult>(mProgressDialog, true, true) {
                    @Override
                    public void onError(ApiException e) {
                        super.onError(e);//super.onError(e)必須寫不能刪掉或者忘記了
                        //請求成功
                    }

                    @Override
                    public void onSuccess(SkinTestResult response) {
                       //請求失敗
                    }
                });

注：錯誤回調 super.onError(e);必須寫

方式二：ProgressSubscriber

IProgressDialog mProgressDialog = new IProgressDialog() {
            @Override
            public Dialog getDialog() {
                ProgressDialog dialog = new ProgressDialog(MainActivity.this);
                dialog.setMessage("請稍候...");
                return dialog;
            }
        };
 EasyHttp.get(URL)
                .timeStamp(true)
                .execute(SkinTestResult.class)
                .subscribe(new ProgressSubscriber<SkinTestResult>(this, mProgressDialog) {
                    @Override
                    public void onError(ApiException e) {
                        super.onError(e);
                        showToast(e.getMessage());
                    }

                    @Override
                    public void onNext(SkinTestResult skinTestResult) {
                        showToast(skinTestResult.toString());
                    }
                });

請求返回Observable

經過網絡請求能夠返回Observable，這樣就能夠很好的經過Rxjava與其它場景業務結合處理，甚至能夠經過Rxjava的connect()操做符處理多個網絡請求。例如：在一個頁面有多個網絡請求，如何在多個請求都訪問成功後再顯示頁面呢？這也是Rxjava強大之處。
注：目前經過execute(Class<T> clazz)方式只支持標註的ApiResult結構，不支持自定義的ApiResult
示例：

Observable<SkinTestResult> observable = EasyHttp.get(url)
                .params("param1", "paramValue1")
                .execute(SkinTestResult.class);

        observable.subscribe(new BaseSubscriber<SkinTestResult>() {
            @Override
            public void onError(ApiException e) {
                showToast(e.getMessage());
            }

            @Override
            public void onNext(SkinTestResult skinTestResult) {
                showToast(skinTestResult.toString());
            }
        });

文件下載

本庫提供的文件下載很是簡單，沒有提供複雜的下載方式例如：下載管理器、斷點續傳、多線程下載等，由於不想把本庫作重。若是複雜的下載方式，還請考慮其它下載方案。
文件目錄若是不指定,默認下載的目錄爲/storage/emulated/0/Android/data/包名/files
文件名若是不指定,則按照如下規則命名:

1.首先檢查用戶是否傳入了文件名,若是傳入,將以用戶傳入的文件名命名
2.若是沒有傳入文件名，默認名字是時間戳生成的。
3.若是傳入了文件名可是沒有後綴，程序會自動解析類型追加後綴名

示例：

String url = "http://61.144.207.146:8081/b8154d3d-4166-4561-ad8d-7188a96eb195/2005/07/6c/076ce42f-3a78-4b5b-9aae-3c2959b7b1ba/kfid/2475751/qqlite_3.5.0.660_android_r108360_GuanWang_537047121_release_10000484.apk";
        EasyHttp.downLoad(url)
                .savePath("/sdcard/test/QQ")
                .saveName("release_10000484.apk")//不設置默認名字是時間戳生成的
                .execute(new DownloadProgressCallBack<String>() {
                    @Override
                    public void update(long bytesRead, long contentLength, boolean done) {
                        int progress = (int) (bytesRead * 100 / contentLength);
                        HttpLog.e(progress + "% ");
                        dialog.setProgress(progress);
                        if (done) {//下載完成
                        }
                        ...
                    }

                    @Override
                    public void onStart() {
                       //開始下載
                    }

                    @Override
                    public void onComplete(String path) {
                       //下載完成，path：下載文件保存的完整路徑
                    }

                    @Override
                    public void onError(ApiException e) {
                        //下載失敗
                    }
                });

POST請求，上傳String、json、object、body、byte[]

通常此種用法用於與服務器約定的數據格式，當使用該方法時，params中的參數設置是無效的，全部參數均須要經過須要上傳的文本中指定，此外，額外指定的header參數仍然保持有效。

.upString("這是要上傳的長文本數據！")//默認類型是：MediaType.parse("text/plain")
若是你對請求頭有本身的要求，可使用這個重載的形式，傳入自定義的content-type文本
upString("這是要上傳的長文本數據！", "application/xml") // 好比上傳xml數據，這裏就能夠本身指定請求頭
upJson該方法與upString沒有本質區別，只是數據格式是json,一般須要本身建立一個實體bean或者一個map，把須要的參數設置進去，而後經過三方的Gson或者 fastjson轉換成json字符串，最後直接使用該方法提交到服務器。
.upJson(jsonObject.toString())//上傳json
.upBytes(new byte[]{})//上傳byte[]
.requestBody(body)//上傳自定義RequestBody
.upObject(object)//上傳對象object

注：upString、upJson、requestBody、upBytes、upObject五個方法不能同時使用，當前只能選用一個

示例：

HashMap<String, String> params = new HashMap<>();
params.put("key1", "value1");
params.put("key2", "這裏是須要提交的json格式數據");
params.put("key3", "也可使用三方工具將對象轉成json字符串");
JSONObject jsonObject = new JSONObject(params);

RequestBody body=RequestBody.create(MediaType.parse("xxx/xx"),"內容");
EasyHttp.post("v1/app/chairdressing/news/favorite")
                //.params("param1", "paramValue1")//不能使用params，upString 與 params 是互斥的，只有 upString 的數據會被上傳
                .upString("這裏是要上傳的文本！")//默認類型是：MediaType.parse("text/plain")
                //.upString("這是要上傳的長文本數據！", "application/xml") // 好比上傳xml數據，這裏就能夠本身指定請求頭
                
                 //.upJson(jsonObject.toString())
                 //.requestBody(body)
                 //.upBytes(new byte[]{})
                 //.upObject(object)
                .execute(new SimpleCallBack<String>() {
                    @Override
                    public void onError(ApiException e) {
                        showToast(e.getMessage());
                    }

                    @Override
                    public void onSuccess(String response) {
                        showToast(response);
                    }
                });

上傳圖片或者文件

支持單文件上傳、多文件上傳、混合上傳，同時支持進度回調，
暫不實現多線程上傳/分片上傳/斷點續傳等高級功能

上傳文件支持文件與參數一塊兒同時上傳，也支持一個key上傳多個文件，如下方式能夠任選
上傳文件支持兩種進度回調：ProgressResponseCallBack(線程中回調)和UIProgressResponseCallBack（能夠刷新UI）

final UIProgressResponseCallBack listener = new UIProgressResponseCallBack() {
            @Override
            public void onUIResponseProgress(long bytesRead, long contentLength, boolean done) {
                int progress = (int) (bytesRead * 100 / contentLength);
                if (done) {//完成
                }
                ...
            }
        };
        EasyHttp.post("/v1/user/uploadAvatar")
                //支持上傳新增的參數
                //.params(String key, File file, ProgressResponseCallBack responseCallBack)
                //.params(String key, InputStream stream, String fileName, ProgressResponseCallBack responseCallBack)
                //.params(String key, byte[] bytes, String fileName, ProgressResponseCallBack responseCallBack) 
                //.addFileParams(String key, List<File> files, ProgressResponseCallBack responseCallBack)
                //.addFileWrapperParams(String key, List<HttpParams.FileWrapper> fileWrappers)
                //.params(String key, File file, String fileName, ProgressResponseCallBack responseCallBack)
                //.params(String key, T file, String fileName, MediaType contentType, ProgressResponseCallBack responseCallBack)
                
                //方式一：文件上傳
                File file = new File("/sdcard/1.jpg");
                //若是有文件名字能夠不用再傳Type,會自動解析到是image/*
                .params("avatar", file, file.getName(), listener)
                //.params("avatar", file, file.getName(),MediaType.parse("image/*"), listener)

                //方式二：InputStream上傳
               final InputStream inputStream = getResources().getAssets().open("1.jpg");
                .params("avatar", inputStream, "test.png", listener)
                
                //方式三：byte[]上傳
                Bitmap bitmap = BitmapFactory.decodeResource(getResources(), R.mipmap.test);
                ByteArrayOutputStream baos = new ByteArrayOutputStream();
                bitmap.compress(Bitmap.CompressFormat.PNG, 100, baos);
                final byte[] bytes = baos.toByteArray();
                //.params("avatar",bytes,"streamfile.png",MediaType.parse("image/*"),listener)
                //若是有文件名字能夠不用再傳Type,會自動解析到是image/*
                .params("avatar", bytes, "streamfile.png", listener)
        
                .params("file1", new File("filepath1"))   // 能夠添加文件上傳
                .params("file2", new File("filepath2"))     // 支持多文件同時添加上傳
                .addFileParams("key", List<File> files)    // 這裏支持一個key傳多個文件
                .params("param1", "paramValue1")         // 這裏能夠上傳參數
                .accessToken(true)
                .timeStamp(true)
                .execute(new ProgressDialogCallBack<String>(mProgressDialog, true, true) {
                    @Override
                    public void onError(ApiException e) {
                        super.onError(e);
                        showToast(e.getMessage());
                    }

                    @Override
                    public void onSuccess(String response) {
                        showToast(response);
                    }
                });

取消請求

經過Subscription取消

每一個請求前都會返回一個Subscription，取消訂閱就能夠取消網絡請求，若是是帶有進度框的網絡請求，則不須要手動取消網絡請求，會自動取消。

Subscription mSubscription = EasyHttp.get(url).execute(callback);
  ...
  @Override
    protected void onDestroy() {
        super.onDestroy();
        EasyHttp.cancelSubscription(mSubscription);
    }

經過dialog取消

自動取消使用ProgressDialogCallBack回調或者使用ProgressSubscriber,就不用再手動調用cancelSubscription();
ProgressDialogCallBack:

EasyHttp.get(url).execute(new ProgressDialogCallBack());

ProgressSubscriber

EasyHttp.get(url).execute(SkinTestResult.class).subscribe(new ProgressSubscriber<SkinTestResult>(this, mProgressDialog) {
            @Override
            public void onError(ApiException e) {
                super.onError(e);
                showToast(e.getMessage());
            }

            @Override
            public void onNext(SkinTestResult skinTestResult) {
                showToast(skinTestResult.toString());
            }
        })

同步請求

同步請求只須要設置syncRequest()方法

EasyHttp.get("/v1/app/chairdressing/skinAnalyzePower/skinTestResult")
                ...
                .syncRequest(true)//設置同步請求
                .execute(new CallBack<SkinTestResult>() {});

請求回調CallBack支持的類型

//支持回調的類型能夠是Bean、String、CacheResult<Bean>、CacheResult<String>、List<Bean>
new SimpleCallBack<CacheResult<Bean>>()//支持緩存的回調，請看緩存講解
new SimpleCallBack<CacheResult<String>>()//支持緩存的回調，請看緩存講解
new SimpleCallBack<Bean>()//返回Bean
new SimpleCallBack<String>()//返回字符串
new SimpleCallBack<List<Bean>()//返回集合

注：其它回調同理

cookie使用

cookie的內容主要包括：名字，值，過時時間，路徑和域。路徑與域一塊兒構成cookie的做用範圍,關於cookie的做用這裏就再也不科普，本身能夠去了解
cookie設置：

EasyHttp.getInstance()
                    ...
                  //若是不想讓本庫管理cookie,如下不須要
                .setCookieStore(new CookieManger(this)) //cookie持久化存儲，若是cookie不過時，則一直有效
                 ...

查看url所對應的cookie

HttpUrl httpUrl = HttpUrl.parse("http://www.xxx.com/test");
CookieManger cookieManger = getCookieJar();
List<Cookie> cookies =  cookieManger.loadForRequest(httpUrl);

查看CookieManger全部cookie

PersistentCookieStore cookieStore= getCookieJar().getCookieStore();
List<Cookie> cookies1= cookieStore.getCookies();

添加cookie

Cookie.Builder builder = new Cookie.Builder();
Cookie cookie = builder.name("mCookieKey1").value("mCookieValue1").domain(httpUrl.host()).build();
CookieManger cookieManger = getCookieJar();
cookieManger.saveFromResponse(httpUrl, cookie);
//cookieStore.saveFromResponse(httpUrl, cookieList);//添加cookie集合

移除cookie

HttpUrl httpUrl = HttpUrl.parse("http://www.xxx.com/test");
CookieManger cookieManger = EasyHttp.getCookieJar();
Cookie cookie = builder.name("mCookieKey1").value("mCookieValue1").domain(httpUrl.host()).build();
cookieManger.remove(httpUrl,cookie);

清空cookie

CookieManger cookieManger = EasyHttp.getCookieJar();
cookieManger.removeAll();

自定義call()請求

提供了用戶自定義ApiService的接口，您只需調用call方法便可.
示例：

public interface LoginService {
    @POST("{path}")
    @FormUrlEncoded
    Observable<ApiResult<AuthModel>> login(@Path("path") String path, @FieldMap Map<String, String> map);
}

final CustomRequest request = EasyHttp.custom()
                .addConverterFactory(GsonConverterFactory.create(new Gson()))//自定義的能夠設置GsonConverterFactory
                .params("param1", "paramValue1")
                .build();

        LoginService mLoginService = request.create(LoginService.class);
        LoginService mLoginService = request.create(LoginService.class);
        Observable<ApiResult<AuthModel>> observable = request.call(mLoginService.login("v1/account/login", request.getParams().urlParamsMap));
        Subscription subscription = observable.subscribe(new Action1<ApiResult<AuthModel>>() {
            @Override
            public void call(ApiResult<AuthModel> result) {
                //請求成功
            }
        }, new Action1<Throwable>() {
            @Override
            public void call(Throwable throwable) {
                //請求失敗
            }
        });

自定義apiCall()請求

提供默認的支持ApiResult結構，數據返回不須要帶ApiResult,直接返回目標.
示例：

Observable<AuthModel> observable = request.apiCall(mLoginService.login("v1/account/login", request.getParams().urlParamsMap));

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。