26、Android--Retrofit

2023-12-14 13:08:45

Retrofit

Retrofit是OkHttp的加强版，是一个RESTful的网络加载框架。底层是实用OkHttp封装的。

App应用程序通过 Retrofit 请求网络，实际上是使用 Retrofit 接口层封装请求参数、Header、Url 等信息，之后由 OkHttp 完成后续的请求操作。

在服务端返回数据之后，OkHttp 将原始的结果交给 Retrofit，Retrofit根据用户的需求对结果进行解析。

OkHttp的大致流程如下所示：

基本用法

请求方式

在gradle中添加如下配置依赖retrofit

implementation "io.reactivex.rxjava2:rxjava:2.1.13"
implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'
implementation 'com.squareup.retrofit2:retrofit:2.4.0'
implementation 'com.squareup.retrofit2:converter-gson:2.2.0'
implementation 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'
implementation 'com.google.code.gson:gson:2.8.3'

不要忘记添加网络访问权限：

使用Retrofit之前，我们需要定义一个接口，用来返回Call对象，我们来演示一个简单的GET请求：

public interface APIService {
    @GET("users")
    Call<List<User>> getUsers();
}

通过@GET和@POST注解来标准是GET或POST请求，其中@GET中所填写的value和retrofit对象构造时的baseUrl拼接成完整的路径。

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://localhost:8080/")
        .addConverterFactory(GsonConverterFactory.create())
        .build();
APIService apiService = retrofit.create(ApiService.class);
Call<List<User>> call = apiService.getUsers();
call.enqueue(new Callback<List<User>>() {
    @Override
    public void onResponse(Call<List<User>> call, Response<List<User>> response) {
        System.out.println("Request Sucess：" + response.body());
    }
    @Override
    public void onFailure(Call<List<User>> call, Throwable t) {
        System.out.println("Request Faild：" + t.toString());
    }
});

通过构建者模式，指定baseUrl和Converter.Factory，由于上面的基于对象转换的，所以使用GsonConverterFactory完成对象转换，其他的请参考包名导入处。

注意：call.enqueue()是异步访问数据的方式，同步的方式是call.execute()。

注解说明

网络请求方法

@GET、@POST、@PUT、@DELETE、@HEAD方法分别对应HTTP中的网络请求方式

public interface APIService{
    @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
    Call<Translation>  getCall();
    // @GET注解的作用:采用Get方法发送网络请求
    // getCall() = 接收网络请求数据的方法
    // 其中返回类型为Call<*>，*是接收数据的类（即上面定义的Translation类）
    // 如果想直接获得Responsebody中的内容，可以定义网络请求返回值为Call<ResponseBody>
}

Retrofit把网络请求的URL 分成了两部分设置：

// 第1部分：在网络请求接口的注解设置
 @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
Call<Translation>  getCall();
// 第2部分：在创建Retrofit实例时通过.baseUrl()设置
Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") //设置网络请求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) //设置数据解析器
                .build();
// 从上面看出：一个请求的URL可以通过 替换块 和 请求方法的参数 来进行动态的URL更新。
// 替换块是由 被{}包裹起来的字符串构成
// 即：Retrofit支持动态改变网络请求根目录

网络请求的完整 Url =baseUrl() + 网络请求接口的注解设置。

@HTTP的作用是替换@GET、@POST、@PUT、@DELETE、@HEAD..注解，通过属性method、path、hasBody来设置

public interface APIService{
    /**
        method：网络请求的方法（区分大小写）
        path：网络请求地址的路径
        hasBody：是否有请求体
    */
    @HTTP(method = "GET", path = "blog/{id}, hasBody = false")
    Call<ResponseBody> getCall(@Path("id") int id);
}

网络请求方法

Retrofit中的标记注解如下图所示：

a、@FormUrlEncoded：表示发送form-encoded的数据

每一个键值对需要用@Field来注解键名，随后的对象需要提供值。

b、@Multipart：表示发送form-encoded的数据（适用于文件上传的场景）

每个键值对需要用@Part来注解键名，随后的对象需要提供值。

具体使用方法如下：

public interface APIService {
        /**
         *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
         * Field("username")表示将后面的String name 中name的取值作为 username 的值
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);
         
        /**
         * {@link Part} 后面支持三种类型，{@link RequestBody}、{@link okhttp3.MultipartBody.Part} 、任意类型
         * 除 {@link okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段({@link okhttp3.MultipartBody.Part} 
         * 中已经包含了表单字段的信息)，
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);
}
// 具体使用
APIService service = retrofit.create(APIService.class);
// @FormUrlEncoded 
Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);
//  @Multipart
RequestBody name = RequestBody.create(textType, "Carson");
RequestBody age = RequestBody.create(textType, "24");
MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
Call<ResponseBody> call2 = service.testFileUpload1(name, age, filePart);

网络请求参数

Retrofit中网络请求参数如下所示：

a. @Header & @Headers：添加请求头 &添加不固定的请求头

// @Header
@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)
// @Headers
@Headers("Authorization: authorization")
@GET("user")
Call<User> getUser()
// 以上的效果是一致的。
// 区别在于使用场景和使用方式
// 1. 使用场景：@Header用于添加不固定的请求头，@Headers用于添加固定的请求头
// 2. 使用方式：@Header作用于方法的参数；@Headers作用于方法

b. @Body：以Post方式传递自定义数据类型给服务器，如果提交的是一个Map，那么相当于@Field

FormBody.Builder builder = new FormBody.Builder();
builder.add("key","value");

c. @Field & @FieldMap：发送Post请求时提交请求的表单字段，与@FormUrlEncoded注解配合使用

public interface APIService {
        /**
         *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
         * Field("username") 表示将后面的String name中name的取值作为 username 的值
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);
        /**
         * Map的key作为表单的键
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded2(@FieldMap Map<String, Object> map);
}
// 具体使用
// @Field
Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);
// @FieldMap
// 实现的效果与上面相同，但要传入Map
Map<String, Object> map = new HashMap<>();
map.put("username", "Carson");
map.put("age", 24);
Call<ResponseBody> call2 = service.testFormUrlEncoded2(map);

d. @Part & @PartMap：发送 Post请求时提交请求的表单字段，与 @Multipart 注解配合使用

public interface APIService{
          /**
         * {@link Part} 后面支持三种类型，{@link RequestBody}、{@link okhttp3.MultipartBody.Part} 、任意类型
         * 除 {@link okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段({@link okhttp3.MultipartBody.Part} 中已经包含了表单字段的信息)，
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);
        /**
         * PartMap 注解支持一个Map作为参数，支持 {@link RequestBody } 类型，
         * 如果有其它的类型，会被{@link retrofit2.Converter}转换，如后面会介绍的 使用{@link com.google.gson.Gson} 的 {@link retrofit2.converter.gson.GsonRequestBodyConverter}
         * 所以{@link MultipartBody.Part} 就不适用了,所以文件只能用<b> @Part MultipartBody.Part </b>
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload2(@PartMap Map<String, RequestBody> args, @Part MultipartBody.Part file);
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload3(@PartMap Map<String, RequestBody> args);
}
// 具体使用
MediaType textType = MediaType.parse("text/plain");
RequestBody name = RequestBody.create(textType, "Carson");
RequestBody age = RequestBody.create(textType, "24");
RequestBody file = RequestBody.create(MediaType.parse("application/octet-stream"), "这里是模拟文件的内容");
// @Part
MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);
ResponseBodyPrinter.printResponseBody(call3);
// @PartMap
// 实现和上面同样的效果
Map<String, RequestBody> fileUpload2Args = new HashMap<>();
fileUpload2Args.put("name", name);
fileUpload2Args.put("age", age);
//这里并不会被当成文件，因为没有文件名(包含在Content-Disposition请求头中)，但上面的 filePart 有
//fileUpload2Args.put("file", file);
Call<ResponseBody> call4 = service.testFileUpload2(fileUpload2Args, filePart); //单独处理文件
ResponseBodyPrinter.printResponseBody(call4);
}

e. @Query和@QueryMap：用于 @GET 方法的查询参数（Query = Url 中 ‘?’ 后面的 key-value），配置时只需要在接口方法中增加一个参数即可：

@GET("/")    
Call<String> cate(@Query("cate") String cate);
// 其使用方式同 @Field与@FieldMap，这里不作过多描述

f. @Path：URL地址的缺省值

public interface APIService {
    @GET("users/{user}/repos")
    Call<ResponseBody>  getBlog（@Path("user") String user ）;
    // 访问的API是：https://api.github.com/users/{user}/repos
    // 在发起请求时， {user} 会被替换为方法的第一个参数 user（被@Path注解作用）
}

g. @Url：直接传入一个请求的 URL变量用于URL设置

public interface APIService {
    @GET
    Call<ResponseBody> testUrlAndQuery(@Url String url, @Query("showAll") boolean showAll);
    // 当有URL注解时，@GET传入的URL就可以省略
    // 当GET、POST...HTTP等方法中没有设置Url时，则必须使用 {@link Url}提供
}

3、解析器 & 适配器

Retrofit创建实例的方式如下代码所示：

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 设置网络请求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) // 设置数据解析器
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava平台
                .build();

关于数据解析器（Converter）

Retrofit支持多种数据解析方式，使用时需要在Gradle中添加相应的依赖

数据解析器	Gradle依赖
Gson	com.squareup.retrofit2:converter-gson:2.0.2
Jackson	com.squareup.retrofit2:converter-jackson:2.0.2
Simple XML	com.squareup.retrofit2:converter-simplexml:2.0.2
Protobuf	com.squareup.retrofit2:converter-protobuf:2.0.2
Moshi	com.squareup.retrofit2:converter-moshi:2.0.2
Wire	com.squareup.retrofit2:converter-wire:2.0.2
Scalars	com.squareup.retrofit2:converter-scalars:2.0.2

当使用到数据解析器后，我们需要手动创建Bean，并设置接口返回类型：

public interface ApiService {
    @GET("book/")
    Call<RetrofitBean> getBookInfo(@Query("bookid") String bookid);
}

网络请求适配器（CallAdapter）

Retrofit支持多种网络请求适配器方式：guava、Java8和rxjava，使用的是 Android 默认的 CallAdapter，则不需要添加网络请求适配器的依赖，

否则则需要按照需求进行添加Retrofit 提供的 CallAdapter。

implementation com.squareup.retrofit2:adapter-guava:2.0.2
implementation com.squareup.retrofit2:adapter-java8:2.0.2
implementation com.squareup.retrofit2:adapter-rxjava:2.0.2

com.squareup.retrofit2:adapter-rxjava:2.0.2用的是RxJava1.X，现在所以很多Rx2的新特性都没有，所以在这里为了支持Rx2.0，

并不建议使用square的适配器。这里使用另外一款适配器，应用如下：

// 引入请求适配器
implementation 'com.jakewharton.retrofit:retrofit2-rxjava2-adapter:1.0.0-RC3'
// 引入RxAndroid适应Android开发需求
implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'

由于使用到Rxjava的网络请求适配器，这也是Retrofit结合Rxjava的使用方式，我们需要修改返回类型：

public void rxJavaAndRetrofit() {
    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("http://fanyi.youdao.com/") // 设置网络请求的Url地址
            .addConverterFactory(GsonConverterFactory.create()) // 设置数据解析器
            .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) // 支持RxJava平台
            .build();
    ApiService apiService = retrofit.create(ApiService.class);
    apiService.getBookInfo("123")
            .subscribeOn(Schedulers.io())
            .subscribeOn(AndroidSchedulers.mainThread())
            .subscribe(new Consumer<RetrofitBean>() {
                @Override
                public void accept(RetrofitBean retrofitBean) throws Exception {
                    // 设置结果
                }
            });
}

码农公寓

Retrofit

基本用法

请求方式

注解说明

网络请求方法

网络请求方法

网络请求参数

3、解析器 & 适配器

关于数据解析器（Converter）

网络请求适配器（CallAdapter）

相关文章