Retrofit2.1官方文档的翻译

前言:

对于Retrofit也是刚开始接触,Retrofit 的使用也并没有太多的心得,网上有很多关于Retrofit的介绍,但是在我看来先从官方文档开始学习不失是一个好的选择。


Retrofit

官方文档地址:http://square.github.io/retrofit/

一种针对android和java的类型安全的http客户端。

Introduction

Retrofit 将http API 装换成 一个java interface。

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

Retrofit 类 生成一个 GitHubService interface 的实例。

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

GitHubService service = retrofit.create(GitHubService.class);

每一个 Call 都要生成一个 同步或异步的http请求到远程web服务器。

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

使用注解来描述http请求(包括):

  • 支持 替换URL参数 以及 查询参数的添加
  • 支持 将整个对象转换成 request body
  • Multipart 请求体 和 文件上传

API Declaration

通过对 interface 的方法及其参数进行注解来表示将执行一次怎样的请求。

1.REQUEST METHOD

每一个方法都必须有一个由 请求方式 及其相对应的URL 组成的http注解。提供了5种注解方式:GET, POST, PUT, DELETE, 和 HEAD 。注解中指定对应的URL。

@GET("users/list")

URL中也可以指定查询参数。

@GET("users/list?sort=desc")
2.URL MANIPULATION

可以通过方法中的可替换参数动态修改请求的URL。可替换部分可以由大括号加上字母来表示(例如:{id})。相应的参数则必须由 @Path 并使用相同的字母串来注释出。

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

查询参数也可以被添加。

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

对于复杂的查询参数 可以直接组合成一个 Map 来添加。

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

可以直接指定一个对象(例子中的User)作为http 的 请求体,用@Body 来注解。

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

该对象(例子中的User)将通过指定的converter(转换器)转换成 Retrofit 实例。在不添加 converter(转换器)的情况下,只有 RequestBody 可以使用。

4.FORM ENCODED AND MULTIPART

方法也可以通过声明去发送 form-encoded 和 multipart 数据。方法在添加 @FormUrlEncoded 后才可以发送 Form-encoded 数据。而参数的注解要用 @Field 来完成,以 key-value的形式,包含 命名 以及 所要上传的值。

@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

方法 在添加 @FormUrlEncoded 后可以发送 Multipart 请求。方法参数要用 @Part 注解来声明。

@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
5.HEADER MANIPULATION

可以使用 @Headers 来为 方法设置静态的header。

@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call<List<Widget>> widgetList();
@Headers({
    "Accept: application/vnd.github.v3.full+json",
    "User-Agent: Retrofit-Sample-App"
})
@GET("users/{username}")
Call<User> getUser(@Path("username") String username);

注意:header 之间不会互相覆盖。具有相同名称的所有 header 将会被包括到请求中。

一个请求的header 可以使用 @Header 来动态的修改,相应的参数必须要用@Header来提供。如果value 为 null,header会被忽略;除此之外,将对参数做toString处理后,使用处理后的结果。

@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)

每一个请求都需要添加 header的时候可以使用 OkHttp 的 interceptor 来指定。

6.SYNCHRONOUS VS. ASYNCHRONOUS

Call 实例 是可以 同步或异步执行的。每个实例是只能执行一次的,但调用clone() 方法 可以重新创建一个新的可使用的实例。
在Android系统中,回调会被执行在主线程中。而在java虚拟机中,回调会在http请求发生的线程中被执行。

Retrofit Configuration

Retrofit 是 将你的API 接口都转换成可调用对象的 class。默认情况下,Retrofit设置好的平台是相当不错的,但其也允许自定义定制。

CONVERTERS

默认情况下,Retrofit只会反序列化 HTTP 的bodies 为 OKHTTP 的 ResponseBody类型,并且@Body 注解 也只接受 ResponseBody类型。

Converters 可以被添加支持其他的类型。

  • Gson: com.squareup.retrofit2:converter-goon
  • Jackson: com.squareup.retrofit2:converter-jackson
  • Moshi: com.squareup.retrofit2:converter-mosh
  • Protobuf: com.squareup.retrofit2:converter-protobuf
  • Wire: com.squareup.retrofit2:converter-wire
  • Simple XML: com.squareup.retrofit2:converter-simplexml
  • Scalars (primitives, boxed, and String):
  • com.squareup.retrofit2:converter-scalars

下面有一个例子:
使用GsonConverterFactory类生成 GitHubService 接口的实例化,并支持Gson 反序列化数据。

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com")
    .addConverterFactory(GsonConverterFactory.create())
    .build();

GitHubService service = retrofit.create(GitHubService.class);
CUSTOM CONVERTERS

话太长不翻译了,大体意思就是:如果你不想使用Retrofit提供的converter,可以自定义一个以实现想要的效果。当你在创建一个adapter(适配器)的时候, 创建一个class 并 extends Converter.Factory class ,给adapter传递一个该类的实例就行。

GRADLE
compile 'com.squareup.retrofit2:retrofit:2.1.0'
PROGUARD

如果项目中添加了混淆,就把下面的文字添加到混淆文件中举行:

# Platform calls Class.forName on types which do not exist on Android to determine platform.
-dontnote retrofit2.Platform
# Platform used when running on RoboVM on iOS. Will not be used at runtime.
-dontnote retrofit2.Platform$IOS$MainThreadExecutor
# Platform used when running on Java 8 VMs. Will not be used at runtime.
-dontwarn retrofit2.Platform$Java8
# Retain generic type information for use by reflection by converters and adapters.
-keepattributes Signature
# Retain declared checked exceptions for use by a Proxy instance.
-keepattributes Exceptions
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,607评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,239评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,960评论 0 355
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,750评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,764评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,604评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,347评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,253评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,702评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,893评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,015评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,734评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,352评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,934评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,052评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,216评论 3 371
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,969评论 2 355

推荐阅读更多精彩内容