博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
27. Retrofit2 -- How to Use Dynamic Urls for Requests
阅读量:5282 次
发布时间:2019-06-14

本文共 2280 字,大约阅读时间需要 7 分钟。

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

最终,Retrofit 2 为动态 url 添加了一个额外的注解。在 Retrofit 1 中,它是一个 hackround。但在 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.  

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

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

  7.  

  8. // request url results in: 

  9. // 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.  

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

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

  7.  

  8. // request url results in: 

  9. // 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.  

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

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

  7.  

  8. // request url results in: 

  9. // 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 是美国口语,有闲逛的意思。

转载于:https://www.cnblogs.com/wchhuangya/p/6052302.html

你可能感兴趣的文章
《转载》POI导出excel日期格式
查看>>
code异常处理
查看>>
git - 搭建最简单的git server
查看>>
会话控制
查看>>
推荐一款UI设计软件Balsamiq Mockups
查看>>
Linux crontab 命令格式与详细例子
查看>>
百度地图Api进阶教程-地图鼠标左右键操作实例和鼠标样式6.html
查看>>
游标使用
查看>>
LLBL Gen Pro 设计器使用指南
查看>>
SetCapture() & ReleaseCapture() 捕获窗口外的【松开左键事件】: WM_LBUTTONUP
查看>>
Android 设置界面的圆角选项
查看>>
百度地图api服务端根据经纬度得到地址
查看>>
根据xml生成相应的对象类
查看>>
Android StageFrightMediaScanner源码解析
查看>>
springBoot 项目 jar/war打包 并运行
查看>>
HDU 1501 Zipper
查看>>
打包java程序生成exe
查看>>
八叉树
查看>>
poj 1129 搜索
查看>>
Git 远程仓库
查看>>