RxVolley使用文档—— RxVolley = Volley + RxJava + OkHttp

同时支持RxJava；

可以选择使用OKHttp替代默认的 HttpUrlConnection 做网络请求；

可以选择使用图片加载功能(复用的网络请求将有效减少apk体积)；

移除了原Volley的 HttpClient 相关 API ，可在 API23 环境编译；

内置了RxBus的实现，可有效替换掉EventBus等相关库；

即将支持 RxJava2.0

依赖

–

使用RxVolley，需要在你的build.gradle文件中加入

compile ‘com.kymjs.rxvolley:rxvolley:1.1.4’

如果你还想使用OKhttp来替代默认的HttpUrlconnection，需要加入

compile ‘com.kymjs.rxvolley:okhttp:1.1.4’

//或者okhttp3（二选一）

compile ‘com.kymjs.rxvolley:okhttp3:1.1.4’

如果你想使用RxVolley的图片加载功能(复用http模块可以有效减少apk大小)，需要加入

compile ‘com.kymjs.rxvolley:bitmapcore:1.1.4’

使用 RxVolley 做网络请求

简洁实现

---

//get请求简洁版实现

RxVolley.get(“http://www.kymjs.com/feed.xml”, new HttpCallback() {

@Override

public void onSuccess(String t) {

Loger.debug(“请求到的数据:” + t);

}

});

//post请求简洁版实现

HttpParams params = new HttpParams();

params.put(“name”, “kymjs”);

params.put(“age”, 18);

params.put(“image”, new File(“path”))//文件上传

RxVolley.post(“http://kymjs.com/feed.xml”, params, new HttpCallback() {

@Override

public void onSuccess(String t) {

Loger.debug(“请求到的数据:” + t);

}

});

对Cookie等请求头的处理

---

//用户登录逻辑(HttpCallback中有很多重载方法，可以选择需要的实现)

HttpParams params = new HttpParams();

params.put(“name”, “kymjs”);

params.put(“age”, 18);

params.put(“password”, “helloword”);

RxVolley.post(“http://kymjs.com/login”, params, new HttpCallback() {

@Override

public void onSuccess(Map<String, String> headers, byte[] t) {

Loger.debug(“请求到的数据:” + new String(t));

// 获取到的cookie

Loger.debug(“===” + headers.get(“Set-Cookie”));

}

});

//向服务器传递cookie信息

HttpParams params = new HttpParams();

params.put(“name”, “kymjs”);

params.put(“age”, 100);

params.putHeaders(“cookie”, “your cookie”);

RxVolley.post(“http://kymjs.com/update”, params, new HttpCallback() {

@Override

public void onSuccess(String t) {

Loger.debug(“请求到的数据:” + t);

}

});

比起 入门 章节讲述的网络请求，你可能希望有更多的需求

构建网络请求

---

HttpParams params = new HttpParams();

//同之前的设计，传递 http 请求头可以使用 putHeaders()

params.putHeaders(“cookie”, “your cookie”);

params.putHeaders(“User-Agent”, “rxvolley”);

//传递 http 请求参数可以使用 put()

params.put(“name”, “kymjs”);

params.put(“age”, “18”);

//http请求的回调，内置了很多方法，详细请查看源码

//包括在异步响应的onSuccessInAsync():注不能做UI操作

//网络请求成功时的回调onSuccess()

//网络请求失败时的回调onFailure():例如无网络，服务器异常等

HttpCallback callback = new HttpCallback(){

@Override

public void onSuccessInAsync(byte[] t) {

}

@Override

public void onSuccess(String t) {

}

@Override

public void onFailure(int errorNo, String strMsg) {

}

}

ProgressListener listener = new ProgressListener(){

/**

• @param transferredBytes 进度

• @param totalSize 总量

*/

@Override

public void onProgress(long transferredBytes, long totalSize​
){

}

}

new RxVolley.Builder()

.url(“http://www.kymjs.com/rss.xml”) //接口地址

//请求类型，如果不加，默认为 GET 可选项：

//POST/PUT/DELETE/HEAD/OPTIONS/TRACE/PATCH

.httpMethod(RxVolley.Method.GET)

//设置缓存时间: 默认是 get 请求 5 分钟, post 请求不缓存

.cacheTime(6)

//内容参数传递形式，如果不加，默认为 FORM 表单提交，可选项 JSON 内容

.contentType(RxVolley.ContentType.FORM)

.params(params) //上文创建的HttpParams请求参数集

//是否缓存，默认是 get 请求 5 缓存分钟, post 请求不缓存

.shouldCache(true)

.progressListener(listener) //上传进度

.callback(callback) //响应回调

.encoding(“UTF-8”) //编码格式，默认为utf-8

.doTask(); //执行请求操作

对 RxJava 的支持

---

RxVolley 支持返回一个 Observable<Result> 类型的数据，如下是 Result 类的原型

public class Result {

public String url;

public byte[] data;

public VolleyError error;

public Map<String, String> headers;

public int errorCode;

}

执行一次请求，并返回 Observable

---

Observable observable = new RxVolley.Builder()

.url(“http://www.kymjs.com/rss.xml”)

//default GET or POST/PUT/DELETE/HEAD/OPTIONS/TRACE/PATCH

.httpMethod(RxVolley.Method.POST)

.cacheTime(6) //default: get 5min, post 0min

.params(params)

.contentType(RxVolley.ContentType.JSON)

.getResult(); // 使用getResult()来返回RxJava数据类型

//当拿到 observable 对象后，你可以设置你自己的 subscriber

observable.subscribe(subscriber);

完整的使用示例

---

public class MainActivity extends AppCompatActivity {

private Subscription subscription;

@Override

protected void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentView(R.layout.activity_main);

Observable observable = new RxVolley.Builder()

.url(“http://kymjs.com/feed.xml”)

.contentType(RxVolley.ContentType.FORM)

.getResult();

subscription = observable

.map(new Func1<Result, String>() {

@Override

public String call(Result result) {

return new String(result.data);

}

})

.subscribeOn(Schedulers.io())

.observeOn(AndroidSchedulers.mainThread())

.subscribe(new Subscriber() {

@Override

public void onCompleted() {

Log.i(“kymjs”, “======网络请求结束”);

}

@Override

public void onError(Throwable e) {

Log.i(“kymjs”, “======网络请求失败” + e.getMessage());

}

@Override

public void onNext(String s) {

Log.i(“kymjs”, “======网络请求” + s);

}

});

}

@Override

protected void onDestroy() {

super.onDestroy();

if (subscription != null && subscription.isUnsubscribed()) {

subscription.unsubscribe();

}

}

}

自定义请求

---

也许你是 Volley 的重度使用者(就像我)，那么你一定是因为 Volley 自由的扩展性而爱上它的。

你可以通过创建一个Request<?>的子类，自由配置请求策略，缓存策略，数据传输加密，重试策略等。

最后通过

RxVolley.Builder().setRequest(yourRequest).doTask();

去执行你的自定义 Request

一个典型自定义Request的示例：

/**

• Form表单形式的Http请求

*/

public class FormRequest extends Request<byte[]> {

private final HttpParams mParams;

public FormRequest(RequestConfig config, HttpParams params, HttpCallback callback) {

super(config, callback);

if (params == null) {

params = new HttpParams();

}

this.mParams = params;

}

@Override

public String getCacheKey() {

if (getMethod() == RxVolley.Method.POST) {

return getUrl() + mParams.getUrlParams();

} else {

return getUrl();

}

}

@Override

public String getBodyContentType() {

if (mParams.getContentType() != null) {

return mParams.getContentType();

} else {

return super.getBodyContentType();

}

}

@Override

public ArrayList getHeaders() {

return mParams.getHeaders();

}

@Override

public byte[] getBody() {

ByteArrayOutputStream bos = new ByteArrayOutputStream();

try {

mParams.writeTo(bos);

} catch (IOException e) {

Loger.debug(“FormRequest#getBody()—>IOException writing to ByteArrayOutputStream”);

}

return bos.toByteArray();

}

@Override

public Response<byte[]> parseNetworkResponse(NetworkResponse response) {

return Response.success(response.data, response.headers,

HttpHeaderParser.parseCacheHeaders(getUseServerControl(), getCacheTime(),

response));

}

@Override

protected void deliverResponse(ArrayList headers, final byte[] response) {

if (mCallback != null) {

HashMap<String, String> map = new HashMap<>(headers.size());

for (HttpParamsEntry entry : headers) {

map.put(entry.k, entry.v);

}

mCallback.onSuccess(map, response);

}

}

@Override

public Priority getPriority() {

return Priority.IMMEDIATE;

}

}

文件(图片)下载

---

利用 RxVolley 的自定义请求，在库中内置了文件下载功能。你可以使用

//下载进度(可选参数，不需要可不传)

listener = new ProgressListener() {

@Override

public void onProgress(long transferredBytes, long totalSize) {

Loger.debug(transferredBytes + “======” + totalSize);

}

}

//下载回调，内置了很多方法，详细请查看源码

//包括在异步响应的onSuccessInAsync():注不能做UI操作

//下载成功时的回调onSuccess()

//下载失败时的回调onFailure():例如无网络，服务器异常等

最后

小编这些年深知大多数初中级Android工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人

都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

资料⬅专栏获取

文件(图片)下载

---

利用 RxVolley 的自定义请求，在库中内置了文件下载功能。你可以使用

//下载进度(可选参数，不需要可不传)

listener = new ProgressListener() {

@Override

public void onProgress(long transferredBytes, long totalSize) {

Loger.debug(transferredBytes + “======” + totalSize);

}

}

//下载回调，内置了很多方法，详细请查看源码

//包括在异步响应的onSuccessInAsync():注不能做UI操作

//下载成功时的回调onSuccess()

//下载失败时的回调onFailure():例如无网络，服务器异常等

最后

小编这些年深知大多数初中级Android工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

[外链图片转存中…(img-qXyisNLW-1719092741082)]一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人

都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

资料⬅专栏获取