Retrofit——API声明 2

今天继续讲Retrofit的API声明，今天会讲Retrofit如何实现Form表单，也就是post方式请求。还有Multipart的put方式请求，Header的操作，以及同步和异步请求。

Form encoded和Multipart

请求方法也可以被定义为发送form-encoded和multipart形式。

当请求方法使用@FormUrlEncoded时，Form-encoded数据将被发送。每个键-值对带@Field注解，包含名称和对象提供的值。

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

当请求方法使用@Multipart时，Multipart雪菊将别发送。使用@Part注解来声明Parts。

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

Multipart使用Retrofit的一个converter或能实现RequestBody来处理他们自己的序列化。

Header操作

你可以使用@header注解来为一个请求方法设置一个静态header。

@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);

注意，header不会互相覆盖，所有具有相同名字的header将被包含在请求中。

使用@Header注解，可以让一个请求的header能够被动态更新。一个对应的参数必须提供给@Header。如果这个值是null，那么这个header将被忽略，否则，将调用这个对象的toString方法作为结果来使用。

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

如果需要Header添加到每个请求，你可以使用一个OkHttp拦截器来指定。

同步vs异步

Call实例能够被执行为同步或异步方式，每个实例仅能被用一次，但是调用clone方法将创建一个新的实例用来使用。

在android中，回调将被执行在主线程，在JVM中，回调将发生在同样的线程执行Http请求。