android 网络请求开发安卓网络请求框架retrofit

转载

kcoufee 2023-09-22 15:05:21

文章标签 android 网络请求开发 java android http 网络请求 文章分类 Android 移动开发

Retrofit2 网络请求框架

1 简介

Retorifit 是一个基于OkHttp的轻量级网络请求框架。网络请求的工作本质上是 OkHttp 完成，而 Retrofit 仅负责网络请求接口的封装。

它功能强大：支持同步和异步请求，支持多种数据解析，支持RxJava.
它简洁易用：通过注解配置网络参数
它可拓展性好：功能模块高度封装、彻底解耦

github地址：https://github.com/square/retrofit

app应用程序通过 Retrofit 请求网络，实际上是使用 Retrofit 接口层封装请求参数、Header、Url 等信息，之后由 OkHttp 完成后续的请求操作
在服务端返回数据之后，OkHttp 将原始的结果交给 Retrofit，Retrofit根据用户的需求对结果进行解析

2 接入

添加Retrofit库的依赖

dependencies {
    implementation 'com.squareup.retrofit2:retrofit:2.4.0'
    // Retrofit库
    implementation 'com.squareup.okhttp3:okhttp:3.10.0'
    // Okhttp库
  }

添加网络权限

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

3 使用

使用步骤

步骤1：创建接收服务器返回数据的类
步骤2：创建用于描述网络请求的接口
步骤3：创建 Retrofit 实例
步骤4：创建网络请求接口实例并配置网络请求参数
步骤5：发送网络请求（异步 / 同步）
步骤6：处理服务器返回的数据

步骤1：创建接收服务器返回数据的类

Reception.java

public class Reception {
    // 根据返回数据的格式和数据解析方式（Json、XML等）定义
    }

步骤2：创建用于描述网络请求的接口

Retrofit将 Http请求抽象成Java接口：采用注解描述网络请求参数和配置网络请求参数

public interface GetRequest {
    @GET("banner/json")
    Call<Translation>  getCall();
}

其中返回类型为Call<*>，*是接收数据的类（即上面定义的Translation类）
如果想直接获得Responsebody中的内容，可以定义网络请求返回值为Call

网络请求的URL的组成

Retrofit的网络请求的完整Url = 创建Retrofit实例时通过.baseUrl()设置的url
+网络请求接口的注解设置(下面称 “path“ )

// 第1部分：在创建Retrofit实例时通过.baseUrl()设置
Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(BASE_URL)
                .addConverterFactory(GsonConverterFactory.create()) 
                .build();
                
// 第2部分：在网络请求接口的注解设置
@GET("banner/json")
Call<Translation>  getCall();

具体整合的规则如下：

建议采用第三种方式来配置，并尽量使用同一种路径形式。

注解类型

大量注解的使用简化了代码

注解说明

android 网络请求开发安卓网络请求框架retrofit_android 网络请求开发

第一类：网络请求方法

android 网络请求开发安卓网络请求框架retrofit_网络请求_02

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

public interface GetRequest {
    @GET("banner/json")
    Call<Translation>  getCall();
}

@HTTP

作用：替换**@GET、@POST、@PUT、@DELETE、@HEAD**注解的作用及更多功能拓展
具体使用：通过属性method、path、hasBody进行设置

public interface GetRequest_Interface {
    /**
     * method：网络请求的方法（区分大小写）
     * path：网络请求地址路径
     * hasBody：是否有请求体
     */
    @HTTP(method = "GET", path = "blog/{id}", hasBody = false)
    Call<ResponseBody> getCall(@Path("id") int id);
    // {id} 表示是一个变量
    // method 的值 retrofit 不会做处理，所以要自行保证准确
}

第二类：标记

android 网络请求开发安卓网络请求框架retrofit_网络请求_03

@FormUrlEncoded

作用：表示发送form-encoded的数据
每个键值对需要用@Filed来注解键名，随后的对象需要提供值。

@Multipart

作用：表示发送form-encoded的数据（适用于有文件上传的场景）
每个键值对需要用@Part来注解键名，随后的对象需要提供值。

具体使用如下：

public interface GetRequest {
        /**
         *表明是一个表单格式的请求（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);
         
        /**
         * @Part后面支持三种类型，{@RequestBody}、{@ okhttp3.MultipartBody.Part} 、任意类型
         * 除 {@okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

}

       // 具体使用
       GetRequest service = retrofit.create(GetRequest.class);
        // @FormUrlEncoded 
        Call<ResponseBody> call1 = service.testFormUrlEncoded1("Jame", 24);
        
        //  @Multipart
        RequestBody name = RequestBody.create(textType, "Jame");
        RequestBody age = RequestBody.create(textType, "24");

        MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
        Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);

第三类：网络请求参数

android 网络请求开发安卓网络请求框架retrofit_android_04

@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作用于方法

@Body

作用：以 Post方式传递自定义数据类型给服务器

@Field & @FieldMap

作用：发送 Post请求时提交请求的表单字段
具体使用：与 @FormUrlEncoded 注解配合使用

public interface GetRequest_Interface {
    
        @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);

@Part & @PartMap

作用：发送 Post请求时提交请求的表单字段, 与@Field的区别：功能相同，但携带的参数类型更加丰富，包括数据流，所以适用于有文件上传的场景
具体使用：与 @Multipart 注解配合使用

public interface GetRequest_Interface {

        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

    
        @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 有
        Call<ResponseBody> call4 = service.testFileUpload2(fileUpload2Args, filePart); //单独处理文件
        ResponseBodyPrinter.printResponseBody(call4);
}

@Query和@QueryMap

作用：用于 @GET 方法的查询参数（Query = Url 中 ‘?’ 后面的 key-value）

如：url = http://www.println.net/?cate=android
具体使用：配置时只需要在接口方法中增加一个参数即可：

@GET("/")    
   Call<String> cate(@Query("cate") String cate);
}

@Path

作用：URL地址的缺省值
具体使用：

public interface GetRequest_Interface {

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

@Url

作用：直接传入一个请求的 URL变量用于URL设置
具体使用：

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

步骤3：创建 Retrofit 实例

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

数据解析器（Converter）

Retrofit支持多种数据解析方式,使得来自接口的json结果会自动解析成定义好了的字段和类型都相符的json对象接受类。
使用时需要在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

网络请求适配器（CallAdapter）

addCallAdapterFactory()方法传入适配器，默认为CallAdapter
Retrofit支持多种网络请求适配器方式：guava、Java8和rxjava
使用时需要在Gradle添加依赖：

网络请求适配器	Gradle依赖
guava	com.squareup.retrofit2:adapter-guava:2.0.2
Java8	com.squareup.retrofit2:adapter-java8:2.0.2
rxjava	com.squareup.retrofit2:adapter-rxjava:2.0.2

步骤4：创建网络请求接口实例

// 创建 网络请求接口 的实例
    GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);

    //对 发送请求 进行封装
    Call<Reception> call = request.getCall();

步骤5：发送网络请求（异步 / 同步）

//发送网络请求(异步)
        call.enqueue(new Callback<Translation>() {
            //请求成功时回调
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                //请求处理,输出结果
                response.body().show();
            }

            //请求失败时候的回调
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                System.out.println("连接失败");
            }
        });

// 发送网络请求（同步）
Response<Reception> response = call.execute();

步骤6：处理返回数据

//发送网络请求(异步)
        call.enqueue(new Callback<Translation>() {
            //请求成功时回调
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                // 对返回数据进行处理
                response.body().show();
            }

            //请求失败时候的回调
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                System.out.println("连接失败");
            }
        });

// 发送网络请求（同步）
  Response<Reception> response = call.execute();
  // 对返回数据进行处理
  response.body().show();

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。