<译> Retrofit

原文:一种针对 Android 和 Java 的类型安全的 HTTP 代理


简介

Retrofit 可以将 HTTP API 转换为 Java 接口。

public interface GithubService{
    @GET("/user/{user}/repos")
    Call<List<Repo> listRepos(@Path("user") String user);
}

Retrofit 类生成 GitHubService 接口的实现。

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com")
    .build();
    
GitHubService service = retrofit.create(GitHubService.class);

每个 GitHubService 的 Call 方法能进行一个到远程服务器的同步或异步的 HTTP 请求。

Call<List<Repo>> repos = service.listRepos("octocat");

使用注解来描述 HTTP 请求:

  • URL 参数替代和查询参数的支持
  • 将对象转换为请求体(例如:JSON,协议缓冲等)
  • 多部分的请求体和文件上传

注释:这个网页仍然为了新的2.0的API在扩展。

API 声明

接口和其参数上的注解表明了这个请求将被如何处理。

请求方法

每个方法都必须有一个 HTTP 注解用来定义请求方法和相关的 URL。共有五种内置的注解:GET、POST、PUT、DELETE,和 HEAD。相关的 URL 资源定义在注解内。

@GET("/user/list")

你也可以在 URL 中定义查询参数。

@GET("/user/list?sort=desc")

URL 处理

请求 URL 可以通过使用方法中的替换区块和参数来动态更改。替换区块是指被 { 和 } 包围的字母数字串。合适的参数必须以相同的字符串的@Path 注解来标识。

@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId);

也可以添加查询参数。

@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId, @Query("sort") String sort);

对于复杂的查询条件可以使用 Map。

@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);

请求体

通过 @Body 注解来声明一个对象可以用作 HTTP 请求体。

@POST("/users/new")
Call<User> createUser(@Body User user);

该对象会被定义在 Retrofit 实例中的转换器转换。如果没有已添加的转换器,那么只有 RequestBody 可以被用于请求体。

实在翻译不下来了,以后再尝试吧。

初次翻译,好

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 整体Retrofit内容如下: 1、Retrofit解析1之前哨站——理解RESTful2、Retrofit解析2...
    隔壁老李头阅读 15,071评论 4 39
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,999评论 25 707
  • 本文翻译自https://futurestud.io/tutorials/retrofit-getting-sta...
    sakasa阅读 18,463评论 3 54
  • 今天我们来聊一聊Java的动态代理模式,这个在很多开源库中用的比较多的。要讲到动态代理我们要先简单讲下静态代理,一...
    juexingzhe阅读 3,794评论 1 24