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的，后面就是通过这个来判断的是否以“ / ”结尾

5. 从第三步找到@/\?#这个位子的地方，通过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

7. 回到最开始的baseUrl方法，可以看到它通过pathSegments这个集合判断是否以/（斜线）结尾。取这个集合的最后一位，是不是" "等于空字符，如果不是，那就抛出异常，这时候，肯定有人要骂街了，你丫的不是让我记住encodedPathSegments这个集合吗？怎么现在又变成pathSegments这个集合了？？？别急，年轻人要撑得住气😄。我们继续往下看。
   baseUrl.png
   判断是否以斜杠结尾.png
8. 我们继续看看pathSegments集合是哪里来的。我们可以看到他的赋值点就只有一处，还是很好找的。你看，他最终是不是还是引用了encodedPathSegments这个集合嘛！🤭
   赋值点.png
   赋值.png
9. 这时候还有同学会问了，我要是直接以端口结尾呢？后面没跟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]/path或scheme://host:port/path
• 首先不已/结尾是会抛出异常的，毕竟人家判断放在那里，只不过，以端口结尾的时候内部帮我们做了处理。
• 我使用的当前Retrofit2的版本还是比较高的，是做了处理的，据说低版本的Retrofit是没有这个处理的。这么说来那就不存在对错问题了🤭。

参考文献：Retrofit2 的baseUrl 真的必须以 /（斜线） 结尾吗？

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

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