Retrofit之请求Url

2017-01-14 15:50:23来源:http://www.jianshu.com/p/be4007f8eac7作者:DoAndKeep人点击

第七城市

在之前的《Retrofit之初体验》中,我们初步了解了如何使用Retrofit,没有阅读过的同学,建议先阅读下。接下来,我们开始讨论Retrofit的各个细节,本文介绍的是如何定义Retrofit的请求url。


base url与端点url的连接

从上文我们知道,Retrofit在Java接口方法上使用注解来描述API端点及请求的处理:


定义HTTP请求方法,GET、POST、PUT、DELETE等等,Retrofit中都有相对应的注解。
在注解上添加相对资源端点url。

于是就会有像这样的一个接口:


public interface WeiboService {
@GET("statuses/public_timeline.json")
Call<Object> timelineForPublic();
}

Retrofit类定义了base url,而这里通过GET注解定义的资源url会与base url连接起来作为最终的请求url。


我们定义的base url为:


Retrofit.Builder().baseUrl("https://api.weibo.com/2/");

得到的最终的请求url为:


https://api.weibo.com/2/statuses/public_timeline.json

当然,这个最终请求url是正确的,那么如果base url中的末尾不带"/",而在端点url的前段带"/",是否也一样可以呢?答案是不可以,app直接崩溃了,抛出了ExceptionInInitializerError异常,因为Retrofit要求base url必须以"/"结尾。


好的,base url是不能改了,那如果只在端点url的前面加"/"会如何呢?


此时得到的最终请求url为:


https://api.weibo.com/statuses/public_timeline.json

这又是为什么呢?


首先,明确一个概念,当端点url以"/"开头时代表绝对路径后缀路径,而base url的中的"2"则为路径参数。当端点url是绝对路径时,在base url中包含的路径参数会被忽略,于是就变成了最终的"https://api.weibo.com/statuses/public_timeline.json"。


base url的应用

在处理API时,通常它们都有共同的基本地址,也就是Retrofit中的base url。有时候,因为服务器的升级,可能会发生改变,例如微博的从api从版本2升级到版本3,那么base url就会变成"https://api.weibo.com/3/",而我们只需要在定义base url的地方更改即可,这样每个端点的最终请求url也都会随之改变。亦或者,可能有测试服务器、预发服务器以及正式服务器,API的端点url不会改变,改变的都只会是base url。


端点url的应用

在上面谈base url与端点url连接时了解到,当base url以"/"开头时,会忽略base url中的路径参数。好了,现在假如有这样一种情况,微博的大部分api还是版本2,但是获取广场微博的api从版本2升级到版本3,也就是请求url应该为:


https://api.weibo.com/3/statuses/public_timeline.json

因此,我们可以在定义API端点时,将端点url设置为"/3/statuses/public_timeline.json",这样就可以使得获取广场微博调用版本3的API,而其他的还是使用版本2的API。


动态url的应用

使用base url和端点url可以应对大多数API,但是应用中总会出现另类的API。在我的示例中,现在要获取天气,当然我只能找到一个免费的api了,链接是:http://apistore.baidu.com/apiworks/servicedetail/112.html,可以看到请求的url是"http://apis.baidu.com/apistore/weatherservice/weather",此时base url就完全不可用了,这时候就到了动态url出场的时间了。


定义动态url只需要添加一个字符串参数用来表示url,并使用@Url注解:


public interface WeatherService {
@Headers("apikey:b86c2269fe6588bbe3b41924bb2f2da2")
@GET
Call<WeatherWrapper> weather(@Url String url, @Query("cityname") String cityName);
}

代码中的@Headers是用来添加请求头的,这块暂不用管,后续会有文章进行介绍。好了,关注我们的动态url,可以发现现在@GET注解后面没有了端点url,并使用了@Url来定义请求url。


上面我们了解了base url和端点url的连接,那Retrofit又是如何处理base url和动态url的呢?


分三种情况(base url为"https://api.weibo.com/2/"):


动态url包含完整的scheme和host,直接使用动态url作为最终的请求url。例如动态url为"http://apis.baidu.com/apistore/weatherservice/weather",那么最终的请求url也为"http://apis.baidu.com/apistore/weatherservice/weather"。
动态url包含该host,则使用base url的scheme连接动态url作为最终的请求url。例如动态url为"//apis.baidu.com/apistore/weatherservice/weather",那么最终的请求url为"https://apis.baidu.com/apistore/weatherservice/weather"。
动态url不包含scheme和host,则将base url与动态url连接起来作为最终的请求url,与在@GET后定义端点url一致。例如动态url为"/apistore/weatherservice/weather",那么最终的请求url为"https://api.weibo.com/apistore/weatherservice/weather"。

根据使用场景,灵活使用url的定义方式,就可以处理各种url了。如果你对retrofit感兴趣,同时你也觉得我的文章可以给你带来那么一丢丢的帮助,敬请关注,后续会继续介绍Retrofit的相关使用。


源码地址:
https://github.com/FILWAndroid/DevJourney


关于源码:


不只是本文涉及的代码,会包含很多知识点的代码,应该都会在我的简书中进行介绍。
有可能代码与本文中所贴出来的有差异,但应该都是我觉得更好的方式吧。
新浪微博相关的代码运行显示不出来结果,感兴趣的可以参考新浪微博SDK,配置工程。
欢迎大家对我进行批评教育。



第七城市

最新文章

123

最新摄影

微信扫一扫

第七城市微信公众平台