[移动开发]Retrofit 的基本使用

基于okhttp，并支持ESTful API 设计风格。网络请求工作实际由OkHttp完成，Retrofit主要负责接口的封装。可以通过注解配置请求：包括请求方法，请求参数，请求头，返回值等。对RxJava支持。

1.准备工作
1.1 导入依赖

implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
implementation 'com.squareup.retrofit2:retrofit:2.9.0'
implementation 'com.squareup.retrofit2:converter-scalars:2.9.0'

1.2 开启网络权限

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

在 res 目录下新建 xml 文件夹，新建 network-config.xml

<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
    <base-config cleartextTrafficPermitted="true" />
</network-security-config>

在 manifest application 下引入

android:networkSecurityConfig="@xml/network_config"

2.创建网络请求
2.1 创建网络请求的接口

public interface CreditService {
    @POST("/findStudentById")
    Call<String> getStudentById(@Query("id") String id);
}

2.2 创建 Retrofit 实例

OkHttpClient okHttpClient1 = new OkHttpClient.Builder()
        .addInterceptor(new MineIntercept())
        .build();
Retrofit retrofit1 = new Retrofit.Builder()
    .baseUrl("http://172.16.49.173:8080")
    .addConverterFactory(ScalarsConverterFactory.create())
    .client(okHttpClient1)
    .build();
CreditService creditService = retrofit1.create(CreditService.class);

.addInterceptor: 传入参数为拦截器，可省略.以下是我自定义拦截器，用于拦截并打印日志

public class MineIntercept implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        Response response = chain.proceed(request);
        Log.i("XXX", "intercept request ->  " + request);
        Log.i("XXX", "intercept response ->  " + response);
        return response;
    }
}

.baseUrl： 访问的是 基地址（必须以 / 结尾），在请求接口的GET注解中是我真正要访问的地址，因为 @Query 中的id，所以最终的访问地址如下
http://172.16.49.173:8080/findStudentById?id=传入的id值
.addConverterFactory: 对服务器的数据进行解析
eg: addConverterFactory(GsonConverterFactory.create()) 发可以将返回的json数据直接解析为一个实体类
2.3 创建网络请求接口的实例

CreditService creditService = retrofit1.create(CreditService.class);

2.4 发送网络请求

creditService.getStudentById(id).enqueue(new retrofit2.Callback<String>() {
    @Override
    public void onResponse(retrofit2.Call<String> call, retrofit2.Response<String> response) {
        String res = response.body();
        Log.i(TAG, "res -> " + res);
        tvCredit.setText(res);
    }

    @Override
    public void onFailure(retrofit2.Call<String> call, Throwable t) {

    }
});

3 Get请求注解
3.1 @GET
上诉例子即为 GET 实例，其最终的访问地址为 ：
http://172.16.49.173:8080/findStudentById?id=传入的id值
@Query 该注解就是再getUserInfo 后面添加？ 并以 id=传来的参数userId 的形式拼接 id
3.2 @QueryMap
定义请求方法，返回值为 Activity 的list集合

@GET("/findAllActivity")
Call<List<Activity>> getArticalInfo(@QueryMap Map<String, String> params);

异步请求获取数据：

OkHttpClient okHttpClient = new OkHttpClient.Builder().build();
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://172.16.49.173:8080")
        .addConverterFactory(GsonConverterFactory.create())
        .client(okHttpClient).build();
CreditService creditService1 = retrofit.create(CreditService.class);
creditService1.findAllActivity(list).enqueue(new retrofit2.Callback<List<Activity>>() {
    @Override
    public void onResponse(retrofit2.Call<List<Activity>> call, retrofit2.Response<List<Activity>> response) {
        List<Activity> activityList = response.body();

        for (Activity i : activityList){
            Log.i(TAG, i.toString());
        }
    }
    public void onFailure(retrofit2.Call<List<Activity>> call, Throwable t) {

    }
});

注：从此以下，demo语言为kotlin
3.3 @Path
当访问的参数由 某个参数 动态凭借而成，
当不知道返回的类型是啥玩意，可以返回 ResponseBody 类型

@GET("/{id}/pathDemo")
fun pathDemo(@Path("id") id : Int) : ResponseBody

为使用方便，用 kotlin 将 Retrofit 进行了简单的封装，需传入 baseUrl

fun getCreditServiceInstance(baseUrl : String) : CreditService? {

    var creditService : CreditService? = null

    if (creditService == null){
        val okHttpClient = OkHttpClient.Builder().build();
        val retrofit = Retrofit.Builder()
            .baseUrl(baseUrl)
            .addConverterFactory(GsonConverterFactory.create())
            .client(okHttpClient)
            .build();
        creditService = retrofit.create(CreditService::class.java)
    }

    return creditService;
}

3.4 @Url
当访问的地址不只是在基地址中动态的改变几个参数什么的，而是整个地址都需要发生变化，甚至基类地址也需变化，则需用到 @Url

@GET
fun getOtherUrl(@Url url: String ,@Query("id") id : String?) : Call<String>
getCreditServiceInstance(baseUrl)?.getOtherUrl(baseUrl + "/demo","1234")?.enqueue(object : Callback<String>{
    override fun onResponse(call: Call<String>, response: Response<String>) {
        Log.i("XXX", "res is ->> " + response.body())
        tvOtherUrl?.text = response.body().toString()
    }

    override fun onFailure(call: Call<String>, t: Throwable) {
    }

})

注：虽然说最终访问的地址与原先的baseUrl无关，但是baseUrl还是要以 http:// https://，并且后面至少要跟一个字母或者其他东西，不然就会报错。
3.5 @Header
该请求是用于配置HTTP请求的 Header。
4.POST请求注解
对比GET中的请求
@Fileld == @Query
@FieldMap == @QueryMap
@Body == @Url
4.1 @FormUrlEncoded
@FormUrlEncoded 用于修饰 @Field ，@FieldMap 注解，将自动将请求参数的类型调整为 ：
application/x-www-form-urlencoded
4.2 @Field
用法同 @Query
区别在于，get请求参数在 url 路径后面，post 在请求的主体中

注：记得加上 @FormUrlEncoded ,否则会报错
4.3 @FieldMap
用法同 @QueryMap
4.4 @Body
@FieldMap 注解适合多个相同类型参数的传递

@POST("/demo/find")
fun getNextStudent(@Body student: Student) : Call<Student>

注： @FormUrlEncoded 和 @Body 不可以同时使用，否则会报错：
IllegalArgumentException:@Body parameters cannot be used with form or multi-part encoding
因为 @FormUrlEncoded , @Body , @Maltiipart 都是用来指定数据发送的方式，故不能同时使用
reason：Content-Type 位于Http 协议的消息头，用于表示具体请求的媒体类型。
application/x-www-form-urlencoded： 请求以键值对的形式加到 url 的后面
**application/json：**标识消息主体是序列化的json字符串
**multipart/form-data ：**多用于文件的上传

使用 @Body 必须在创建 Retrofit 实例时，必须添加 ，.addConverterFactory(GsonConverterFactory.create()) 用于序列化实体类