Retrofit

有道翻译的Retrofit官方文档需要翻墙才能看~

一:定义:

用于Android和Java的类型安全HTTP客户机

二:介绍

1.改进将您的HTTP API转换为Java接口。

public interface GitHubService{

    @GET("users/{user}/repos")

   Call<List<Pro> listRepos(@Path("user") String user);

}

2.Retrofit类生成一个GitHubService接口的实现。

Retrofit retrofit=new Retrofit.Builder()

     .baseUrl("https://api.github.com/")

     .build();

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

3.来自创建的GitHubService的每个调用都可以向远程web服务器发出同步或异步的HTTP请求。

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

4.使用注释来描述HTTP请求:

URL参数替换和查询参数支持

对象转换为请求主体(例如、JSON、协议缓冲区)

多部件请求体和文件上传

三:API声明:

接口方法及其参数上的注释指示如何处理请求。

1.请求方法:

每个方法都必须有一个提供请求方法和相对URL的HTTP注释。有5个内置注释:GET、POST、PUT、DELETE和HEAD。该资源的相对URL是在注释中指定的。

@GET("users/list")

您还可以在URL中指定查询参数。

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

2.URL操作:

可以使用该方法的替换块和参数动态地更新请求URL。替换块是由字母和数字包围的字母数字字符串。一个相应的参数必须使用相同的字符串对@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);

对于复杂的查询参数组合,可以使用映射。

@GET("group/{id}/users")

Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String,String> options);

3.请求体

可以指定一个对象作为一个带有@body注释的HTTP请求体。

@POST("users/new")

Call<User> createUser(@Body User user);

该对象还将使用Retrofit实例中指定的转换器进行转换。如果不添加任何转换器,则只能使用RequestBody。

4.表单编码和多部分

方法也可以被声明为发送表单编码和多部分数据。

表单编码的数据是在该方法上出现@formurlen编码时发送的。每个键值对都带有@field的注释,其中包含名称和提供该值的对象。

@FormUrlEncoded

@POST("user/edit")

Call<User> updateUser(@Field("first_name")String first,@Field("last_name")String last);

当@multi部件出现在该方法时,将使用多部件请求。部分是使用@part注释声明的。

@Multipart

@PUT("user/photo")

Call<User> updateUser(@Part("photo") RequestBody photo,@Part("description") RequestBody description);

多部件部件使用一个Retrofit转换器,或者他们可以实现请求体来处理他们自己的序列化。

5.头操作

您可以使用@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。如果值为null,则将省略头。否则,toString将调用该值,并使用该结果。

@GET("user")

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

需要添加到每个请求的头信息都可以使用OkHttp拦截器来指定。

6.同步或异步

调用实例可以同步或异步执行。每个实例只能使用一次,但是调用克隆()将创建一个可以使用的新实例。

在Android上,回调将在主线程上执行。在JVM上,回调将发生在执行HTTP请求的同一线程上。

四:要改装配置

Retrofit是将您的API接口转化为可调用对象的类。默认情况下,Retrofit会为你的平台提供合理的默认值,但它允许定制。

1.转换器

默认情况下,Retrofit只能将HTTP主体反序列化为OkHttp的ResponseBody类型,并且只能接受它的请求体类型为@body。

可以添加转换器来支持其他类型。为了方便,6个兄弟模块调整了流行的序列化库。

Gson:com.squareup.retrofit2:converter-gson

Jackson:com.squareup.retrofit2:converter-jackson

Moshi:com.squareup.retrofit2:converter-moshi

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进行反序列化。

Retrofitretrofit=newRetrofit.Builder()

    .baseUrl("https://api.github.com")

   .addConverterFactory(GsonConverterFactory.create()

    .build();

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

2.自定义转换器

如果您需要使用一个API,该API使用的内容格式并不支持box(例如YAML、txt、定制格式),或者您希望使用不同的库来实现现有的格式,那么您可以轻松地创建自己的转换器。创建一个扩展转换器的类。工厂类,并在构建适配器时传入一个实例。

五:应用?


以下为我项目中的应用

Retrofit

compile'com.squareup.retrofit2:retrofit:2.2.0'

compile'com.squareup.retrofit2:converter-gson:2.2.0'

compile'com.squareup.retrofit2:adapter-rxjava:2.2.0'

compile'com.squareup.retrofit2:converter-scalars:2.2.0'

具体应用查看:你真的会用Retrofit2吗?Retrofit2完全教程

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

推荐阅读更多精彩内容

  • 简介 刚接触Retrofit的时候,就写了一篇简单的使用介绍:Retrofit 2.0基本使用方法,算是对Retr...
    Whyn阅读 2,844评论 4 24
  • 写在前面## 其实一直都没有写博客的习惯,借着这次公司内部分享的机会,开始写博客,希望以后渐渐养成习惯。也方便以后...
    seph_von阅读 882评论 0 1
  • Retrofit详解 在目前的开发环境下,相信Retrofit这个词大家已经非常熟悉了,就像之前volley刚出来...
    OpenCoder阅读 5,790评论 0 10
  • 说好每天要看书的,说好一天写点东西的。自己确实对待别人的态度不太好,今天。无论怎样,不要发脾气,不要自寻烦恼。看奇...
    柠檬安然阅读 269评论 0 0
  • 有些人光是遇见 就已经很开心了
    FAB小钟钟阅读 125评论 0 0