入门Retrofit，看这一篇就够了

柔光的暖阳◎ 2021-12-22 16:11 665阅读 0赞

文章目录

      • Retrofit介绍
      • 基础使用步骤
        • 添加依赖
        • 声明网络权限
        • 创建用于配置网络请求的接口
        • 创建Retrofit实例并发起网络请求
      • Retrofit使用详解
        • 请求方法
        • URL操作
        • 请求体
        • 标记注解
        • Header操作
        • 同步请求和异步请求
        • 转换器(converters)
        • 网络请求适配器(CallAdapter)
      • 总结

Retrofit介绍

image-20190629194940746

Retrofit是Square公司开发的一款针对Android和java的网络请求框架，遵循Restful设计风格，底层基于OkHttp。

Retrofit具有以下主要功能：

  1. 支持同步/异步网络请求
  2. 支持多种数据的解析&序列化格式(Gson、json、XML等等)
  3. 通过注解配置网络请求参数
  4. 提供对Rxjava的支持高度解耦,使用方便

相比去其他网络请求框架，其具有性能特别棒、使用特别方便的特性，所以在任何网络请求场景下，我们都应该有限考虑Retrofit，本文就Retrofit的入门使用和简单特性做简单介绍，抛砖引玉，希望大家可以爱上Retrofit。

基础使用步骤

我们首先通过一个简单的案例带大家走一遍使用Retrofit的完整流程，然后再深入介绍Retrofit的一些特性。

我们要做的就是在Android中使用Retrofit发起网络请求，将下图（图片地址：/images/20211220/44afec257e7f4ec7ba82cedcd2b9740e.png）下载并展示出来，下面我来一步一步介绍如何去做。

Retrofit-logo

添加依赖

在Gradle文件中添加如下依赖：

  1. implementation 'com.squareup.retrofit2:retrofit:2.6.0'

声明网络权限

在Android的manifest配置文件中声明网络请求权限：

  1. <uses-permission android:name="android.permission.INTERNET"/>

创建用于配置网络请求的接口

Retrofit将 Http请求抽象成 Java接口，采用注解来描述配置网络请求参数，何为配置网络请求参数？说白了就是设置网络请求的地址是什么、使用什么请求方法、传递的参数是什么、返回值类型是什么等等一系列配置信息，通过接口描述清楚这些具体的网络配置信息，Retrofit才能根据你的配置发起最终的网络请求。所以我们首先应该声明一个用于配置网络请求的Java接口：

  1. /**
  2.  * @author dmrfcoder
  3.  * @date 2019-06-29
  4.  */
  6. public interface GetRequestInterface {
  8.     /**
  9.      *
  10.      *
  11.      * 通过get（）方法获取图片的请求接口
  12.      * GET注解中的参数值"2019-06-29-121904.png"和Retrofit的base url拼接在一起就是本次请求的最终地址
  13.      *
  14.      * @return
  15.      *
  16.      */
  17.     @GET("2019-06-29-121904.png")
  18.     Call<ResponseBody> getPictureCall();
  19. }

创建Retrofit实例并发起网络请求

这里直接给出代码，重点都在注释中：

  1. public void retrofitGet() {
  3.         /*
  4.          创建Retrofit对象，这里设置了baseUrl，注意我们在声明网络配置接口GetRequestInterface的时候在GET注解中也声明了一个Url，
  5.          我们将会这里的baseUrl和GET注解中设置的Url拼接之后就可以形成最终网络请求实际访问的url
  6.          */
  7.         Retrofit retrofit = new Retrofit.Builder().baseUrl("http://picture-pool.oss-cn-beijing.aliyuncs.com/").build();
  9.         //创建网络请求配置的接口实例
  10.         GetRequestInterface getRequestInterface = retrofit.create(GetRequestInterface.class);
  11.         //调用我们声明的getPictureCall（）方法创建Call对象
  12.         Call<ResponseBody> requestBodyCall = getRequestInterface.getPictureCall();
  13.         //使用requestBodyCall发起异步网络请求
  14.         requestBodyCall.enqueue(new Callback<ResponseBody>() {
  16.             @Override
  17.             public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
  19.                 //将网络请求返回的数据解析为图片并展示到界面
  20.                 ResponseBody body = response.body();
  21.                 InputStream inputStream = body.byteStream();
  22.                 Drawable drawable = Drawable.createFromStream(inputStream, "pic.png");
  23.                 imageView.setBackground(drawable);
  24.                 Log.e(TAG, "网络请求成功");
  26.             }
  28.             @Override
  29.             public void onFailure(Call<ResponseBody> call, Throwable t) {
  31.                 Log.e(TAG, "网络请求失败，失败原因：" + t.getMessage());
  32.             }
  33.         });
  36.     }

如果使用过OkHttp的读者可能很熟悉最后两步创建Call对象、发起异步网络请求的操作，几乎和OkHttp一模一样，这是因为Retrofit就是基于OkHttp的啊~~

最终效果如下：

y9n0y-1vqyi

细心的读者可能发现了一个问题，在上面的代码中我是直接在CallBack接口的onResponse()回调方法中更新的ImageView，即在onResponse()中更新UI的，在OkHttp中这个onResponse()方法是在子线程中被调用的，而在Retrofit中，onResponse()和onFailure（）这两个回调方法都是在主线程进行调用的，所以可以在其中直接更新UI，这也是Retrofit和OkHttp的一点不同之处。

Retrofit使用详解

通过上面的例子带大家走了一遍Retrofit的整体流程，让大家对Retrofit有了一个整体的感知，接下来我们来逐步深入了解一下Retrofit的具体使用。

请求方法

每一个方法都必须有一个HTTP注解，用来提供网络请求的请求方法以及相对URL。在Retrofit中可以使用五种请求方法：GET,POST,PUT,DELETE,HEAD，而相对URL直接在对应注解中填写即可，比如：

  1. @GET("users/list")//表示以GET请求方法发起网络请求，子URL为：users/list

你可以在URL中直接指定查询的参数：

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

URL操作

网络请求的URL可以通过结合占位符和方法中的参数的方式来进行动态更新，所谓的占位符指的是URL中由{}包裹的String类型字符串，而参数必须使用@Path注解进行修饰，而且也只能是String，这样，@Path修饰的变量会动态对应到URL中，比如：

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

如上面的代码所示，当代码运行的时候，groupId会被动态绑定到子URL中{id}所占的位置上，达到动态设置URL的作用。

查询参数也可以使用类似的方法进行设置：

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

如果查询参数太多，还可以使用Map：

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

请求体

我们可以通过@Body注解将一个对象以 Post方式发送给服务器：

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

标记注解

当我们想发送form-encoded的数据时，可以使用@FormUrlEncode注解，将每个键值对中的键使用@Filed注解来进行说明，而值设置为随后跟随的对象：

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

当我们想发送Multipart的数据时（适用于文件发送的场景），可以使用@Multipart注解，时使用，将每个键值对中的键使用@Part注解来进行说明，而值设置为随后跟随的对象：

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

Header操作

你可以通过使用@Headers注解为请求方法设置静态请求头：

  1. @Headers("Cache-Control: max-age=640000")
  2. @GET("widget/list")
  3. Call<List<Widget>> widgetList();

或者像这样：

  1. @Headers({
  3.     "Accept: application/vnd.github.v3.full+json",
  4.     "User-Agent: Retrofit-Sample-App"
  5. })
  6. @GET("users/{username}")
  7. Call<User> getUser(@Path("username") String username);

注意，请求头中不会进行覆盖，即如果你设置两个相同键的请求头，这两个请求头都会被发送。

请求头可以使用@Header进行动态更新，前提是设置了合法的请求头，如果你设置了类型为null的请求头，那么对应的请求头会被忽略，如果不为null，将最终会发送你设置参数的toString（）结果。

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

和查询参数的设置方法类似，当请求头的参数过于复杂时，你也可以使用Map：

  1. @GET("user")
  2. Call<User> getUser(@HeaderMap Map<String, String> headers)

同步请求和异步请求

Call实例可以使用同步和异步两种方式进行执行，每一个实例都仅仅只能被执行一次，但是，你可以通过调用clone()方法拷贝一份新的、同样的Call实例，以达到多次请求的目的。

在Android中，Call的回调接口会在主线程中执行，在JVM中，回调接口会在发起请求的当前线程中执行。

转换器(converters)

默认情况下，Retrofit只能反序列化OkHttp中的ResponseBody类型的返回值，通过添加不同类型的转换器可以使Retrofit拥有反序列化其他主流序列的能力，以下是一些常用转换器的列表：

  1. Gson：com.squareup.retrofit2:converter-gson
  2. Jackson：com.squareup.retrofit2:converter-jackson
  3. Moshi：com.squareup.retrofit2:converter-moshi
  4. Protobuf：com.squareup.retrofit2:converter-protobuf
  5. Wire：com.squareup.retrofit2:converter-wire
  6. Simple XML：com.squareup.retrofit2:converter-simplexml

下面是一个使用GsonConverterFactory类反序列化GithubService返回结果的例子：

  1. Retrofit retrofit = new Retrofit.Builder()
  2.     .baseUrl("https://api.github.com")
  3.     .addConverterFactory(GsonConverterFactory.create())
  4.     .build();
  6. GitHubService service = retrofit.create(GitHubService.class);

网络请求适配器(CallAdapter)

Retrofit支持多种网络请求适配器方式：guava、Java8和rxjava

使用时如使用的是 Android 默认的 CallAdapter，则不需要添加网络请求适配器的依赖，否则则需要按照需求进行添加 Retrofit 提供的 CallAdapter，对应依赖为：

  1. guava ：com.squareup.retrofit2:adapter-guava:x.x.x
  2. Java8：com.squareup.retrofit2:adapter-java8:x.x.x
  3. rxjava：com.squareup.retrofit2:adapter-rxjava:x.x.x

这里使用rxjava来发起之前例子中的网络请求：

首先修改网络请求的接口：

  1. public interface GetRequestInterfaceWithRxJava {
  3.     /**
  4.      * 通过get（）方法获取图片的请求接口
  5.      * GET注解中的参数值"2019-06-29-121904.png"和Retrofit的base url拼接在一起就是本次请求的最终地址
  6.      *
  7.      设置返回值类型为Observable的
  8.      * @return
  9.      */
  10.     @GET("2019-06-29-121904.png")
  11.     Observable<ResponseBody> getPictureCall();
  12. }

然后使用RxJava发起网络请求：

  1. public void retrofitGetWithRxJava() {
  3.         /*
  4.          创建Retrofit对象，这里设置了baseUrl，注意我们在声明网络配置接口GetRequestInterface的时候在GET注解中也声明了一个Url，
  5.          我们将会这里的baseUrl和GET注解中设置的Url拼接之后就可以形成最终网络请求实际访问的url
  6.          */
  7.         Retrofit retrofit = new Retrofit.Builder().baseUrl("http://picture-pool.oss-cn-beijing.aliyuncs.com/").addCallAdapterFactory(RxJava2CallAdapterFactory.create()).build();
  9.         //创建网络请求配置的接口实例
  10.         GetRequestInterfaceWithRxJava getRequestInterfaceWithRxJava = retrofit.create(GetRequestInterfaceWithRxJava.class);
  11.         //调用我们声明的getPictureCall（）方法创建Call对象
  12.         Observable<ResponseBody> requestObservable = getRequestInterfaceWithRxJava.getPictureCall();
  13.         requestObservable.subscribeOn(Schedulers.io()).observeOn(AndroidSchedulers.mainThread()).subscribe(new Observer<ResponseBody>() {
  15.             @Override
  16.             public void onSubscribe(Disposable d) {
  18.                 Log.e(TAG, "onSubscribe");
  19.             }
  21.             @Override
  22.             public void onNext(ResponseBody body) {
  24.                 //将网络请求返回的数据解析为图片并展示到界面
  25.                 InputStream inputStream = body.byteStream();
  26.                 Drawable drawable = Drawable.createFromStream(inputStream, "pic.png");
  27.                 imageView.setBackground(drawable);
  28.                 Log.e(TAG, "网络请求成功");
  30.             }
  32.             @Override
  33.             public void onError(Throwable e) {
  35.                 Log.e(TAG, "onError:" + e.getMessage());
  36.             }
  38.             @Override
  39.             public void onComplete() {
  41.                 Log.e(TAG, "onComplete");
  42.             }
  43.         });
  46.     }

运行效果和之前的代码一样：

y9n0y-1vqyi

总结

本文介绍了Retrofit的基本使用和常用API，希望可以帮大家对Retrofit有一个入门的认识，后面我会推出有关Retrofit源码分析等一系列文章，欢迎大家关注。

发表评论

表情：
评论列表 （有 0 条评论，665人围观）

还没有评论，来说两句吧...

相关阅读