Retrofit使用方法

Retrofit采用 RESTfull HTTP网络请求框架基于OKHTTTPClient的源代码进行包装。与传统的网络框架相比，其本质没有区别。它只是非常仔细地设计和包装了网络请求过程的每一步。它涉及到许多设计模式。实现网络请求的真正解耦，可以说设计模式已经应用到了极致。

首先，Retrofit需要在使用前依赖于项目：

<!--Retrofit核心库--><dependency>  <groupId>com.squareup.retrofit2</groupId>  <artifactId>retrofit</artifactId>  <version>2.9.0</version></dependency>

需要注意的是：Retrofit requires at minimum Java 8+ or Android API 21+.

接下来，让我们来看看使用Retrofit创建网络请求的步骤：

2. 使用2.1 声明接口API

public interface GitHubService {      @GET("users/{user}/repos")      Call<List<Repo>> listRepos(@Path("user") String user);}

2.2 创建Retrofit对象

Retrofit retrofit = new Retrofit.Builder()        .baseUrl("https://api.github.com/")        .build();

2.3 实现创建界面

GitHubService service = retrofit.create(GitHubService.class);

2.4 调用Call对象发起网络请求

Call<List<Repo>> repos = service.listRepos("octocat");repos.enqueue(new Callback<List<Repo>>() {        @Override        public void onResponse(Call<List<Repo>> call, Response<List<Repo>> response) {            //成功        }        @Override        public void onFailure(Call<List<Repo>> call, Throwable t) {            //失败        }    });

3. 详细使用3.11API 请求方法

发起Get请求只需在方法上声明@Get注释，还支持HTTP， POST, PUT, PATCH, DELETE, OPTIONS、 HEAD。

3.2 URL自定义

我们可以采用 {id}将参数替换为url的方法。例如：

@GET("group/{id}/users")Call<List<User>> groupList(@Path("id") int groupId);

Query的参数也可以这样使用:

@GET("group/{id}/users")Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);

可以使用稍微复杂的参数@QueryMap：

@GET("group/{id}/users")Call<List<User>> groupList(@Path("id") int groupId, @QueryMap      Map<String, String> options);

3.3 带body的请求

我们还以注释的方式声明了具体实体的请求，如下：

@POST("users/new")Call<User> createUser(@Body User user);

3.4 表格加密和各种请求体

使用@FormUrlEncoded注意提交表单，表单的数据对应于方法参数中声明的数据@Fieldkey对应的字段@Field("first_namevalue是first字符串的具体内容。

@FormUrlEncoded@POST("user/edit")Call<User> updateUser(@Field("first_name") String first,         @Field("last_name") String last);

可以使用多种类型的请求@Multipart注释字段来声明，例如：

@Multipart@PUT("user/photo")Call<User> updateUser(@Part("photo") RequestBody photo,       @Part("description") RequestBody description);

3.5 Header定制化

Header的声明可以直接用于方法@Headers，例如：

@Headers("Cache-Control: max-age=640000")@GET("widget/list")Call<List<Widget>> widgetList();

@Headers({  "Accept: application/vnd.github.v3.full+json",  "User-Agent: Retrofit-Sample-App"})@GET("users/{username}")Call<User> getUser(@Path("username") String username);

注意：

1. 声明中的Header不会相互覆盖。所有Header都有这样的名字，并将被添加到请求中。
2. 可以使用请求Header@Header动态变化注释；

此外，需要将Header添加到每个请求中，可以使用OkHttp的Bridgeinterceptor来实现。

4. Retrofitt配置

Retrofit将您的API请求转换为Call对象。因此，Retrofit将为您提供默认配置，并允许您自己定制。

Converters(数据转换器)

Converters是在创建Retrofit对象之初进行配置的。Converter的功能是在数据返回时转换相应格式的数据，减少了我们在获取数据时定制分析的麻烦和bug;

Retrofit retrofit = new Retrofit.Builder()            .baseUrl(BASE_URL)            .addConverterFactory(GsonConverterFactory.create())            .build();

GsonconverterFactory继承converterter.Factory

public interface Converter<F, T> {    @Nullable    T convert(F value) throws IOException;    abstract class Factory {    public @Nullable Converter<ResponseBody, ?> responseBodyConverter(        Type type, Annotation[] annotations, Retrofit retrofit) {      return null;  }    //...}

Retrofit不仅支持Gson，还支持Gson

Gson: com.squareup.retrofit2:converter-gson

Jackson: com.squareup.retrofit2:converter-jackson

Moshi: com.squareup.retrofit2:converter-moshi

Protobuf: com.squareup.retrofit2:converter-protobuf

Wire: com.squareup.retrofit2:converter-wire

Simple XML: com.squareup.retrofit2:converter-simplexml

JAXB: com.squareup.retrofit2:converter-jaxb

5. 总结

1. Retrofit是基于RESTfull的网络请求框架，底层是使用OKHTTPClient完成网络请求；
2. 注解+Java接口声明请求及参数；
3. 支持异步和同步；
4. 支持数据解析器Converter，支持自定义