Android 搭建MVP+Retrofit+RxJava网络请求框架(一)

之前公司的项目用到了MVP+Retrofit+RxJava的框架进行网络请求,所以今天特此写一篇文章以做总结。相信很多人都听说过MVP、Retrofit、以及RxJava,有的人已经开始用了,有的人可能还不知道这是什么,以及到底怎么用。不过没关系,接下来我将为你一一揭开他们的神秘面纱,然后利用这三个家伙搭建一个网络请求框架

1.什么是MVP?

MVP(Model View Presenter)其实就是一种项目的整体框架,能让你的代码变得更加简洁,说起框架大家可能还会想到MVC、MVVM。由于篇幅原因,这里我们先不讲MVVM,先来看一下MVC。其实Android本身就采用的是MVC(Model View Controllor)模式、其中Model指的是数据逻辑和实体模型;View指的是布局文件、Controllor指的是Activity。对于很多Android初学者可能会有这样的经历,写代码的时候,不管三七二十一都往Activity中写,当然我当初也是这么干的,根本就没有什么框架的概念,只要能实现某一个功能就很开心了,没有管这么多。当然项目比较小还好,一旦项目比较大,你会发现,Activity所承担的任务其实是很重的,它既要负责页面的展示和交互,还得负责数据的请求和业务逻辑之类的工作,相当于既要打理家庭,又要教育自己调皮的孩子,真是又当爹又当妈。。。那该怎么办呢?这时候Presenter这个继父来到了这个家庭。Presenter对Activity说,我来了,以后你就别这么辛苦了,你就好好打理好View这个家,我专门来负责教育Model这孩子,有什么情况我会向你反映的。这时Activity流下了幸福的眼泪,从此,Model、View(Activity)、Presenter一家三口过上了幸福的生活。。。好了磕个药继续,由于Presenter(我们自己建的类)的出现,可以使View(Activity)不用直接和Model打交道,View(Activity)只用负责页面的显示和交互,剩下的和Model交互的事情都交给Presenter做,比如一些网络请求、数据的获取等,当Presenter获取到数据后再交给View(Activity)进行展示,这样,Activity的任务就大大减小了。这便是MVP(Model 还是指的数据逻辑和实体模型,View指的是Activity,P就是Presenter)框架的工作方式。

2.什么是Retrofit?

接下来我们看一下什么是Retrofit。在官网对Retrofit的描述是这样的

A type-safe HTTP client for Android and Java说人话就是“一个类型安全的用于Android和Java网络请求的客户端”,其实就是一个封装好的网络请求库。接下来就来看一下这个库该怎么用。首先我在网上找了一个API接口用于测试:https://api.douban.com/v2/book/search?q=金瓶梅&tag=&start=0&count=1这是一个用于查询一本书详细信息的一个请求接口。如果直接用浏览器打开的话会返回以下内容:

浏览器中返回内容

接下来我们来看看如何用Retrofit将上面的请求下来。为了在Android Studio中添加Retrofit库,我们需要添加如下依赖:

compile 'com.squareup.retrofit2:retrofit:2.1.0'

好了,添加完该库,我们再来看看如何使用,首先我们来建一个实体类Book,用于装网络请求后返回的数据。这里顺带说一下,有的人建一个实体类时可能会根据浏览器中返回中的数据一行一行敲,其实这样非常麻烦,这里教大家一个简单的方法,瞬间生成一个实体类。没错有的人可能用过,我们需要一个插件GsonFormat。它的使用也很简单,首先需要在Android Studio中下载,点击左上角菜单栏中的File,然后点击Settings,在弹窗中选择Plugins,然后点击下方的Browse repositories...

然后在新打开的窗口中搜索GsonFormat,点击右侧绿色按钮就可以下载安装了,安装完需要重启下studio,就可以用了。

它的用法也很简单,比如你先建立一个新的空类取名Book,然后在里面按Alt+insert,会有个小弹窗选择GsonFormat,之后在弹出的编辑框中拷入在浏览器中请求下来的那一坨东西,然后一直点ok就会自动生成字段,以及set和get方法,一会儿我们用Retrofit请求下来的数据都会保存在这个实体类中,还是挺方便的。最后我们里面添加一个toString()方法,用于后面显示方便。

接下来,回到我们的Retrofit中上,实体类已经建好了,我们来看看这个Retrofit如何进行网络请求,其实代码也很简单。首先我们需要定义一个接口,取名RetrofitService :

public interface RetrofitService {

@GET("book/search")

Observable getSearchBooks(@Query("q") String name,

@Query("tag") String tag,@Query("start")intstart,

@Query("count")intcount);

}

额。。想必有人要问了,这是什么玩意?跟我们平时定义的接口类很像,但又不一样。别心急,我来一一解释下,和别的接口类一样,我们在其中定义了一个方法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前面都是以//www.greatytc.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(@QueryMapMap 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(@BodyUser user);

它会把我们传入的User实体类转换为用于传输的HTTP请求体,进行网络请求。

@Field(POST请求):

用于传送表单数据:

@FormUrlEncoded@POST("user/edit")

Call updateUser(@Field("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对象,然后给它设置一个我们前面说的baseUrl:https://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 的实体对象。有了这个对象,我们就可以调用里面之前定义好的请求方法了。比如:

Callcall=  service.getSearchBook("金瓶梅",null,0,1);

它会返回一个Call实体类,然后就可以调用Call的enqueue方法进行异步请求,在enqueue方法中传入一个回调CallBack,重写里面的onResponse和

onFailure方法,也就是请求成功和失败的回调方法。当成功时,它会返回Response,里边封装了请求结果的所有信息,包括报头,返回码,还有主体等。比如调用它的body()方法就可获得Book对象,也就是我们需要的数据。这里我们就把返回的Book,显示屏幕上。如下图:

Book中的数据

好了,到这里我们就基本了解了Retrofit的整个工作流程。

3.RxJava

我们这篇文章主要介绍搭建整体网络请求框架,所以关于RxJava的基础知识,我这就不再详细介绍了,网上也有很多文章,对RxJava还不是很了解的同学,推荐你看一下抛物线的这篇文章给 Android 开发者的 RxJava 详解

感兴趣可以接着看下一篇:

//www.greatytc.com/p/d62fd00dfd76


参考文章://www.greatytc.com/p/7b839b7c5884

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,340评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,762评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,329评论 0 329
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,678评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,583评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,995评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,493评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,145评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,293评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,250评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,267评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,973评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,556评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,648评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,873评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,257评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,809评论 2 339

推荐阅读更多精彩内容