Retrofit基本使用

Retrofit 作为Android和Java类型安全的HTTP客户端，记得刚毕业那会面试，面试官问我用过Retrofit和OKHttp吗？当时一脸蒙蔽的记忆尤新，哈哈，我使用Retrofit和OKHttp已经差不多1年多了，趁最近有时间记录下来，当前最新：Retrofit 2.4.0和OKHttp 3.10.0 了，这里就先讲解Retrofit的使用，后期将会结合OKHttp和RxJava来说。

• [自定义Converter]
• Retrofit结合RxJava和OKHttp的使用和封装
• OKHttp全局自动刷新Token

HTTP请求方法区别

看了好多有关于Retrofit的文档，发现很多同志对于Http的理解是错的，比如：GET请求和POST的区别。
HTTP请求方法包含get、post、delete、put、head、patch、trace、options总共8种。除get外，其他6种都是基于post方法衍生的，最常见的是get和post，以便后面能更好的理解Retrofit的基本原理：
先来看看：

POST  HTTP/1.1 
Host: host
Content-Type: application/json
Cache-Control: no-cache
Postman-Token: f71ba1cc-3143-6891-619e-f1d4a0b3f277

{"username":"test",
"birth":"1994-12-25",
"weight":42.5,
"height":162,
"preproduction":"2018-5-3",
"hobby":"运动&美食&阅读",
"deviceid":"fe0b17b628d19c16"},
}

上面POST请求，接下来看一下GET请求：

GET  HTTP/1.1
Host: host
Content-Type: application/json
Cache-Control: no-cache
Postman-Token: f7433b77-c539-b882-5dae-001c0325f051

由于这个IP没有域名，所以没有URL域，大家能看出有什么区别吗？GET和POST请求的区别在于GET没有请求体而POST有请求体，不好理解？那就上图：

请求报文一般格式.png

所以GET和POST请求的区别在于GET没有请求体而POST有请求体；

Retrofit初识

1.开启Retrofit旅程

导入Retrofit：
下载the latest JAR 或者 Maven:

<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>retrofit</artifactId>
  <version>2.4.0</version>
</dependency>

在Gradle中使用：

implementation 'com.squareup.retrofit2:retrofit:2.4.0'

注意：
如果你在项目中需要混淆代码需要在ProGuard 文件中加入下面的混淆，防止retrofit被混淆而抛异常：

# Retain generic type information for use by reflection by converters and adapters.
-keepattributes Signature
# Retain service method parameters.
-keepclassmembernames,allowobfuscation interface * {
    @retrofit2.http.* <methods>;
}
# Ignore annotation used for build tooling.
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement

经过以上的配置基本就可以在项目中使用Retrofit：
首先Retrofit是通过Interface来管理HTTP API，而且这个接口不能继承其他接口（看源码）

public interface APIService {
    @FormUrlEncoded
    @POST("login")
    Flowable<HttpResult<UserInfoData>> login(@FieldMa Map<String,  String> map);//登陆
}

然后通过Retrofit.Builder获取到Retrofit实例，并通过create(clazz)方法获取到我们刚才创建的RetrofitApi接口实例：

Retrofit retrofit=new Retrofit.Builder()
    .baseUrl(baseurl)
    .build();

RetrofitApi retrofitApi=retrofit.create(APIService .class);

有了RetrofitApi实例之后，我们就可以在需要网络请求的地方调用了：

    Call<BaseResult<User>> userCall=retrofitApi.login();

这里面Retrofit使用的代理模式，做各种操作，这里只是讲使用后期讲解源码，将仔细讲解这方面的内容。
以上是利用Retrofit向buaseurl接口发送一个get请求。
注：baseUrl("")中的url必须以'/'结尾，否则会报异常；@GET("public")中的url如果是需要拼接在baseUrl之后的则不要以‘/’开头

Retrofit的注解

Retrofit中有很多注解，这些注解总共分三类：HTTP请求方法、标记类、参数类;

1.HTTP请求方法注解

Retrofit支持八种HTTP请求方法注解，分别是：GET，POST，PUT，DELETE，HEAD，PATCH，OPTIONS，HTTP，其中前7种分别对应HTTP请求方法（见Retrofit初识小节1），而HTTP注解可自定义请求方法，也就是说可以替换前面七种方法.

• GET：对应HTTP的get请求方法

写法：

@GET("public")
Call<BaseResult<List<User>>> getUser();

• POST：对应HTTP的post请求方法

写法：

  @POST("User")
   Call<BaseResult<String>> addUser();

• PUT：对应HTTP的put请求方法
  写法：

  @PUT("User")
  Call<BaseResult<String>> updateUser();
  

• DELETE：对应HTTP的delete请求方法

写法：

  @DELETE("User")
  Call<BaseResult<String>> deleteUser();

• HEAD：对应HTTP的head请求方法
• PATCH：对应HTTP的patch请求方法
• OPTIONS：对应HTTP的options请求方法
• HTTP：可替换以上七种，也可以扩展请求方法

写法：

/**
    * method 表示请的方法，不区分大小写
    * path表示路径
    * hasBody表示是否有请求体
*/
@HTTP(method = "get", path = "public", hasBody = false)
Call<BaseResult<List<User>>> getUser();

2.标记类注解

Retrofit支持三种标记类注解，分别是：FormUrlEncoded、Multipart、Streaming。

• FormUrlEncoded：指请求体是一个Form表单，Content-Type=application/x-www-form-urlencoded，需要和参数类注解@Field，@FieldMap搭配使用；

写法：

@FormUrlEncoded
@POST("login")
Flowable<HttpResult<UserInfoData>> login(@FieldMap Map<String, String> map);

@FormUrlEncoded
@POST("public")
Call<BaseResult> addUser(@Field("userName") String userName);

• Multipart：指请求体是一个支持文件上传的Form表单，Content-Type=multipart/form-data，需要和参数类注解@Part，@PartMap搭配使用（详见下节）

写法：

@Multipart
@POST("public")
Call<BaseResult> uploadFile(@Part MultipartBody.Part file);

 @Multipart
@POST("users/image")
Call<BaseResponse<String>> uploadFilesWithParts(@Part() List<MultipartBody.Part> parts);

 @POST("users/image")
Call<BaseResponse<String>> uploadFileWithRequestBody(@Body  MultipartBody multipartBody);

使用@Multipart注解方法，并用@Part注解方法参数，类型是List< okhttp3.MultipartBody.Part>
不使用@Multipart注解方法，直接使用@Body注解方法参数，类型是okhttp3.MultipartBody

• Streaming：指响应体的数据以流的形式返回，如果不使用默认会把数据全部加载到内存，所以下载文件时需要加上这个注解

写法：

@Streaming
@GET("download")
Call<ResponseBody> downloadFile();

3.参数类注解

• Headers：添加请求头，作用于方法

写法：

@Headers("Cache-Control: max-age=640000")
@GET("public")
Call<BaseResult<List<User>>> getUser();

或

@Headers({
"Cache-Control: max-age=640000"
"User-Agent: Retrofit-Sample-App"
})
@GET("public")
Call<BaseResult<List<User>>> getUser();

• Header：用于动态添加头部，作用于方法参数

写法：

@GET("public")
Call<BaseResult<List<User>>> getUser(@Header("Token") String token);

• Body：用于非表单请求体，作用于方法参数

写法：

@POST("user")
Call<BaseResult<String>> addUser(@Body User user);

• Url：用于动态改变Url，作用于方法参数

写法：

@GET("public")
Call<BaseResult<List<User>>> getUser(@Url String url);

请求的时候，url会替换掉public

• Path：用于替换请求地址，作用于方法参数

写法：

@GET("{public}")
Call<BaseResult<List<User>>> getUser(@Path("public") String path);

请求的时候，path会替换掉public

• Field：用于表单字段参数，（需要配合FormUrlEncoded使用）作用于方法参数

写法：

@FormUrlEncoded
@POST("public")
Call<BaseResult> addUser(@Field("userName") String userName);

• FieldMap：用于表单字段参数，接收Map实现多个参数，（需要配合FormUrlEncoded使用）作用于方法参数

写法：

@FormUrlEncoded
@POST("public")
Call<BaseResult> addUser(@FieldMap Map<String,String> fieldMap);

• Part：用于表单字段参数，适用于文件上传，（需要配合Multipart使用）作用于方法参数

写法：

@Multipart
@POST("public")
Call<BaseResult> uploadFile(@Part MultipartBody.Part file);

• PartMap：用于表单字段参数，适用于文件上传，（需要配合Multipart使用）作用于方法参数

写法：

@Multipart
@POST("public")
Call<BaseResult> uploadFile(@PartMap Map<String,RequestBody> RequestBodyMap);

• Query：用于条件字段参数，作用于方法参数（主要在GET中使用）

写法：

    @GET("public")
    Call<BaseResult<List<User>>> getUser(@Query("userId") String userId);

• QueryMap：用于条件字段参数，作用于方法参数（主要在GET中使用）

写法：

@GET("public")
Call<BaseResult<List<User>>> getUser(@QueryMap Map<String,String> map);

• @Body 作用于方法参数

   @POST("public")
   Call<BaseResult<List<User>>> getUser(@Body( User user);
  

注：

• 使用Post请求方式（数据都是被放在请求体中上传到服务器）：
  1、表单提交：建议使用Field或FieldMap+FormUrlEncoded，以键值对上传到服务器；
  2、JSON提交：建议使用@Body，大部分都是实体类，最后将实体类转换为JSON，上传服务器；

• 使用GET请求（将参数拼接在url后面的）
  1、建议使用Query或QueryMap都是将参数拼接在url后面的；