RxEasyHttp网络库请求数据（三）

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

请求数据

网络请求，采用链式调用，支持一点到底。

入口方法

  /**     * 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.包含一次普通请求所有能配置的参数，真实使用时不需要配置这么多，按自己的需要选择性的使用即可

2.以下配置全部是单次请求配置，不会影响全局配置，没有配置的仍然是使用全局参数。

3.为单个请求设置超时，比如涉及到文件的需要设置读写等待时间多一点。

完整参数GET示例：

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都不会被拼接。

http请求参数

两种设置方式
.params(HttpParams params)
.params(“param1”,”param1Value”)//添加参数键值对

HttpParams params = new HttpParams();
params.put(“appId”, AppConstant.APPID);
.addCommonParams(params)//设置全局公共参数

http请求头

.headers(HttpHeaders headers)
.headers(“header2”,”header2Value”)//添加参数键值对

.addCommonHeaders(headers)//设置全局公共头

普通网络请求

支持get/post/delete/put等
链式调用的终点请求的执行方式有：execute(Class clazz) 、execute(Type type)、execute(CallBack callBack)三种方式，都是针对标准的ApiResult

execute(CallBack callBack)

1.EasyHttp（推荐）
示例：

方式一： //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 clazz)和execute(Type type)

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

### 请求回调CallBack支持的类型

//支持回调的类型可以是Bean、String、CacheResult、CacheResult、List
new SimpleCallBack

*注：其它回调同理*### 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 cookies = cookieManger.loadForRequest(httpUrl);

- 查看CookieManger所有cookie

PersistentCookieStore cookieStore= getCookieJar().getCookieStore();
List 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

### 自定义apiCall()请求提供默认的支持ApiResult结构，数据返回不需要带ApiResult,直接返回目标.示例：

Observable observable = request.apiCall(mLoginService.login(“v1/account/login”, request.getParams().urlParamsMap));
“`