Retrofit2（提高篇）

@HTTP

• 作用：替换@GET、@POST、@PUT、@DELETE、@HEAD注解的作用 及 更多功能拓展
• 具体使用：通过属性method、path、hasBody进行设置

public interface GetRequest_Interface {
    /**
     * method：网络请求的方法（区分大小写）
     * path：网络请求地址路径
     * hasBody：是否有请求体
     */
    @HTTP(method = "GET", path = "blog/{id}", hasBody = false)
    Call<ResponseBody> getCall(@Path("id") int id);
    // {id} 表示是一个变量
    // method 的值 retrofit 不会做处理，所以要自行保证准确
}

 

 

@FormUrlEncoded

• 作用：表示发送form-encoded的数据

@Multipart

• 作用：表示发送form-encoded的数据（适用于 有文件 上传的场景） 

/**
 *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
 * @Field("username") 表示将后面的 String name 中name的取值作为 username 的值
 */
@POST("/form")
@FormUrlEncoded
Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);

/**
 * {@Part} 后面支持三种类型，{RequestBody}、{okhttp3.MultipartBody.Part} 、任意类型
 * 除 {okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段({okhttp3.MultipartBody.Part} 中已经包含了表单字段的信息)，
 */
@POST("/form")
@Multipart
Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

// 具体使用
       GetRequest_Interface service = retrofit.create(GetRequest_Interface.class);
        // @FormUrlEncoded 
        Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);

        //  @Multipart
        RequestBody name = RequestBody.create(textType, "Carson");
        RequestBody age = RequestBody.create(textType, "24");

        MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
        Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);

 

 

@Header & @Headers

 

• 作用：添加请求头 &添加不固定的请求头
• 具体使用如下：

// @Header
@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)

// @Headers
@Headers("Authorization: authorization")
@GET("user")
Call<User> getUser()

// 以上的效果是一致的。
// 区别在于使用场景和使用方式
// 1. 使用场景：@Header用于添加不固定的请求头，@Headers用于添加固定的请求头
// 2. 使用方式：@Header作用于方法的参数；@Headers作用于方法

 

@Body

 

• 作用：以 Post方式 传递 自定义数据类型 给服务器
• 特别注意：如果提交的是一个Map，那么作用相当于 @Field 

不过Map要经过 FormBody.Builder 类处理成为符合 Okhttp 格式的表单，如：

FormBody.Builder builder = new FormBody.Builder();
builder.add("key","value");

 

@Field & @FieldMap

 

• 作用：发送 Post请求 时提交请求的表单字段
• 具体使用：与 @FormUrlEncoded 注解配合使用

/**
 *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
 * @Field("username") 表示将后面的 String name 中name的取值作为 username 的值
 */
@POST("/form")
@FormUrlEncoded
Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);

/**
 * Map的key作为表单的键
 */
@POST("/form")
@FormUrlEncoded
Call<ResponseBody> testFormUrlEncoded2(@FieldMap Map<String, Object> map);

// 具体使用
// @Field
Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);

// @FieldMap
// 实现的效果与上面相同，但要传入Map
Map<String, Object> map = new HashMap<>();
map.put("username", "Carson");
map.put("age", 24);
Call<ResponseBody> call2 = service.testFormUrlEncoded2(map);

 

@Part & @PartMap

 

• 作用：发送 Post请求 时提交请求的表单字段

  与@Field的区别：功能相同，但携带的参数类型更加丰富，包括数据流，所以适用于 有文件上传 的场景

• 具体使用：与 @Multipart 注解配合使用

/**
 * {@Part} 后面支持三种类型，{RequestBody}、{okhttp3.MultipartBody.Part} 、任意类型
 * 除 {okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段({okhttp3.MultipartBody.Part} 中已经包含了表单字段的信息)，
 */
@POST("/form")
@Multipart
Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

/**
* PartMap 注解支持一个Map作为参数，支持 {RequestBody } 类型，
* 如果有其它的类型，会被{retrofit2.Converter}转换，如后面会介绍的 使用{com.google.gson.Gson} 的 {retrofit2.converter.gson.GsonRequestBodyConverter}
* 所以{MultipartBody.Part} 就不适用了,所以文件只能用@Part MultipartBody.Part
*/
@POST("/form")
@Multipart
Call<ResponseBody> testFileUpload2(@PartMap Map<String, RequestBody> args, @Part MultipartBody.Part file);

@POST("/form")
@Multipart
Call<ResponseBody> testFileUpload3(@PartMap Map<String, RequestBody> args);

// 具体使用
 MediaType textType = MediaType.parse("text/plain");
 RequestBody name = RequestBody.create(textType, "Carson");
 RequestBody age = RequestBody.create(textType, "24");
 RequestBody file = RequestBody.create(MediaType.parse("application/octet-stream"), "这里是模拟文件的内容");

 // @Part
 MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
 Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);
 ResponseBodyPrinter.printResponseBody(call3);

 // @PartMap
 // 实现和上面同样的效果
 Map<String, RequestBody> fileUpload2Args = new HashMap<>();
 fileUpload2Args.put("name", name);
 fileUpload2Args.put("age", age);
 //这里并不会被当成文件，因为没有文件名(包含在Content-Disposition请求头中)，但上面的 filePart 有
 //fileUpload2Args.put("file", file);
 Call<ResponseBody> call4 = service.testFileUpload2(fileUpload2Args, filePart); //单独处理文件
 ResponseBodyPrinter.printResponseBody(call4);

 

@Query和@QueryMap

 

• 作用：用于 @GET 方法的查询参数（Query = Url 中 ‘?’ 后面的 key-value）

  如：url = http://www.println.net/?cate=android，其中，Query = cate

• 具体使用：配置时只需要在接口方法中增加一个参数即可：

@GET("/")    
Call<String> cate(@Query("cate") String cate);

 

@Path

• 作用：URL地址的缺省值
• 具体使用：

@GET("users/{user}/repos")
Call<ResponseBody>  getBlog（@Path("user") String user ）;
// 访问的API是：https://api.github.com/users/{user}/repos
// 在发起请求时， {user} 会被替换为方法的第一个参数 user（被@Path注解作用）

 

@Url

• 作用：直接传入一个请求的 URL变量 用于URL设置
• 具体使用：

@GET
Call<ResponseBody> testUrlAndQuery(@Url String url, @Query("showAll") boolean showAll);
// 当有URL注解时，@GET传入的URL就可以省略
// 当GET、POST...HTTP等方法中没有设置Url时，则必须使用 {@Url}提供