Retrofit之请求Url

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

base url与端点url的连接

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

  1. 定义HTTP请求方法,GET、POST、PUT、DELETE等等,Retrofit中都有相对应的注解。
  2. 在注解上添加相对资源端点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的定义方式,就可以处理各种url了。如果你对retrofit感兴趣,同时你也觉得我的文章可以给你带来那么一丢丢的帮助,敬请关注,后续会继续介绍Retrofit的相关使用。

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

关于源码:

  1. 不只是本文涉及的代码,会包含很多知识点的代码,应该都会在我的简书中进行介绍。
  2. 有可能代码与本文中所贴出来的有差异,但应该都是我觉得更好的方式吧。
  3. 新浪微博相关的代码运行显示不出来结果,感兴趣的可以参考新浪微博SDK,配置工程。
  4. 欢迎大家对我进行批评教育。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 221,198评论 6 514
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,334评论 3 398
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,643评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,495评论 1 296
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,502评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,156评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,743评论 3 421
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,659评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,200评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,282评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,424评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,107评论 5 349
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,789评论 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,264评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,390评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,798评论 3 376
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,435评论 2 359

推荐阅读更多精彩内容