《第一行代码》阅读笔记（二十九）——网络框架 OkHttp+Retrofit+Rxjava

简介

现在android网络请求大部分已经换成了Retrofit2.0 +RxJava + okHttp3.0，Retrofit 使用接口的方式，负责请求的数据和请求的结果，OkHttp 负责请求的过程，RxJava 负责异步，各种线程之间的切换。毫无疑问这三剑客 已成为当前Android 网络请求最流行的方式。

Retrofit：Retrofit是Square 公司开发的一款基于restful风格接口的Android 网络请求的框架，对OkHttp做了一层封装。网络请求还是基于OkHttp，我们只需要通过简单的配置就能使用retrofit来进行网络请求了。Retrofit官网

RxJava：RxJava 在 GitHub 主页上介绍 “a library for composing asynchronous and event-based programs using observable sequences for the Java VM”（一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库）。总之，RxJava让异步操作变得非常简单。RxJava官网

OkHttp：Square 公司开源的网络请求库。OkHttp官网

————————————————
版权声明：本文为CSDN博主「fengyongge_」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/f917386389/article/details/76461231

导入依赖

     //okhttp3
    implementation 'com.squareup.okhttp3:logging-interceptor:3.8.0'
    implementation 'com.squareup.okhttp3:okhttp:3.8.0'
    //Retrofit2库
    implementation 'com.squareup.retrofit2:retrofit:2.3.0'
    //gson解析
    implementation 'com.squareup.retrofit2:converter-gson:2.3.0'
    //rxjava适配器
    implementation 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'
    //rxjava2
    implementation 'io.reactivex.rxjava2:rxjava:2.2.3'
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.0'

Retrofit

使用介绍

使用 Retrofit 的步骤

步骤1：添加Retrofit库的依赖和添加网络请求权限
不多说
步骤2：创建接收服务器返回数据的类
一般使用Gson处理，方式就是使用之前文章中介绍过的GsonFormat插件
步骤3：创建用于描述网络请求的接口

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

1.用 动态代理 动态 将该接口的注解“翻译”成一个 Http 请求，最后再执行 Http 请求
2.注：接口中的每个方法的参数都需要使用注解标注，否则会报错

public interface GetRequest_Interface {

    @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>
}

步骤4：创建Retrofit实例

 Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 设置网络请求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) // 设置数据解析器
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava平台
                .build();
  • 关于数据解析器（Converter）
    Retrofit支持多种数据解析方式，一般我们使用Gson，在使用的时候需要添加依赖。
  • 关于网络请求适配器（CallAdapter）
    Retrofit支持多种网络请求适配器方式：guava、Java8和rxjava，一般我们使用rxjava，在使用的时候需要添加依赖。

这也是Retrofit方便的地方，不需要再单独解析Gson数据。

步骤5：创建网络请求接口实例并配置网络请求参数

        // 创建 网络请求接口 的实例
        GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);
        //对 发送请求 进行封装
        Call<Reception> call = request.getCall();

步骤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();

封装了数据转换、线程切换的操作，所在在这里不能对UI进行操作，如果需要对控件进行改变的话，可以设置handler。

步骤7：处理服务器返回的数据
通过response类的body()对返回的数据进行处理

//发送网络请求(异步)
        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();

注解说明

网络请求方法

  1. @GET、@POST、@PUT、@DELETE、@HEAD
public interface GetRequest_Interface {

    @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
    Call<Translation>  getCall();
    // @GET注解的作用:采用Get方法发送网络请求
    // getCall() = 接收网络请求数据的方法
    // 其中返回类型为Call<*>，*是接收数据的类
}

此处特意说明URL的组成：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 = 在创建Retrofit实例时通过.baseUrl()设置 + 网络请求接口的注解设置（下面称 “path“ ）
具体整合的规则如下：

类型 具体使用
path = 完整的Url Url = "http://host:port/a/b/apath"
其中:
●path = "http://host:port/a/b/apath"
●baseUrl（覆盖）
(即如接口里的Url是一个完整的网址，那么在创建Retrofit实例时
设置baseUrl时无效，但是baseUrl不能为空，并且要输入
“http://+随意输入”，不然报错)
path = 相对路径
baseUrl = 目录形式		 Url = "http://host:port/a/b/apath"
其中:
●path = "apath"
●baseUrl = "http://host:port/a/b/"

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

  1. @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 不会做处理，所以要自行保证准确
}

标记

  1. @FormUrlEncoded

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

  1. @Multipart

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

public interface GetRequest_Interface {
        /**
         *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
         * <code>Field("username")</code> 表示将后面的 <code>String name</code> 中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);

}

// 具体使用
       GetRequest_Interface service = retrofit.create(GetRequest_Interface.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> call3 = service.testFileUpload1(name, age, filePart);

网络请求参数

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

作用：以 Post方式传递自定义数据类型给服务器
特别注意：如果提交的是一个Map，那么作用相当于@Field

不过Map要经过FormBody.Builder类处理成为符合Okhttp格式的表单，如：

FormBody.Builder builder = new FormBody.Builder();
builder.add("key","value");
  1. @Field & @FieldMap

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

public interface GetRequest_Interface {
        /**
         *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
         * <code>Field("username")</code> 表示将后面的 <code>String name</code> 中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);
  1. @Part & @PartMap

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

具体使用：与 @Multipart 注解配合使用

public interface GetRequest_Interface {

          /**
         * {@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);
}
  1. @Query和@QueryMap

作用：用于 @GET 方法的查询参数（Query = Url 中 ‘?’ 后面的 key-value）
如：url = http://www.println.net/?cate=android，其中，Query = cate

具体使用：配置时只需要在接口方法中增加一个参数即可：

   @GET("/")    
   Call<String> cate(@Query("cate") String cate);
// 其使用方式同 @Field与@FieldMap，这里不作过多描述
  1. @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注解作用）
    }
  1. @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时，则必须使用 {@link Url}提供

}

汇总

这里是一篇讲的非常好的有关网络请求参数注解的文章，大家可以浏览。
【Android】Retrofit网络请求参数注解，@Path、@Query、@QueryMap...

示例

这是一份很详细的 Retrofit 2.0 使用教程（含实例讲解）

RxJava

这里不得不给大家推荐一下这两位大神写的Rxjava系列，通俗易懂，太强了。看完之后足以入门。
给初学者的RxJava2.0教程(一)
RxJava2.0——从放弃到入门

使用RxJava和Retrofit

浅谈OkHttp以及Retrofit+RxJava的封装使用
这篇文章笔者看过，写的也非常好。

下面的一些文章是笔者找的一些高阅读量的文章，笔者虽然没有仔细浏览，但是也大差不差，同学们感兴趣，可以仔细阅读。
Retrofit2+Rxjava+OkHttp的使用和网络请求
Android网络框架之Retrofit + RxJava ＋ OkHttp
MVP+Okhttp3+Retrofit2+Rxjava2 框架实现

posted @ 2020-08-01 20:26  朱李洛克  阅读(567)  评论(0)  编辑  收藏  举报
// 侧边栏目录 // https://blog-static.cnblogs.com/files/douzujun/marvin.nav.my1502.css