初识Retrofit2

基本使用

基本的使用方法官网就有一个点这里，步骤大致可能分为以下几步。

1.创建接口，使用注解声明url和参数

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

2.创建Retrofit实例

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

3.创建接口实例

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

4.接口调用

Call> repos = service.listRepos("octocat");

5.发起请求

//同步请求
call.execute();
//异步请求
call.enqueue(new Callback(){
        @Override
        public void onResponse (Call << T > call, Response < Result < User >> response){

    }

        @Override
        public void onFailure (Call << T > call, Throwable throwable){

    }
});

json解析

retrofit支持添加json解析器，将返回的json自动转换成模型。支持的解析器

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
Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

添加Gson解析器

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

baseUrl

Retrofit2 的baseUrl 真的必须以 /（斜线） 结尾吗？

常见注解

@GET

用于get请求，写在方法外，一般后面会跟上请求的路由

@GET("getAll")
Call> getAll();

@Query

设置查询参数，直接拼接在url后面

@GET("getById")
Call> getById(@Query("id") long id);

请求的url：baseUrl/getById?id=真实参数

@QueryMap

和Query的功能一样，用于查询参数很多的时候使用map代替。

@GET("getUser")
Call> getUser(@QueryMap Map params);

请求的url：baseUrl/getById?key1=value1&key2=value2

@Path

路径参数，动态替换url中的参数

@GET("get/{id}")
Call> getWithPath(@Path("id") long id)

请求的url：baseUrl/get/真实参数

@Url

当请求的路由不确定，需要通过参数传递的时候使用

@GET
Call> getDynamicUrl(@Url String url);

@get后面不跟路由，使用参数中的url。

@Headers

静态添加头部信息：包含添加单个头部、添加多个头部

通过@Headers("")注解，内部以key:value的方式填写内容

@GET("getWithHead")
@Headers("name:test")
Call> getWithHead1();

@Header

动态添加单个请求头数据

@GET("getWithHead")
Call> getWithHead2(@Header("name") String name);

@HeaderMap

动态添加多个头部信息，和@Header的功能一样。用map来代替多个参数。

@POST

用于post请求，写在方法外

@FormUrlEncoded

表单请求，和@Field配合使用。会将请求参数转为application/x-www-form-urlencoded

@POST("post")
@FormUrlEncoded
Call> post(@Field("id") long id, @Field("name") String name);

@Field

表单请求的字段，见上例

@FieldMap

多个表单请求的参数

@Body

对应服务端的content-type 是application/json。

对应springBoot中的@RequestBody

@POST("postBody")
Call> postBody(@Body User user);

注意:使用@Body注解的时候要使用json的解析转换。

@Multipart

用于上传文件

包含文件上传的请求不是普通的表单请求。

Content-Type:multipart/form-data

不能使用@FormUrlEncoded，要修改为@Multipar

参数也不能使用@Field，要使用@Part

上传的文件类型要声明称MultipartBody.Part类型。

传参的时候也要麻烦一些。

    public void postFile()throws IOException{

        File file = new File("/Users/yeqiu/Desktop/测试文档/pdf/悟空线上合同模板V20190815.pdf");
        RequestBody fileBody = RequestBody.create(MediaType.parse("file/pdf"), file);
        MultipartBody.Part file1 = MultipartBody.Part.createFormData("file", file.getName(), fileBody);
        
        Call> call = getApi().postFile("悟空线上合同模板V20190815", file1);
        Response> response = call.execute();
        Result result = response.body();
        log(result);
    }

关于一些请求的传参

上传list参数

如果list泛型是基本数据类型可以直接使用list类型的参数。

@POST("post/list")
@FormUrlEncoded
Call> postList(@Field("title") String title,
                              @Field("list") List list);

如果泛型是引用数据类型就，接口方法的参数就要设置成map。

@POST("post/multipart/data")
@Multipart
Call> postMultipartData(@PartMap Map params,
                                       @Part List files);

调用的时候需要使用[]和索引来拼接list数据

@Test
public void postMultipartData() throws IOException {

    User user = new User();
    user.setId(1);
    user.setName("宫本武藏");
    User user2 = new User();
    user2.setId(2);
    user2.setName("蓝色超级兵");
    List users = new ArrayList<>();
    users.add(user);
    users.add(user2);
    
    RequestBody nameBody = RequestBody.create(MediaType.parse("text/plain"), "名字");
    RequestBody titleBody = RequestBody.create(MediaType.parse("text/plain"), "标题");
    Map params = new HashMap<>();
    params.put("name", nameBody);
    params.put("title", titleBody);

    for (int i = 0; i < users.size(); i++) {
        User u1 = users.get(i);
        RequestBody id = RequestBody.create(MediaType.parse("text/plain"), String.valueOf(u1.getId()));
        RequestBody name = RequestBody.create(MediaType.parse("text/plain"), u1.getName());
        params.put("users[" + i + "].id", id);
        params.put("users[" + i + "].name", name);
    }
    
    List files = new ArrayList<>();
    files.add(new File("/Users/yeqiu/Desktop/测试文档/pdf/悟空线上合同模板V20190815.pdf"));
    files.add(new File("/Users/yeqiu/Desktop/测试文档/pdf/表格测试.pdf"));
    files.add(new File("/Users/yeqiu/Desktop/测试文档/pdf/印章位置.pdf"));
    
    List parts = new ArrayList<>();

    for (int i = 0; i < files.size(); i++) {
        File file = files.get(i);
        RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);
        MultipartBody.Part filePart = MultipartBody.Part.createFormData("files[" + i + "]", file.getName(), fileBody);
        parts.add(filePart);
    }

    Call> call = getApi().postMultipartData(params,parts);
    Response> response = call.execute();
    Result