Retrofit2 的baseUrl 到底要不要以“/”结尾

前言

最近新换公司,公司要求使用Retrofit2作为网络框架,所以大量阅读相关博客,发现很多博客都提到注意Retrofit2 的baseUrl 必须以“ / ” (斜线) 结束,不然会抛出一个IllegalArgumentException异常。当然也有不同意见的博主表示,不以“ / ”(斜线)同样不会抛出异常,但也没有说出个所以然来。好巧不巧的是,自己在项目中使用的时候就没以 “ / ” (斜线)结尾,确实没抛出异常(Retrofit2版本:2.9.0)。所以决定一探究竟。当出现不同答案时,源码才能告诉我们谁对谁错。Ok废话不多说,进入主题。

在看源码前,我们需要先了解下 Url的格式了

我们常见的基本都是scheme://host[:port]/path[?query]scheme://host:port/path?query

名词解释
  • scheme协议,常用的协议是http、https
  • host 主机地址,可以是域名,也可以是IP地址
  • port 端口 http协议默认端口是:80端口,如果不写默认就是:80端口,https默认端口443端口
  • path 路径 网络资源在服务器中的指定路径
  • query 查询字符串 如果需要从服务器那里查询内容
到目前相信大家已经大致了解Url的基本组成。那我们来看看为什么baseUrl 有时候需要传“ / ”(斜线)有时候不需要呢。让我们来看看Retrofit2.baseUrl()方法里面到底做了什么?
  1. 点进去看,第一步还是很简单的做了个非空判断,我们重点看HttpUrl.get(baseUrl)方法中的parse方法里面做了什么
    baseUrl解析.png

    baseUrl1.png
  2. 判断地址是否符合规则,我们可以看到schemeDelimiterOffset方法是在寻找协议后面的“ :”冒号,如果找到了,返回相应的下标,如果没找到他会尝试的设置base.scheme 但是很不幸的是,我们可以看到入口传的base是null,所以如果没找到。会抛出一个IllegalArgumentException( "Expected URL scheme 'http' or 'https' but no colon was found")异常,如果找到了“ :”下标,将会进一步筛选出协议,如图“筛选协议.png”中的第二步2。如果协议不是以“http”或“https”开头同样是会抛出异常的。这时候我们已经找到了协议头,并且把协议头+冒号的结束位子记录在pos
    协议后面:的位子.png

    筛选协议.png
  3. 再往后可以看到,他从协议后面剩余的字符串中继续逐个寻找,判断协议后面紧接着(连续)的是否存在大于两个以上的“ / 或 \ ”(斜线),如果存在pos添加斜线数量。紧接着寻找斜杠后面的字符串,继续逐条寻找是否包含@/\?#这几个字符,如果存在,返回找到的下标,不存在返回地址的长度。
    寻找符合条件的url.png
  4. 紧接着通过portColonOffset方法来寻找区分端口与域名的下标,通过:[ ]来获取,其次通过canonicalizeHost方法获取到域名(IP),其中通过canonicalizeHost方法判断域名是否符合规则,如果域名不符合条件的将抛出异常,最后通过parsePort方法获取端口号,如果端口不符合条件也将抛出异常
    获取域名、端口.png
重点来了 encodedPathSegments这个集合要记住,他是存放baseUrl后面的path的,后面就是通过这个来判断的是否以“ / ”结尾
  1. 从第三步找到@/\?#这个位子的地方,通过resolvePath方法首先判断找到的位子是否就是url的最后一位,如果是,就跳过,否则继续判断是否为/ 或 \,如果是,就清空encodedPathSegments集合,并添加" "空字符,否则将会把集合最后一个改为" "空字符,最后通过delimiterOffset方法逐个排查后面是否还存在/ 或 \ 通过segmentHasTrailingSlash此字段判断是否为最后一个/ 或 \ 在通过push方法对encodedPathSegments集合进行添加path
    寻找最后一个斜线,添加编码路径片段.png
这里特别注意

只有当最后一个字符为/ 或 \encodedPathSegments集合才会添加" "空字符。
只有当最后一个字符为/ 或 \encodedPathSegments集合才会添加" "空字符。
只有当最后一个字符为/ 或 \encodedPathSegments集合才会添加" "空字符。

以斜杠结尾添加空字符.png

6、到这一步,baseUrl的基本属性基本获取完成了,我们回到第一步进来的build里面去看看,我们逐步点进去看看。build>>>HttpUrl>>>builder.toString() builder.toString()里面将之前拆分获取的协议、域名、端口等信息拼接起来。
build.png

builder.toString.png

第二个重点来了 通过 pathSegmentsToString方法,添加斜杠,还记得我们之前encodedPathSegments说的这个集合吧。这一步就是将集合中的path拼接到baseUrl中。由于我们以斜杠结尾的时候,集合末尾都添加了" "空字符,所以我们最后拼接的baseUrl会以空字符结尾。
添加斜杠.png

拼接路径.png
  1. 回到最开始的baseUrl方法,可以看到它通过pathSegments这个集合判断是否以/(斜线)结尾。取这个集合的最后一位,是不是" "等于空字符,如果不是,那就抛出异常,这时候,肯定有人要骂街了,你丫的不是让我记住encodedPathSegments这个集合吗?怎么现在又变成pathSegments这个集合了???别急,年轻人要撑得住气😄。我们继续往下看。
    baseUrl.png

    判断是否以斜杠结尾.png
  2. 我们继续看看pathSegments集合是哪里来的。我们可以看到他的赋值点就只有一处,还是很好找的。你看,他最终是不是还是引用了encodedPathSegments这个集合嘛!🤭
    赋值点.png

    赋值.png
  3. 这时候还有同学会问了,我要是直接以端口结尾呢?后面没跟path呢,也没跟/(斜杠)呢。第5步就直接跳过了,那岂不是没有以" "结尾,那不也得抛异常?同学你看到很仔细嘛。那我们就看看创建Builder().parse(null, url).build()的时候帮我们做了什么吧。从Builder().parse(null, url).build()方法里面我们就可以看到他内部刚创建的时候已经添加了一个空字符,所以我们以端口结尾,不添加/(斜杠),依然不会报错,是因为httpUrl里面帮我们做好了处理。
    创建builder.png

    默认添加空字符.png

总结

  • 以端口结尾的不添加/依然不会抛异常
  • 格式:scheme://host[:port]scheme://host:port
  • 以相对路径结尾的必须添加/,否在会抛异常
  • 格式:scheme://host[:port]/pathscheme://host:port/path
  • 首先不已/结尾是会抛出异常的,毕竟人家判断放在那里,只不过,以端口结尾的时候内部帮我们做了处理。
  • 我使用的当前Retrofit2的版本还是比较高的,是做了处理的,据说低版本的Retrofit是没有这个处理的。这么说来那就不存在对错问题了🤭。

参考文献:Retrofit2 的baseUrl 真的必须以 /(斜线) 结尾吗?

上一篇:AndroidStudio常见的问题及解决方案

下一篇:Retrofit2 的baseUrl 到底要不要以“/”结尾

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

推荐阅读更多精彩内容