前言:
通过上面的学习,我们不难发现单纯使用okHttp来作为网络库还是多多少少有那么一点点不太方便,而且还需自己来管理接口,对于接口的使用的是哪种请求方式也不能一目了然,出于这个目的接下来学习一下Retrofit+Okhttp的搭配使用。
okHttp相关文章地址:
- Android okHttp网络请求之Get/Post请求
- Android okHttp网络请求之文件上传下载
- Android okHttp网络请求之Json解析
- Android okHttp网络请求之缓存控制Cache-Control
- Android okHttp网络请求之Retrofit+Okhttp组合
Retrofit介绍:
Retrofit和okHttp师出同门,也是Square的开源库,它是一个类型安全的网络请求库,Retrofit简化了网络请求流程,基于OkHtttp做了封装,解耦的更彻底:比方说通过注解来配置请求参数,通过工厂来生成CallAdapter,Converter,你可以使用不同的请求适配器(CallAdapter), 比方说RxJava,Java8, Guava。你可以使用不同的反序列化工具(Converter),比方说json, protobuff, xml, moshi等等。
- 官网 http://square.github.io/retrofit/
- github https://github.com/square/retrofit
Retrofit+OkHttpClient使用:
1.)在build.gradle中添加如下配置
compile 'com.squareup.retrofit2:retrofit:2.1.0'
2.)初始化Retrofit
retrofit = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(FastJsonConverterFactory.create())
.client(mOkHttpClient)
.build();
3.)初始化OkHttpClient
OkHttpClient.Builder builder = new OkHttpClient().newBuilder()
.connectTimeout(10, TimeUnit.SECONDS)//设置超时时间
.readTimeout(10, TimeUnit.SECONDS)//设置读取超时时间
.writeTimeout(10, TimeUnit.SECONDS);//设置写入超时时间
int cacheSize = 10 * 1024 * 1024; // 10 MiB
Cache cache = new Cache(App.getContext().getCacheDir(), cacheSize);
builder.cache(cache);
builder.addInterceptor(interceptor);
mOkHttpClient = builder.build();
关于okHttp的拦截器、Cache-Control等这里就不再做解说了
4.)关于ConverterFactory
对于okHttpClient的初始化我们都已经很熟悉了,对ConverterFactory初次接触多少有点陌生,其实这个就是用来统一解析ResponseBody返回数据的。
常见的ConverterFactory
-
Gson:
com.squareup.retrofit2:converter-gson
-
Jackson:
com.squareup.retrofit2:converter-jackson
-
Moshi:
com.squareup.retrofit2:converter-moshi
-
Protobuf:
com.squareup.retrofit2:converter-protobuf
-
Wire:
com.squareup.retrofit2:converter-wire
-
Simple XML:
com.squareup.retrofit2:converter-simplexml
- Scalars (primitives, boxed, and String):
com.squareup.retrofit2:converter-scalars
由于项目中使用的是FastJson,所以只能自己自定义ConverterFactory,不过国内已经有大神对此作了封装(http://www.tuicool.com/articles/j6rmyi7)。
- FastJson compile 'org.ligboy.retrofit2:converter-fastjson-android:2.0.2'
5.)定义接口 get 请求
1.get请求 不带任何参数
public interface IApi { @GET("users")//不带参数get请求
Call<List<User>> getUsers(); }
2.get请求 动态路径 @Path使用
public interface IApi { @GET("users/{groupId}")//动态路径get请求
Call<List<User>> getUsers(@Path("userId") String userId); }
3.get请求 拼接参数 @Query使用
public interface IApi { @GET("users/{groupId}")
Call<List<User>> getUsers(@Path("userId") String userId, @Query("age")int age); }
3.get请求 拼接参数 @QueryMap使用
public interface IApi { @GET("users/{groupId}")
Call<List<User>> getUsers(@Path("userId") String userId, @QueryMap HashMap<String, String> paramsMap); }
6.)定义接口 post请求
1.post请求 @body使用
public interface IApi { @POST("add")//直接把对象通过ConverterFactory转化成对应的参数
Call<List<User>> addUser(@Body User user); }
2.post请求 @FormUrlEncoded,@Field使用
public interface IApi { @POST("login")
@FormUrlEncoded//读参数进行urlEncoded
Call<User> login(@Field("userId") String username, @Field("password") String password); }
3.post请求 @FormUrlEncoded,@FieldMap使用
public interface IApi { @POST("login")
@FormUrlEncoded//读参数进行urlEncoded
Call<User> login(@FieldMap HashMap<String, String> paramsMap); }
4.post请求 @Multipart,@Part使用
public interface IApi { @Multipart
@POST("login")
Call<User> login(@Part("userId") String userId, @Part("password") String password); }
7.)Cache-Control缓存控制
public interface IApi { @Headers("Cache-Control: max-age=640000")
@GET("users")//不带参数get请求
Call<List<User>> getUsers(); }
8.)请求使用
1.返回IApi
/**
* 初始化Api
*/
private void initIApi() {
iApi = retrofit.create(IApi.class);
} /**
* 返回Api
*/
public static IApi api() { return api.iApi;
}
2.发送请求
Call<String> call = Api.api().login(userId,password);
call.enqueue(new Callback<String>() {
@Override
public void onResponse(Call<String> call, Response<String> response) {
Log.e("", "response---->" + response.body());
} @Override
public void onFailure(Call<String> call, Throwable t) {
Log.e("", "response----失败");
}
});
Retrofit+RxJava使用:
上面介绍了Retrofit 与OkHttp的结合,下面介绍一下Retrofit与RxJava的结合,RxJava作为当前的开源库的网红之一,Retrofit理所当然也提供了对其的支持,RxJava的强大之处强大的异步处理能力,Retrofit与RxJava的结合势必提高开发效率以及运行性能。
1.)在原来的基础上添加以下依赖
compile 'com.squareup.retrofit2:adapter-rxjava:2.0.1' // Retrofit的rx解析库
compile 'io.reactivex:rxandroid:1.2.0'
compile 'io.reactivex:rxjava:1.1.5'
2.)创建retrofit对象实例时,通过addCallAdapterFactory来添加对RxJava的支持
/**
* 初始化Retrofit
*/
private void initRetrofit() {
retrofit = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(FastJsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.client(mOkHttpClient)
.build();
}
3.)定义请求接口
public interface IApi { @POST("system/login")
Observable<String> systemLogin(@Body String userId, @Body String password);
}
4.)调用发送请求
Api.api().systemLogin(userId,password)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Subscriber<String>() {
@Override
public void onCompleted() {
} @Override
public void onError(Throwable e) {
} @Override
public void onNext(String result) { }
});
总结:
这里简单介绍了Retrofit与Okhttp、RxJava的结合使用。