RxVolley 项目地址：github.com/kymjs/RxVol…[1]
RxVolley是一个基于Volley的网络请求库；
同时支持RxJava；
可以选择使用OKHttp替代默认的 HttpUrlConnection 做网络请求；
可以选择使用图片加载功能(复用的网络请求将有效减少apk体积)；
移除了原Volley的 HttpClient 相关 API ，可在 API23 环境编译；
内置了RxBus的实现，可有效替换掉EventBus等相关库；
使用RxVolley，需要在你的build.gradle文件中加入
compile 'com.kymjs.rxvolley:rxvolley:1.0.1'
如果你还想使用OKhttp来替代默认的HttpUrlconnection，需要加入
compile 'com.kymjs.rxvolley:okhttp:1.0.1'
如果你想使用RxVolley的图片加载功能(复用http模块可以有效减少apk大小)，需要加入
compile 'com.kymjs.rxvolley:bitmapcore:1.0.2'
使用 RxVolley 做网络请求
//get请求简洁版实现
RxVolley.("http://www.kymjs.com/feed.xml", HttpCallback() {
@Override
public onSuccess(String t) {
Loger.debug("请求到的数据:" + t);
}
});
//post请求简洁版实现
HttpParams params = HttpParams();
params.put("name", "kymjs");
params.put("age", );
params.put("image", File("path"))//文件上传
RxVolley.post("http://kymjs.com/feed.xml", params, HttpCallback() {
@Override
public onSuccess(String t) {
Loger.debug("请求到的数据:" + t);
}
});
对Cookie等请求头的处理
//用户登录逻辑(HttpCallback中有很多重载方法，可以选择需要的实现)
HttpParams params = HttpParams();
params.put("name", "kymjs");
params.put("age", );
params.put("password", "helloword");
RxVolley.post("http://kymjs.com/login", params, HttpCallback() {
@Override
public onSuccess(Map<String, String> headers, [] t) {
Loger.debug("请求到的数据:" + String(t));
// 获取到的cookie
Loger.debug("===" + headers.("Set-Cookie"));
}
});
//向服务器传递cookie信息
HttpParams params = HttpParams();
params.put("name", "kymjs");
params.put("age", );
params.putHeaders("cookie", "your cookie");
RxVolley.post("http://kymjs.com/update", params, HttpCallback() {
@Override
public onSuccess(String t) {
Loger.debug("请求到的数据:" + t);
}
});
比起 入门 章节讲述的网络请求，你可能希望有更多的需求
构建网络请求
HttpParams params = HttpParams();
//同之前的设计，传递 http 请求头可以使用 putHeaders()
params.putHeaders("cookie", "your cookie");
params.putHeaders("User-Agent", "rxvolley");
//传递 http 请求参数可以使用 put()
params.put("name", "kymjs");
params.put("age", );
//http请求的回调，内置了很多方法，详细请查看源码
//包括在异步响应的onSuccessInAsync():注不能做UI操作
//网络请求成功时的回调onSuccess()
//网络请求失败时的回调onFailure():例如无网络，服务器异常等
HttpCallback callback = HttpCallback(){
@Override
public onSuccessInAsync([] t) {
}
@Override
public onSuccess(String t) {
}
@Override
public onFailure( errorNo, String strMsg) {
}
}
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()
//内容参数传递形式，如果不加，默认为 FORM 表单提交，可选项 JSON 内容
.contentType(RxVolley.ContentType.FORM)
.params(params) //上文创建的HttpParams请求参数集
//是否缓存，默认是 get 请求 5 缓存分钟, post 请求不缓存
.shouldCache()
.callback(callback) //响应回调
.encoding("UTF-8") //编码格式，默认为utf-8
.doTask(); //执行请求操作
对 RxJava 的支持
RxVolley 支持返回一个 Observable<Result> 类型的数据，如下是 Result 类的原型
public class Result {
public Map<String, String> header;
public [] data;
public Result(Map<String, String> header, [] data) {
.header = header;
.data = data;
}
}
执行一次请求，并返回 Observable<Result>
Observable<Result> observable = RxVolley.Builder()
.url("http://www.kymjs.com/rss.xml")
//default GET or POST/PUT/DELETE/HEAD/OPTIONS/TRACE/PATCH
.httpMethod(RxVolley.Method.POST)
.cacheTime() //default: get 5min, post 0min
.params(params)
.contentType(RxVolley.ContentType.JSON)
.getResult(); // 使用getResult()来返回RxJava数据类型
//当拿到 observable 对象后，你可以设置你自己的 subscriber
observable.subscribe(subscriber);
完整的使用示例
public classMainActivityextendsAppCompatActivity
private Subscription subscription;
@Override
protected onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Observable<Result> observable = RxVolley.Builder()
.url("http://kymjs.com/feed.xml")
.contentType(RxVolley.ContentType.FORM)
.getResult();
subscription = observable
.map( Func1<Result, String>() {
@Override
public String (Result result) {
return String(result.data);
}
})
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe( Action1<String>() {
@Override
public (String result) {
Log.i("kymjs", "======网络请求" + result);
}
});
}
@Override
protected onDestroy() {
super.onDestroy();
(subscription != && subscription.isUnsubscribed()) {
subscription.unsubscribe();
}
}
}
自定义请求
也许你是 Volley 的重度使用者(就像我)，那么你一定是因为 Volley 自由的扩展性而爱上它的。
你可以通过创建一个Request<?>的子类，自由配置请求策略，缓存策略，数据传输加密，重试策略等。
最后通过
RxVolley.Builder().setRequest(yourRequest).doTask();
去执行你的自定义 Request
一个典型自定义Request的示例：
/**
* Form表单形式的Http请求
*/
public class FormRequest extends Request<[]> {
private final HttpParams mParams;
public FormRequest(RequestConfig config, HttpParams params, HttpCallback callback) {
super(config, callback);
(params == ) {
params = HttpParams();
}
.mParams = params;
}
@Override
public String getCacheKey() {
(getMethod() == RxVolley.Method.POST) {
return getUrl() + mParams.getUrlParams();
} {
return getUrl();
}
}
@Override
public String getBodyContentType() {
(mParams.getContentType() != ) {
return mParams.getContentType();
} {
return super.getBodyContentType();
}
}
@Override
public ArrayList<HttpParamsEntry> getHeaders() {
return mParams.getHeaders();
}
@Override
public [] getBody() {
ByteArrayOutputStream bos = ByteArrayOutputStream();
{
mParams.writeTo(bos);
} catch (IOException e) {
Loger.debug("FormRequest#getBody()--->IOException writing to ByteArrayOutputStream");
}
return bos.toByteArray();
}
@Override
public Response<[]> parseNetworkResponse(NetworkResponse response) {
return Response.success(response.data, response.headers,
HttpHeaderParser.parseCacheHeaders(getUseServerControl(), getCacheTime(),
response));
}
@Override
protected deliverResponse(ArrayList<HttpParamsEntry> headers, final [] response) {
(mCallback != ) {
HashMap<String, String> map = HashMap<>(headers.size());
(HttpParamsEntry entry : headers) {
map.put(entry.k, entry.v);
}
mCallback.onSuccess(map, response);
}
}
@Override
public Priority getPriority() {
return Priority.IMMEDIATE;
}
}
更多可选设置
理论上来说，一切的请求设置都可以通过自定义 Request 来完成。
但是，如果你和我一样是个懒人，当然更希望这些早就有人已经做好了。
设置文件缓存的路径
默认的文件缓存路径是在SD卡根目录的 /RxVolley 文件夹下，你可以通过如下语句设置你的 cacheFolder
RxVolley.setRequestQueue(RequestQueue.newRequestQueue(cacheFolder));
需要注意的是，setRequestQueue 方法必须在 RxVolley.Build() 方法执行之前调用，也就是在使用 RxVolley 以前先设置配置信息。建议在 Application 类中完成这些设置。
Build()中的可选设置
- 详细请参阅 RxVolley$Builder 类中代码。
//请求超时时间
timeout()
//为了更真实的模拟网络,如果读取缓存,延迟一段时间再返回缓存内容
delayTime()
//缓存有效时间,单位分钟
cacheTime()
//使用服务器控制的缓存有效期,即cookie有效期
//(如果使用服务器端控制,则无视#cacheTime())
useServerControl()
//启用缓存
shouldCache()
//重连策略,Volley默认的重连策略是timeout=3000，重试1次
retryPolicy()
使用 OkHttp 替代 HttpUrlconnection
Volley 允许你创建自己的网络请求执行器，执行器需要实现IHttpStack接口
RxVolley 的 okhttp module 已经有了使用 OkHttp 作为请求执行器的实现。
你可以使用如下代码设置，依旧需要注意的是，setRequestQueue 方法必须在 RxVolley.Build() 方法执行之前调用，也就是在使用 RxVolley 以前先设置配置信息。建议在 Application 类中完成这些设置。
RxVolley.setRequestQueue(RequestQueue.newRequestQueue(RxVolley.CACHE_FOLDER, OkHttpStack( OkHttpClient())));
使用 OkHttp 相关功能需要在你的 build.gradle 文件中加入
compile 'com.kymjs.rxvolley:rxvolley:1.0.1'
