额。。想必有人要问了,这是什么玩意?跟我们平时定义的接口类很像,但又不一样。别心急,我来一一解释下,和别的接口类一样,我们在其中定义了一个方法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(“gro