Retrofit2 的baseUrl 真的必须以 /(斜线) 结尾吗?

【Retrofit GitHub】: https://github.com/square/retrofit
版本:2.4.0

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl(baseUrl)
        .addConverterFactory(GsonConverterFactory.create())
        .build();

最近刚好想看看Retrofit源码了,之前看过好多博文都提到注意Retrofit2 的baseUrl 必须以 /(斜线) 结束,不然会抛出一个IllegalArgumentException异常
个人感觉这段话说的不严谨,并不是所有的baseUrl不以 /(斜线) 结尾就会抛出一个IllegalArgumentException异常,这里就需要讲述一下Url的格式了,往往一个Url格式为scheme://host[:port]/path[?query],

  • scheme协议,常用的协议是http、https
  • host 主机地址,可以是域名,也可以是IP地址
  • port 端口 http协议默认端口是:80端口,如果不写默认就是:80端口,https默认端口443端口
  • path 路径 网络资源在服务器中的指定路径
  • query 查询字符串 如果需要从服务器那里查询内容
public static final String API_URL = "https://api.github.com";
public interface GitHub {
    @GET("/repos/{owner}/{repo}/contributors")
    Call<List<Contributor>> contributors(
        @Path("owner") String owner,
        @Path("repo") String repo);
  }

现在以https://api.github.com/repos/{owner}/{repo}/contributors这个接口为例,此处的

  • https为scheme,
  • api.github.com为host,此处端口没写(https默认443),
  • repos/{owner}/{repo}/contributors为path,

关于Retrofit中的baseUrl并没有强制怎么写,我可以写成https://api.github.com也可以写成 https://api.github.com/repos/,区别在哪呢?下面听我仔细说:

  1. https://api.github.com的格式可以看成scheme://host[:port](此种类型是不是以 /(斜线) 结尾都可以,均不会抛出IllegalArgumentException异常);
  2. https://api.github.com/repos/的格式可以看成scheme://host[:port]/path(此种类型必须以/(斜线) 结尾,否则会抛出IllegalArgumentException异常).

下面关于baseUrl的问题来看看Retrofit.java中的源码:

public Builder baseUrl(String baseUrl) {
     checkNotNull(baseUrl, "baseUrl == null");
     HttpUrl httpUrl = HttpUrl.parse(baseUrl);
     if (httpUrl == null) {
       throw new IllegalArgumentException("Illegal URL: " + baseUrl);
     }
     return baseUrl(httpUrl);
 }
​
public Builder baseUrl(HttpUrl baseUrl) {
     checkNotNull(baseUrl, "baseUrl == null");
     List<String> pathSegments = baseUrl.pathSegments();
     if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
       throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
     }
     this.baseUrl = baseUrl;
     return this;
 }

可以看到第二个baseUrl方法中会在一定场景下抛出IllegalArgumentException异常,但是在第一个baseUrl方法中HttpUrl.parse(baseUrl)会对baseUrl做处理转换成对应的HttpUrl,区别就在这里了,对于场景1中https://api.github.com会自动转换成https://api.github.com/,如下图:

场景1.png

而场景2中自然不会做处理,若场景2中写成https://api.github.com/repos未以 /(斜线) 结尾,此时HttpUrl.parse(baseUrl)也不会对此做处理,那么就会抛出IllegalArgumentException异常。如下图:

场景2.png

抛异常.png

注意:建议BaseUrl以/(斜线) 结尾。scheme://host[:port]/path类型的baseUrl必须以/(斜线) 结尾。

路径整合规则:

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    aimaile阅读 26,440评论 6 428
  • afinalAfinal是一个android的ioc,orm框架 https://github.com/yangf...
    passiontim阅读 15,396评论 2 45
  • 那是十几年前的事了。舅舅家的孩子刚在太原参加工作。我也师范刚毕业,暑假里到舅舅家玩。表哥顺便请我到太原玩,我很高兴...
    海鱼缘阅读 325评论 5 3
  • 1 那天,正当深夜零时,她忙完手中的工作,在睡梦中几近徘徊,意识飘忽。 所以当电话的震动与铃声响起,她也能迷迷糊糊...
    目觉阅读 621评论 1 12