Retrofit教程之【入门篇】


Retrofit已经出了好久了,现在才开始研究,真的是太落后了我,废话不多说了,直接进入主题。

我将由三篇文章来介绍Retrofit的使用以及源码,架构设计方面。如果想直接跳过可以直接传送:

  1. Retrofit教程之【新手入门】篇
  2. Retrofit教程之【深入源码】篇
  3. Retrofit教程之【设计模式】篇

1. 介绍

还不了解Retrofit的可以先去 Retrofit官网 瞧瞧。

Retrofit是采用 RESTfull 的HTTP网络请求框架,内部是基于OkHttpClient的源码进行封装的。
相比较于传统的网络框架,其本质没有区别,只是将网络请求过程的每一步都进行非常缜密的设计并对其封装,这里面涉及了很多设计模式,把网络请求实现真正的解耦,真可谓是把设计模式运用到了极致。

首先在使用之前,需要将Retrofit依赖到项目里:

dependencies {
        implementation 'com.squareup.retrofit2:retrofit:2.9.0'
}

需要注意的是:Retrofit requires at minimum Java 8+ or Android API 21+.

接下来让我们来看看使用Retrofit创建一个网络请求需要分几步:

2. 使用

2.1 声明接口式API

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

2.2 创建Retrofit对象

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

2.3 创建接口实现

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

2.4 调用Call对象发起网络请求

Call<List<Repo>> repos = service.listRepos("octocat");
repos.enqueue(new Callback<List<Repo>>() {
        @Override
        public void onResponse(Call<List<Repo>> call, Response<List<Repo>> response) {
            //成功
        }

        @Override
        public void onFailure(Call<List<Repo>> call, Throwable t) {
            //失败
        }
    });

3. API详细使用

3.1 请求方法

发起一个Get请求只需要在方法上声明@Get注解,另外还支持HTTP, POST, PUT, PATCH, DELETE, OPTIONS、 HEAD。

3.2 URL自定义

我们可以采用 {id}的方式将参数替换到url里面。例如下面:

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

稍微复杂的参数可以使用@QueryMap:

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

3.3 带body的请求

我们也以注解的方式声明一个带具体实体的请求,例如下面:

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

3.4 表单加密和多种请求体

使用@FormUrlEncoded注解来提交表单,表单的数据对应的是在方法参数里面声明的@Field字段,key对应的@Field("first_name"),value就是具体的first字符串内容。

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

带有多类型的请求可以使用@Multipart注解字段来声明,例如:

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

3.5 Header定制化

Header的声明可以直接在方法上使用@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);

注意:

  1. 声明的Header不会互相覆盖。所有的Header有这一样的名字都会被添加到请求里。
  2. 一个请求的Header可以利用@Header注解动态的更改;

另外需要把Header添加到每个请求里可以使用OkHttpBridgeInterceptor来实现。

4. 配置Retrofit

Retrofit是将你的API请求转换成Call对象。所以,Retrofit会给你默认的配置,也允许你自己定制。

Converters(数据转换器)

Converters是在一开始创建Retrofit对象时进行配置的。
Converter的作用就是在数据返回的时候,对数据进行对应格式的转换,减少了我们在拿到数据的时候进行自定义解析时候的麻烦以及bug;

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

GsonConverterFactory是继承自Converter.Factory

public interface Converter<F, T> {
    @Nullable
    T convert(F value) throws IOException;

    abstract class Factory {

    public @Nullable Converter<ResponseBody, ?> responseBodyConverter(
        Type type, Annotation[] annotations, Retrofit retrofit) {
      return null;
  }
    //...
}

Retrofit不仅支持Gson,还支持

  • 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
  • JAXB: com.squareup.retrofit2:converter-jaxb
  • Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

当然,我们也可以自定义Converter。

5. 总结

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

推荐阅读更多精彩内容