#Android# Retrofit使用指南

知识框架(脑图)

Retrofit脑图

出现背景

移动端网络请求复杂,代码冗余

解决思路

Retrofit:给Android和Java用的类型安全的HTTP客户端,将网络请求抽象成接口,以注解形式定义HTTP请求,Retrofit会自动生成对应的实现供开发人员调用。

Retrofit设计思路

具体步骤

(1)添加网络访问权限并引入依赖库

<uses-permission android:name="android.permission.INTERNET"/>
compile 'com.squareup.retrofit2:retrofit:2.1.0'

(2)使用注解定义网络访问的API

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

有哪些注解呢?

  • URL参数和Query参数
  • 对象到请求体的转换(eg : JSON,protocol buffers)
  • 表单提交和文件上传
Retrofit中的注解

(3)使用Retrofit生成该接口的一个实现

使用Builder构建一个Retrofit,并调用Retrofit的create方法创建一个接口实现。构建的时候需要提供baseUrl,而接口定义时使用相对路径即可。

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .addConverterFactory(GsonConverterFactory.create()) //这里使用Gson转换器,需要添加相应依赖,见问题1
    .build();

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

(4)调用实现的方法来进行同步或异步的HTTP请求

Call<List<Repo>> repos = service.listRepos("octocat");
// 同步请求
List<Repo> repoList = repos.execute().body();
// 异步请求
repos.enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
    }
    @Override
    public void onResponse(Call call, Response response) throws IOException {
        // response.body().string();
    }
});

调用接口方法之后返回的是Call对象,可以被异步或同步执行,每个实例只能使用一次,当然可以使用clone()造一个新的来用。还可以通过cancle方法取消Call~

在Android,回调会在主线程执行;而在JVM,回调会在发起HTTP请求的线程执行;这是自动完成的!!

(5)进阶:操作URL

使用替换块和方法中的参数动态地更新请求的URL。替换块的组成:用花括号包裹起来的仅含字母数字的字符串;而参数需要使用@Path注解和相同的字符串。例如:

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

也可以使用@Query注解添加查询参数,如:

@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);

(6)进阶:请求体

对象可以作为HTTP的请求体(使用@Body注解),也可以使用转换器转成特定的字符串,比如JSON。

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

(7)进阶:表单提交和文件上传

使用@FormUrlEncoded标明是表单上传的方法,然后每一个键值对使用@Field关联:

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

使用@Multipart标明是文件上传的方法,然后使用@Part分隔各个部分:

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

(8)进阶:操作请求头

使用@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动态修改请求头,如果值是null,那么该头部会被清除;还有toString方法会被调用。

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

(9)进阶:Retrofit配置转换器

为什么要配置转换器?

Retrofit已经不提供给默认的转换器了,需要相应的转换器,比如要用Gson解析的话就需要添加依赖并使用addConverterFactory方法在构建Retrofit时配置好。

有哪些转换器可以用?

  • 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

怎么添加转换器?

使用addConverterFactory方法

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

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

Q&A

问题1:IllegalArgumentException: Unable to create converter for class...

Retrofit已经不提供给默认的转换器了,需要相应的转换器比如要用Gson解析的话就需要添加依赖:

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

然后构建Retrofit时使用该转换器:

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

值得注意的是:JSON Converter要放置在最后,因为没有确切的条件可以判定一个对象是否是JSON对象

参考文档

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

推荐阅读更多精彩内容