27. Retrofit2 -- How to Use Dynamic Urls for Requests

Retrofit
tutorial

最终,Retrofit 2 为动态 url 添加了一个额外的注解。在 Retrofit 1 中,它是一个 hackround[1]。但在 Retrofit 2 中,它是一个注解,用于端点申明。

该节显示了如何在单个请求上使用动态端点 url

用户案例场景


猛然间,你可能一时还想不到需要定义动态端口 url 的场景。那我们就给出两个示例,来说明真实世界的场景。

  1. 个人图片:如果应用允许用户上传个人图片,那么这些图片可能被存储在不同的位置。例如自己的服务器,或其它云存储服务器等。

  2. 文件上传:文件可以被存储在不同的位置,它们需要用任意资源路径,可以灵活的下载。

即使你的应用中没有上述的两个假想的功能,但是,你应该有适当的心态来完成这两个示例。

如何使用动态 Url


其实,对于 Retrofit 2 来说,动态 Url 只需要在端点定义中,添加一个使用 @Url 标注的字符串参数就可以了。简单的代码胜过千言万语,翠花,上代码:

  1. public interface UserService {  

  2. @GET 

  3. public Call<ResponseBody> profilePicture(@Url String url); 



正如你所见,@GET 注解后,没有任何端点信息,而是把 @Url 注解添加到方法本身了。

相对于基本地址,动态 Url 如何解析


这是另外一个值得注意的有趣的事情。Retrofit 2 使用了 OKHttpHTTPUrl,它把每一个端点 Url 都当成了网页上的一个链接(<a href=""></a>)。

让我们看一个例子:一个指向 Amazon S3 个人照片存储的 Url。我们将有两个 Url:一个是基本 Url,一个是个人照片方法使用的动态 Url

  1. Retrofit retrofit = Retrofit.Builder()  

  2. .baseUrl("https://your.api.url/"); 

  3. .build(); 


  4. UserService service = retrofit.create(UserService.class);  

  5. service.profilePicture("https://s3.amazon.com/profile-picture/path"); 


  6. // request url results in: 

  7. // https://s3.amazon.com/profile-picture/path 

因为你设置了完全不同的 hostscheme,因此,OKHttpHTTPUrl 将把方法中的 Url 解析为动态 Url

另一个例子:我们把个人照片的动态 Url 的服务与基本 Url 的服务设置为一致。

  1. Retrofit retrofit = Retrofit.Builder()  

  2. .baseUrl("https://your.api.url/"); 

  3. .build(); 


  4. UserService service = retrofit.create(UserService.class);  

  5. service.profilePicture("profile-picture/path"); 


  6. // request url results in: 

  7. // https://your.api.url/profile-picture/path 

这次,最终的请求 Url 由基本 Url 加上动态定义的端点 Url 所组成。这是因为 HttpUrl 识别出我们并没有定义 schemehost,因此,它会把这两者结合到一起。

第三个例子:假设后端开发者给产品推送了一个更新通知,使用的是上一个例子的知识:

  1. Retrofit retrofit = Retrofit.Builder()  

  2. .baseUrl("https://your.api.url/v2/"); 

  3. .build(); 


  4. UserService service = retrofit.create(UserService.class);  

  5. service.profilePicture("/profile-picture/path"); 


  6. // request url results in: 

  7. // https://your.api.url/profile-picture/path 

第三个例子和第二个例子的不同在于:在基本地址上,我们添加了 v2/,端点地址以 / 开头。因为端点地址以 / 开头,因此,端点地址会与基本地址中的 host 部分结合,也就是与最终的请求网址为:https://your.api.url/profile-picture/path。当端点地址以 / 开头时,基本地址除 host 之外的部分都会被忽略。

观点


你需要注意的是:正确创建请求 Url。本文中的示例显示了一些常见的陷阱,这些陷阱很容易就被触犯。要么确保使用包含 schemehostpath 的完整 Url,要么在使用 Url 前,好好的学习理解下。

我们建议:使用 Retrofit 2 处理 Url 时,要有足够的耐心。


  1. 不知道什么意思。hack around 是美国口语,有闲逛的意思。

27. Retrofit2 -- How to Use Dynamic Urls for Requests的更多相关文章

  1. Retrofit所有知识场景汇总

    https://futurestud.io/blog/retrofit-getting-started-and-android-client Retrofit Series Overview Gett ...

  2. Django Views: Dynamic Content

    世味年来薄似纱,谁令骑马客京华. 小楼一夜听春雨,深巷明朝卖杏花. 矮纸斜行闲作草,晴窗细乳戏分茶. 素衣莫起风尘叹,犹及清明可到家. Your Second View: Dynamic Conten ...

  3. http协议之cookie标准RFC6265介绍

      [Docs] [txt|pdf] [draft-ietf-httpst...] [Diff1] [Diff2] [Errata] PROPOSED STANDARD Errata Exist In ...

  4. Pyhton开源框架(加强版)

    info:Djangourl:https://www.oschina.net/p/djangodetail: Django 是 Python 编程语言驱动的一个开源模型-视图-控制器(MVC)风格的 ...

  5. Python开源框架

    info:更多Django信息url:https://www.oschina.net/p/djangodetail: Django 是 Python 编程语言驱动的一个开源模型-视图-控制器(MVC) ...

  6. Python-aiohttp百万并发

    http://www.aikaiyuan.com/10935.html 本文将测试python aiohttp的极限,同时测试其性能表现,以分钟发起请求数作为指标.大家都知道,当应用到网络操作时,异步 ...

  7. Http,Https (SSL)的Url绝对路径,相对路径解决方案Security Switch 4.2 英文帮助文档 分类: ASP.NET 2014-10-28 10:50 147人阅读 评论(1) 收藏

    Security Switch 4.2 =================== Security Switch enables various ASP.NET applications to auto ...

  8. scrapy代理的设置

    scrapy代理的设置 在我的上一篇文章介绍了scrapy下载器中间件的使用,这里的scrapyIP的代理就是用这个原理实现的,重写了下载器中间件的process_request(self,reque ...

  9. LeetCode 120. Triangle (三角形)

    Given a triangle, find the minimum path sum from top to bottom. Each step you may move to adjacent n ...

随机推荐

  1. 教你u盘中毒后如何恢复被隐藏文件

    方法1: 1)在桌面空白处单击鼠标右键,新建一个文本文档,如下图所示: 2) 然后将下列一段代码拷贝到文档中: for /f "delims=?" %%a in ('dir /a ...

  2. RawCap抓取本地回环接口数据包

    RawCap.exe --help ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 D: ...

  3. 往aws中的s3上传数据

    在官网下载对应的sdk http://aws.amazon.com/cn/sdk-for-net/ 然后再aws上为s3上的bucket生成密钥对 access_key和secret_key 调用对应 ...

  4. Hadoop端口一览表

    Hadoop端口一览表 @(Hadoop) 端口名 用途 50070 Hadoop Namenode UI端口 50075 Hadoop Datanode UI端口 50090 Hadoop Seco ...

  5. subline 配置,本地项目代码下断点来调试远程项目

    参考: https://my.oschina.net/ptk/blog/299464 1. 文件 tts.sublime-project 的配置如下: { "folders": [ ...

  6. 我的Android进阶之旅------&gt;Android实现音乐示波器、均衡器、重低音和音场功能

    本实例来自于<疯狂Android讲义>.要实现详细的功能,须要了解下面API: MediaPlayer  媒体播放器 Visualizer 频谱 Equalizer 均衡器 BassBoo ...

  7. 微信公众平台开发小记(ASP.NET)

    微信的好东西,提供了很大的平台去发挥,公司最近推出微信公众账号,也接触了一些东西, 最终决定用asp.net来开发服务端程序. 微信公众平台的API很简单,利用XML来规范格式,并且所有的数据都在CD ...

  8. flex 布局示例

    <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title> ...

  9. Activity生命周期以及启动模式对生命周期的影响(二)

    前面一篇文章概述了Android四大组件之一的Activity生命周期方法的调用先后顺序,但对于非标准启动模式下Activity被多次调用时的一些生命周期方法并未详细阐述,现在针对该情况着重记录. 现 ...

  10. python中的socket服务器(多线程)

    最近在写一个客户端和服务器的项目,使用了SocketServer模块,网上大多数都是TCP连接的例子,我在这总结一个UDP. 直接贴上代码 import threadingimport SocketS ...