Retrofit介绍

Retrofit

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

源码和例子,Github地址:https://github.com/square/retrofit

一个Android和Java上HTTP库(利用注解和okhttp来实现和服务器的数据交互)。

介绍

Retrofit将网络请求API转换为一个Java 接口。

public interface MovieService {
    @GET("top250")
    Call<MovieEntity> getTopMovie(@Query("start") int start, @Query("count") int count);
}

Retrofit生成一个MovieService的接口实现。

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

MovieService movieService = retrofit.create(MovieService.class);

MovieService可以创建一个同步或者异步的远程服务器请求:Call

Call<MovieEntity> topMovie = movieService.getTopMovie(0, 1);

使用注解来描述HTTP请求:

  • 支持URL参数替换和查询。
  • 将对象转化为一个Request Body(例如:JSON、协议缓冲区)。
  • 多部分Request Body和文件上传。

API介绍

为接口的方法添加注解,其参数指明这个请求如何操作。

请求方法

每个方法必须含有HTTP注解(请求方法和相对URL地址)。有5个内置的注解:GET, POST, PUT, DELETE, and HEAD。相对URL地址在注解中指定。

@GET("top250")

同样,可以在URL上指定查询参数。

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

URL操作

一个请求的URL可以使用替换块和参数来进行URL的动态的替换。替换块的格式:{字符串}。需要替换的部分需要使用相同的字符串和@Path注解。

@GET("{type}250")
Call<MovieEntity> getTopMovie(@Path("type") String type,@Query("start") int start, @Query("count") int count);

同样可以添加查询参数

@GET("top250")
Call<MovieEntity> getTopMovie(@Query("start") int start, @Query("count") int count);

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

@GET("{type}250")
Call<MovieEntity> getTopMovie(@Path("type") String type,@QueryMap Map<String,Integer> options);

Map<String,Integer> options = new HashMap<>();
options.put("start",1);
options.put("count",2);
Call<MovieEntity> topMovie = movieService.getTopMovie("top",options);

请求主体

使用@Body可以将一个对象作为HTTP的请求主体。

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

指定的对象将使用"Retrofit"指定的转换器进行转换。如果没有添加转换器,就只可以使用RequestBody

FORM ENCODED 和 MULTIPART

方法同样可以声明表单编码和复合数据。

表单编码数据发送当存在@FormUrlEncoded注解。每个键值对的key为@Filed的部分,Value为Object。

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

使用@Multipart来实现Multipart的请求。使用@Part注解来声明内容。

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

Multipart parts使用Retrofit的转换器,或者实现RequestBody

请求头操作

使用@Headers来设置请求头。

@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,头就会被忽略掉。另外,valeu会进行toString

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

如果请求头需要应用在每个请求上,请使用'OkHttp interceptor'

同步和异步

每个Call实例可以执行同步或者异步请求。每个实例只能使用一次,但是可以使用clone()方法创建一个新的实例来操作。

在Android中,callback会在UI线程中执行,在JVM上,callback会在请求执行的线程上执行。

Retrofit的配置

Retrofit是一个将HTTP的API接口转化为可被调用的对象的类。默认的,Retrofit提供默认的配置,当然,你可以自定义。

转换器

默认情况下,Retrofit只能反序列化HTTP的主体到okhttpResponseBody,并且@Body注解只能接收RequestBody的类型数据。

转换器可以被添加来支持其它类型。下面是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

例子:生成一个使用Gson反序列的API接口实现类,通过GsonConverterFactory转换器。

Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(baseUrl)
            .addConverterFactory(GsonConverterFactory.create())
            .build();

自定义转换器

Create a class that extends the Converter.Factory class and pass in an instance when building your adapter.

混淆器

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

推荐阅读更多精彩内容