Retrofit2-如何在请求时使用动态URL

Retrofit2为动态url带来的新的注解,在Retrofit 1中迷惑的点现在只需要一个 Url 注解就能描述结点(endpoint)。
这篇文章将会展示如何利用动态结点url处理单独的请求。

原文地址

Retrofit 2 — How to Use Dynamic Urls for Requests

使用案例情况

这里有两个案例来说明真实的应用场景。

  • 图片详情:如果你的app允许用户上传他们自己的个人头像,你可能需要将这些文件储存在不同的地方比如你自己的服务器,Amazon S3(亚马逊云服务)或者是Gravatar(Globally Recognized Avatar)
  • 文件下载:文件可以被存储在多个地方而且你希望从任何资源地址灵活的下载内容

即使你的app没有任何建议的功能,你也可以可以适当的想象一个适合动态URL使用的例子。

怎么使用动态URLs

实际上,它只需要你加入一个单独的注解 @Url 在你的定义的结点,一图胜千言

public interface UserService {  
    @GET
    public Call<ResponseBody> profilePicture(@Url String url);
}

可以看到,在 GET 上不需要结点url,我们可以直接在方法中去添加这个url

Urls是怎么针对base url解析的

有另外一个有趣而且需要注意的地方:动态url是怎么在已经定义base Url的情况下被解析的,Retrofit 2使用OkHttp的 HttpUrl 而且解析任何URL结点成类似一个网址的链接。
让我们根据一些场景来明白这个过程,首先我们有一个url指向Amazon S3(注:一个云服务平台,类似七牛)中存储的一个图片地址,而且我们也已经定义了一个base Url,这两个的地址是完全不一样的,

Retrofit retrofit = Retrofit.Builder()  
    .baseUrl("https://your.api.url/");
    .build();

UserService service = retrofit.create(UserService.class);  
service.profilePicture("https://s3.amazon.com/profile-picture/path");

// request url results in:
// https://s3.amazon.com/profile-picture/path

因为你设置了一个完全不同的包含scheme的host (https://s3.amazon.com vs. https://your.api.url) ,OkHttp的HttpUrl会解析它成我们设置的url,这个和我们所定义的base Url并没有关系。
第二个例子:这次我们指定动态url在我们已经定义的base Url同一个服务下面,比如下面的代码

Retrofit retrofit = Retrofit.Builder()  
    .baseUrl("https://your.api.url/");
    .build();

UserService service = retrofit.create(UserService.class);  
service.profilePicture("profile-picture/path");

// request url results in:
// https://your.api.url/profile-picture/path

这次,这个最终的请求url被会我们定义的base Url和动态结点url联系起来,HttpUrl(OkHttp)会意识到我们没有指定一个scheme和host,因此这个url结点会被加到base Url的后面。
第三个例子:我们假设后端开发发布了一个更新版本v2,并且和原来的base Url冲突了,比如下面的例子

Retrofit retrofit = Retrofit.Builder()  
    .baseUrl("https://your.api.url/v2/");
    .build();

UserService service = retrofit.create(UserService.class);  
service.profilePicture("/profile-picture/path");

// request url results in:
// https://your.api.url/profile-picture/path

第二和第三个例子的不同点就是:我们添加了一个 v2/ 到base url后面并且在结点url的前面添加了一个 / 。实际上这将会最终生成同样的url,因为结点url的前面是一个 / 符号,这个将会只添加到base Url的host上面。当我们在结点url上添加一个前置 / 符号时,每个加到host Url后面的东西都会被省略掉。删除前置 / 有时候可以解决你的一些不明白的问题。

分析提示

正确的“创建”请求url是你需要注意的问题。这些文章中的例子展示了一些容易犯的错误,一不小心就可能陷入这个陷阱中,确保你在请求时使用了一个完全的url(包括scheme,host,path),否则你不得不去考虑上面的这些场景。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,569评论 25 707
  • OKHttp(一)之Calls OKHttp(二)之Connections OkHttp(三)之使用方法 OkHt...
    sakasa阅读 2,675评论 0 15
  • Retrofit用法详解 一、简介 Retrofit是Square公司开发的一款针对Android网络请求的框架,...
    流水潺湲阅读 828评论 0 6
  • 通过iOS 8app extensions,我们可以选择多种方式去分享我们app的功能。Document Prov...
    _浅墨_阅读 7,043评论 4 12