由于最近的Android项目上使用了流行的 Retrofit＋RxJava + OkHttp方案,现基于已有代码分析总结一篇该框架的简单应用介绍.
介绍:
Retrofit: Retrofit是Square 公司开发的一款正对Android 网络请求的框架,底层基于OkHttp实现.
OkHttp: Square 开源的网络请求库.
RxJava: RxJava 在 GitHub 主页上的自我介绍是 "a library for composing asynchronous and event-based programs using observable sequences for the Java VM"（一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库）.这就是 RxJava ，概括得非常精准。总之就是让异步操作变得非常简单。
各自的职责：
Retrofit: 负责请求的数据和请求的结果，使用接口的方式呈现;
OkHttp: 负责请求的过程;
RxJava: 负责异步，各种线程之间的切换。
下面便于阅读理解,由Retrofit开始,逐步搭建整个框健.
一, 使用Retrofit写一个网络请求
- 首先，要使用Retrofit ,你肯定需要把它的包引入，在你的build.gradle文件中添加如下配置：
compile 'com.google.code.gson:gson:2.8.0'//Gson 库
compile 'com.squareup.okhttp3:okhttp:3.6.0'//okhttp
compile 'com.squareup.okhttp3:logging-interceptor:3.6.0'//interceptor辅助库
compile 'com.squareup.retrofit2:retrofit:2.3.0'//retrofit
compile 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'//配合Rxjava 使用
compile 'com.squareup.retrofit2:converter-gson:2.3.0'//转换器，请求结果转换成Model
compile 'io.reactivex.rxjava2:rxjava:2.1.2' //RxJava
compile 'io.reactivex.rxjava2:rxandroid:2.0.1' //RxAndroid
- 创建一个Retrofit 实例，并且完成相关的配置,先注释掉其中OkHttp和RxJava的配合逻辑.
Retrofit retrofit = new Retrofit.Builder()
//.client(getHttpClient())//配合OkHttp
.addConverterFactory(GsonConverterFactory.create())//GsonConverterFactory 是默认提供的Gson 转换器
//.addCallAdapterFactory(RxJava2CallAdapterFactory.createAsync())//配合RxJava
.baseUrl(BASE_URL)
.build();
- 创建一个service接口：
下例采用Post方式传递简单的键值对,里面使用了Retrofit的一些注解,
@FormUrlEncoded表示表单提交(Post方式必须添加);
@FieldMap传递键值对;
@HeaderMap为表头信息;
@Body表示要传递的对象;
@Path表示链接中{}传递的变量.
public interface BannerService {
@POST("api/src/list")
@FormUrlEncoded
Call<BannerProvider> getProvider(@FieldMap Map<String, String> fieldsMaps,
@HeaderMap Map<String, String> headers);
@POST("/api/src/stats/{Id}/{name}")
Call<BannerResult> reportEvent(@Body Collection<ReportData> datas,
@HeaderMap Map<String, String> headers,
@Path("Id") String appId, @Path("name") String imei);
}
- 接着就可以创建BannerService实例,并调用其中的接口方法进行网络请求.
BannerService service = retrofit.create(BannerService.class);
Call<BannerProvider> call = service.getProvider(params,header);
//同步请求方式:
Response<BannerProvider> response = call.execute();
//异步请求方式:
call.enqueue(new Callback<Provider>() {
@Override
public void onResponse(Call<BannerProvider> call, Response<BannerProvider> response) {
}
@Override
public void onFailure(Call<BannerProvider> call, Throwable t) {
t.printStackTrace();
}
});
二, 配合RxJava的使用
-
创建Retrofit的时候,打开之前的RxJava注释
.addCallAdapterFactory(RxJava2CallAdapterFactory.createAsync())//配合RxJava 更改定义的serivce接口,返回值是一个Flowable(或使用Observable)
在RxJava2中，数据源有两个类，一个Observable，一个是Flowable.区别在于Flowable能处理背压，而Obserable没有处理背压的能力。关于背压的详细讨论参看:https://www.jianshu.com/p/ff8167c1d191
观察者也有两个，一个是Observer，适用于Observable.一个是Subscriber，适用于Flowable.
public interface BannerService {
@POST("api/src/list")
@FormUrlEncoded
Flowable<BannerProvider> getProvider(@FieldMap Map<String, String> fieldsMaps,
@HeaderMap Map<String, String> headers);
}
- 然后使用Flowable封装
Flowable<BannerProvider> bannerProvider = service.getProvider(params,header).doOnNext(cacheConsumer);
Flowable<BannerProvider> flowable = Flowable.concat(bannerProviderCache, bannerProvider)
.firstElement()
.onErrorReturnItem(...)
.toFlowable();
flowable.observeOn(Schedulers.io())
.filter(new Predicate<BannerProvider>() {
@Override
public boolean test(@NonNull BannerProvider bannerProvider) throws Exception {
})
.flatMap(new Function<BannerProvider, Publisher<Banner>>() {
@Override
public Publisher<Banner> apply(BannerProvider bannerProvider) throws Exception {
return load(bannerProvider.name);
}
})
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<Banner>() {
@Override
public void accept(Banner banner) throws Exception {
show();
}
});
三,加入 OkHttp 配置
- 创建OkHttpClient,通过OkHttpClient 可以配置很多东西，比如链接超时时间，缓存，拦截器等
OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.connectTimeout(10, TimeUnit.SECONDS);//连接超时时间
.writeTimeout(10,TimeUnit.SECONDS);//写操作 超时时间
.readTimeout(10,TimeUnit.SECONDS);//读操作超时时间
.addInterceptor(basicParamsInterceptor);// 添加公共参数拦截器
- 创建Retrofit的时候,打开之前的OkHttpClient注释
.client(getHttpClient())//配合OkHttp
以上就是Retrofit+RxJava＋OkHttp实现网络请求的简单演示
