一 、简介
如上图所示，Retrofit2针对于Android/Java的、基于okHttp的、一种轻量级且安全的、并使用注解方式的网络请求框架。
Retrofit使用注解方式，大大简化了我们的URL拼写形式，而且注解含义一目了然，简单易懂；支持同步和异步执行，使得请求变得异常简单。
App通过 Retrofit 请求网络，实际上是使用 Retrofit 接口层封装请求参数、Header、Url 等信息，然后使用 OkHttp 完成请求操作，然后OkHttp 将原始的结果交给 Retrofit，Retrofit根据用户的需求对结果进行解析。
这篇文章主要写Retrofit的基本使用，更多使用和配置请移步Retrofit-GitHub关于retrofit的源码，我们在后续的文章中学习。
二、 Retrofit2的使用配置
添加依赖：
implementation'com.squareup.retrofit2:retrofit:2.4.0'
添加网络权限
<uses-permission android:name="android.permission.INTERNET"/>
三、 Retrofit2的使用
1、简单介绍
Retrofit是通过注解的方法去表示请求的方法，请求的参数等，常使用的会在后面整理。
2、基本使用
Retrofit的使用可以简单的分为个过程
- 创建接口，添加请求网络的方法
- 创建Retrofit对象，回去定义的接口，使用同步或异步请求网络
创建请求网络的接口：
在下面的代码中，我们创建一个接口，Get注解表示这个方法为Get请求，返回ResponseBody对象。
public interface ApiServer{
//一般请求，通过注释GET表明为GET方法
//https://api.github.com/users/list
@GET("users/list")
//定义返回的方法，返回的响应体使用了ResponseBody，也可以返回一个对象，注意要加入Gson解析
Call<ResponseBody>getUser();
}
创建Retrofit，获取定义的接口，然后获取请求的数据。
//获取Retrofit对象
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create())
.baseUrl("https://api.github.com")
.build();
//然后通过动态代理获取到所定义的接口，获取到返回
RetrofitService retrofitService=retrofit.create(ApiServer.class);
Call<ResponseBody> repos = retrofitService.getGroupList(1);
repos.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
//处理数据，然后在UI线程中更新数据
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
}
});
3、 GET请求
3.1、基本使用
public interface ApiServer{
//一般请求，通过注释GET表明为GET方法
//https://api.github.com/users/list
@GET("users/list")
//定义返回的方法，返回的响应体使用了ResponseBody，也可以返回一个对象，注意要加入Gson解析
Call<ResponseBody>getUser();
//一般请求，并指定查询参数
//https://api.github.com/users/list
@GET("users/list?sort=desc")
Call<ResponseBody>getUserByDesc();
}
3.2、动态的url访问
这样我们在访问时，就可以通过传入不同的参数，就可以获取需要的数据
public interface ApiServer{
//动态添加查询参数https://api.github.com/group/10/users
@GET("group/{id}/users")
Call<ResponseBody>getGroupById(@Path("id")int groupId);
}
3.3、传入查询参数
通过Query、QueryMap我们传入参数，就可以访问各种数据
public interface ApiServer{
//动态查询，并动态指定一个查询参数
//https://api.github.com/group/10/users?sort=desc
@GET("group/{id}/users")
Call<ResponseBody>getGroupByParm(@Path("id")int groupId, @Query("sort")String sort);
//通过传入HashMap，添加多个查询参数
@GET("group/{id}/users")
Call<ResponseBody>getGroupByParms(@Path("id") int groupId, @QueryMap Map<String, String> options);
}
3.4、添加请求头
@Header和@Headers都可以用于添加请求头
//添加请求头
//@Header(“key：XXXXX”)
//@Headers({“key：XXXXX”，“key：XXXXX”})
//添加请求头
//https://api.github.com/users/list
@GET("users/list")
Call<ResponseBody>getUserByHeadler(@Header("key")String value);
3.5、@HTTP使用方法
@HTTP可以代替各种网络请求
public interface ApiServer{
@HTTP(method = "GET", path = "blog/{id}", hasBody = false)
Call<ResponseBody> getCall(@Path("id") int id);
}
4、POST请求
4.1、上传json字符串数据@Body
传入一个User对象
public interface ApiServer{
//通过注释子POST表明为POST方法
@POST("users/new")
Call<ResponseBody> createUser(@Body User user);
}
4.2 上传表单数据
@FormUrlEncoded：表示发送form-encoded的数据，每个键值对需要用@Filed来注解键名
@Multipart:表示发送form-encoded的数据（适用于 有文件 上传的场景）,每个键值对需要用@Part来注解键名
public interface RetfofitService{
@POST("login")
@FormUrlEncoded
Call<ResponseBody> login(@Field("username") String username, @Field("password") String password);
//Map的key作为表单的键
@POST("/FormUrlEncoded")
@FormUrlEncoded
Call<ResponseBody> testFormUrlEncoded2(@FieldMap Map<String, Object> map);
}
四、数据解析
Retrofit支持很多解析器，我们常用的是Gson，使用后我们就可以直接返回一个对象
添加依赖
implementation 'com.squareup.retrofit2:converter-gson:2.4.0'
添加数据解析器
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("")
.addConverterFactory(GsonConverterFactory.create()) // 设置数据解析器
.build();
//我们在返回参数时，就可以直接返回对象
@POST("login")
@FormUrlEncoded
Call<User> login(@Field("username") String username, @Field("password") String password);
五、通用的请求方法
我们一下方法，可以创建统一的Get和Post
public interface RetfofitService{
@POST("{path}")
Observable<ResponseBody> post(
@Path(value = "path", encoded = true) String path,
@QueryMap Map<String, Object> map);
@GET("{path}")
Observable<ResponseBody> get(
@Path(value = "path", encoded = true) String path,
@QueryMap Map<String, Object> map);
}
文件上传和下载的功能，我们放在Rxjava中通过实例学习
