额。。想必有人要问了,这是什么玩意?跟我们平时定义的接口类很像,但又不一样。别心急,我来一一解释下,和别的接口类一样,我们在其中定义了一个方法getSearchBook,那么这个方法是做什么的呢?其实它干的事很简单,就是拼接一个URL然后进行网络请求。这里我们拼接的URL就是上文提到的测试URL:https://api.douban.com/v2/book/search?q=金瓶梅&tag=&start=0&count=1。聪明的你一定看出来了,在这个URL中book/search就是GET后的值,而?后的q、tag、start、count等入参就是这个方法的入参。有的朋友可能要问了,https://api.douban.com/v2/这么一大串跑哪去了?其实我们在进行网络请求时,在URL中前一部分是相对不变的。什么意思呢,比如你打开间书网站,在间书中你打开不同的网页,虽然它的URL不同,但你会发现,每个URL前面都是以http://www.jianshu.com/开头,我们把这个不变的部分,也叫做baseUrl提出来,放到另一个地方,在下面我们会提到。这样我们一个完整的URL就拼接好了。在方法的开头我们可以看到有个GET的注释,说明这个请求是GET方法,当然你也可以根据具体需要用POST、PUT、DELETE以及HEAD。他们的区别如下:
GET ----------查找资源(查)
POST --------修改资源(改)
PUT ----------上传文件(增)
DELETE ----删除文件(删)
HEAD--------只请求页面的首部
然后我们来看一下这个方法的返回值,它返回Call实体,一会我们要用它进行具体的网络请求,我们需要为它指定泛型为Book也就是我们数据的实体类。接下来,你会发现这个方法的入参和我们平时方法的入参还不大一样。在每个入参前还多了一个注解。比如第一个入参@Query("q") String name,Query表示把你传入的字段拼接起来,比如在测试url中我们可以看到q=金瓶梅的入参,那么Query后面的值必须是q,要和url中保持不变,然后我们定义了String类型的name,当调用这个方法是,用于传入字符串,比如可以传入“金瓶梅”。那么这个方法就会自动在q后面拼上这个字符串进行网络请求。以此类推,这个url需要几个入参你就在这个方法中定义几个入参,每个入参前都要加上Query注解。当然Retrofit除了Query这个注解外,还有其他几个比如:@QueryMap、@Path、@Body、@FormUrlEncoded/@Field、@Header/@Headers。我们来看一下他们的区别:
@Query(GET请求):
用于在url后拼接上参数,例如:
`@GET(“book/search”)
Call getSearchBook(@Query(“q”) String name);//name由调用者传入`
相当于:
`@GET(“book/search?q=name”)
Call getSearchBook();`
@QueryMap(GET请求):
当然如果入参比较多,就可以把它们都放在Map中,例如:
`@GET(“book/search”)
Call getSearchBook(@QueryMap Map<String, String> options);`
@Path(GET请求):
用于替换url中某个字段,例如:
`@GET(“group/{id}/users”)
Call groupList(@Path(“id”) int groupId);`
像这种请求接口,在group和user之间有个不确定的id值需要传入,就可以这种方法。我们把待定的值字段用{}括起来,当然 {}里的名字不一定就是id,可以任取,但需和@Path后括号里的名字一样。如果在user后面还需要传入参数的话,就可以用Query拼接上,比如:
`@GET(“group/{id}/users”)
Call groupList(@Path(“id”) int groupId,@Query(“sort”) String sort);`
当我们调用这个方法时,假设我们groupId传入1,sort传入“2”,那么它拼接成的url就是group/1/users?sort=2,当然最后请求的话还会加上前面的baseUrl。
@Body(POST请求):
可以指定一个对象作为HTTP请求体,比如:
`@POST(“users/new”)
Call createUser(@Body User user);`
它会把我们传入的User实体类转换为用于传输的HTTP请求体,进行网络请求。
@Field(POST请求):
用于传送表单数据:
`@FormUrlEncoded
@POST(“user/edit”)
Call updateUser(@Fie
《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》
【docs.qq.com/doc/DSkNLaERkbnFoS0ZF】 完整资料开源分享
ld(“first_name”) String first, @Field(“last_name”) String last);`
注意开头必须多加上@FormUrlEncoded这句注释,不然会报错。表单自然是有多组键值对组成,这里的first_name就是键,而具体传入的first就是值啦。
@Header/@Headers(POST请求):
用于添加请求头部:
`@GET(“user”)
Call getUser(@Header(“Authorization”) String authorization)`
表示将头部Authorization属性设置为你传入的authorization;当然你还可以用@Headers表示,作用是一样的比如:
`@Headers(“Cache-Control: max-age=640000”)
@GET(“user”)
Call getUser()`
当然你可以多个设置:
`@Headers({
“Accept: application/vnd.github.v3.full+json”,
“User-Agent: Retrofit-Sample-App”
})
@GET(“user”)
Call getUser()`
好了,这样我们就把上面这个RetrofitService 接口类解释的差不多了。我觉得,Retrofit最主要的也就是这个接口类的定义了。好了,有了这个接口类,我们来看一下,到底如何使用这个我们定义的接口来进行网络请求。代码如下:
`Retrofit retrofit = new Retrofit.Builder()
.baseUrl(“https://api.douban.com/v2/”)
.addConverterFactory(GsonConverterFactory.create(new GsonBuilder().create()))
.build();
RetrofitService service = retrofit.create(RetrofitService.class);
Call call = service.getSearchBook(“金瓶梅”, null, 0, 1);
call.enqueue(new Callback() {
@Override
public void onResponse(Call call, Response response) {
text.setText(response.body()+"");
}
@Override
public void onFailure(Call call, Throwable t) {
}
});`
这里我们可以看到,先新建了一个Retrofit对象,然后给它设置一个我们前面说的baseUrlhttps://api.douban.com/v2/.因为接口返回的数据不是我们需要的实体类,我们需要调用addConverterFactory方法进行转换。由于返回的数据为json类型,所以在这个方法中传入Gson转换工厂GsonConverterFactory.create(new GsonBuilder().create()),这里我们需要在studio中添加Gson的依赖:
compile ‘com.squareup.retrofit2:converter-gson:2.1.0’
然后我们调用retrofit的create方法并传入上面我们定义的接口的文件名RetrofitService.class,就可以得到RetrofitService 的实体对象。有了这个对象,我们就可以调用里面之前定义好的请求方法了。比如:
Call<Book> call = service.getSearchBook("金瓶梅", null, 0, 1);
它会返回一个Call实体类,然后就可以调用Call的enqueue方法进行异步请求,在enqueue方法中传入一个回调CallBack,重写里面的onResponse和
onFailure方法,也就是请求成功和失败的回调方法。当成功时,它会返回Response,里边封装了请求结果的所有信息,包括报头,返回码,还有主体等。比如调用它的body()方法就可获得Book对象,也就是我们需要的数据。这里我们就把返回的Book,显示屏幕上。如下图:

好了,到这里我们就基本了解了Retrofit的整个工作流程。
3.RxJava
我们这篇文章主要介绍搭建整体网络请求框架,所以关于RxJava的基础知识,我这就不再详细介绍了,网上也有很多文章,对RxJava还不是很了解的同学,推荐你看一下扔物线的这篇文章给 Android 开发者的 RxJava 详解
下面我们来看一下RxJava和retrofit的结合使用,为了使Rxjava与retrofit结合,我们需要在Retrofit对象建立的时候添加一句代码addCallAdapterFactory(RxJavaCallAdapterFactory.create()),当然你还需要在build.gradle文件中添加如下依赖:
compile ‘com.squareup.retrofit2:adapter-rxjava:2.1.0’
完整的代码如下:
`Retrofit retrofit = new Retrofit.Builder()
.baseUrl(“https://api.douban.com/v2/”)
.addConverterFactory(GsonConverterFactory.create(new GsonBuilder().create()))
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())//支持RxJava
.build();`
然后我们还需要修改RetrofitService 中的代码:
`public interface RetrofitService {
@GET(“book/search”)
Observable getSearchBook(@Query(“q”) String name,
@Query(“tag”) String tag, @Query(“start”) int start,
@Query(“count”) int count);`
可以看到,在原来的RetrofitService 中我们把getSearchBook方法返回的类型Call改为了Observable,也就是被观察者。其他都没变。然后就是创建RetrofitService 实体类:
RetrofitService service = retrofit.create(RetrofitService.class);
和上面一样,创建完RetrofitService ,就可以调用里面的方法了:
Observable<Book> observable = service.getSearchBook("金瓶梅", null, 0, 1);
其实这一步,就是创建了一个rxjava中observable,即被观察者,有了被观察者,就需要一个观察者,且订阅它:
`observable.subscribeOn(Schedulers.io())//请求数据的事件发生在io线程
.observeOn(AndroidSchedulers.mainThread())//请求完成后在主线程更显UI
.subscribe(new Observer() {//订阅
@Override
public void onCompleted() {
//所有事件都完成,可以做些操作。。。
}
@Override
public void onError(Throwable e) {
e.printStackTrace(); //请求过程中发生错误
}
@Override
public void onNext(Book book) {//这里的book就是我们请求接口返回的实体类
}
}`
在上面中我们可以看到,事件的消费在Android主线程,所以我们还要在build.gradle中添加如下依赖:
compile ‘io.reactivex:rxandroid:1.2.0’
这样我们就引入了RxAndroid,RxAndroid其实就是对RxJava的扩展。比如上面这个Android主线程在RxJava中就没有,因此要使用的话就必须得引用RxAndroid。
4.实践
接下来我们就看看,在一个项目中上面三者是如何配合的。我们打开Android Studio,新建一个项目取名为MVPDemo。这个demo的功能也很简单,就是点击按钮调用上面的那个测试接口,将请求下来书的信息显示在屏幕上。首先我们来看一下这个工程的目录结构:

我们可以看到,在项目的包名下,我们建了三个主要的文件夹:app、service、ui。当然根据项目的需要你也可以添加更多其他的文件夹,比如一些工具类等。其中app文件夹中可以建一个Application类,用于设置应用全局的一些属性,这里为了使项目更加简单就没有添加;然后,我们再来看看ui文件夹下,这个文件夹下主要放一些关于界面的东西。在里面我们又建了三个文件夹:activity、adapter、fragment,我想看名字你就清楚里面要放什么了。最后我们在重点看看service文件夹中的东西。首先我们来看看里面重要的两个类:RetrofitHelper和RetrofitService。RetrofitHelper主要用于Retrofit的初始化:
`public class RetrofitHelper {
private Context mCntext;
OkHttpClient client = new OkHttpClient();
GsonConverterFactory factory = GsonConverterFactory.create(new GsonBuilder().create());
private static RetrofitHelper instance = null;
private Retrofit mRetrofit = null;
public static RetrofitHelper getInstance(Context context){
if (instance == null){
instance = new RetrofitHelper(context);
}
return instance;
}
private RetrofitHelper(Context mContext){
mCntext = mContext;
init();
}
private void init() {
resetApp();
}
private void resetApp() {
mRetrofit = new Retrofit.Builder()
.baseUrl(“https://api.douban.com/v2/”)
.client(client)
.addConverterFactory(factory)
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
}
public RetrofitService getServer(){
return mRetrofit.create(RetrofitService.class);
}
}`
代码并不复杂,其中resetApp方法,就是前面介绍的Retrofit的创建,getServer方法就是为了获取RetrofitService接口类的实例化。然后定义了一个静态方法getInstance用于获取自身RetrofitHelper的实例化,并且只会实例化一次。
接下来,看一下RetrofitService,其中代码还是上面一样:
`public interface RetrofitService {
@GET(“book/search”)
Observable getSearchBooks(@Query(“q”) String name,
@Query(“tag”) String tag, @Query(“start”) int start,
@Query(“count”) int count);
}`
然后我们依次来看一下service文件夹下的四个文件夹:entity、manager、presenter和view。其中entity下放我们请求的实体类,这里就是Book。接下来我们来看一下manager中DataManager。这个类其实就是为了让你更方便的调用RetrofitService 中定义的方法:
`public class DataManager {
private RetrofitService mRetrofitService;
public DataManager(Context context){
this.mRetrofitService = RetrofitHelper.getInstance(context).getServer();
}
public Observable getSearchBooks(String name,String tag,int start,int count){
return mRetrofitService.getSearchBooks(name,tag,start,count);
}
}`
可以看到,在它的构造方法中,我们得到了RetrofitService 的实例化,然后定义了一个和RetrofitService 中同名的方法,里面其实就是调用RetrofitService 中的这个方法。这样,把RetrofitService 中定义的方法都封装到DataManager 中,以后无论在哪个要调用方法时直接在DataManager 中调用就可以了,而不是重复建立RetrofitService 的实例化,再调用其中的方法。
好了,我们再来看一下presenter和view,我们在前面说过,presenter主要用于网络的请求以及数据的获取,view就是将presenter获取到的数据进行展示。首先我们先来看view,我们看到我们建了两个接口类View和BookView,其中View是空的,主要用于和Android中的View区别开来:
`public interface View {
}`
然后让BookView继承自我们自己定义的View :
`public interface BookView extends View {
void onSuccess(Book mBook);
void onError(String result);
}`
可以看到在里面定义两个方法,一个onSuccess,如果presenter请求成功,将向该方法传入请求下来的实体类,也就是Book,view拿到这个数据实体类后,就可以进行关于这个数据的展示或其他的一些操作。如果请求失败,就会向这个view传入失败信息,你可以弹个Toast来提示请求失败。通常这两个方法比较常用,当然你可以根据项目需要来定义一些其他的方法。接下来我们看看presenter是如何进行网络请求的 。我们也定义了一个基础Presenter:
`public interface Presenter {
void onCreate();
请求以及数据的获取,view就是将presenter获取到的数据进行展示。首先我们先来看view,我们看到我们建了两个接口类View和BookView,其中View是空的,主要用于和Android中的View区别开来:
`public interface View {
}`
然后让BookView继承自我们自己定义的View :
`public interface BookView extends View {
void onSuccess(Book mBook);
void onError(String result);
}`
可以看到在里面定义两个方法,一个onSuccess,如果presenter请求成功,将向该方法传入请求下来的实体类,也就是Book,view拿到这个数据实体类后,就可以进行关于这个数据的展示或其他的一些操作。如果请求失败,就会向这个view传入失败信息,你可以弹个Toast来提示请求失败。通常这两个方法比较常用,当然你可以根据项目需要来定义一些其他的方法。接下来我们看看presenter是如何进行网络请求的 。我们也定义了一个基础Presenter:
`public interface Presenter {
void onCreate();