Android网络请求框架之Retrofit

Retrofit

• Square出品
• 底层使用OkHttp
• 用注解配置请求参数
• 可以与RxJava联用

项目地址

https://github.com/square/retrofit

使用说明

http://square.github.io/retrofit/

Gradle：

compile 'com.squareup.retrofit2:retrofit:2.1.0'

将HTTP API 转为 interface

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

Retrofit 自动生成interface的实现

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

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

同步或异步请求

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

请求方式

必须配置请求方式及关联的Url，内置五种注解：GET, POST, PUT, DELETE, HEAD，关联的Url在注解里指定

@GET("users/list")
@GET("users/list?sort=desc") // 同时指定参数

URL操作

请求URL可以通过替换模块动态来改变，替换模块是{ }包含着的字母数字字符串，替换的参数必须使用@Path注解的相同字符串

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

也可添加查询参数

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

可以使用Map组合复杂的参数

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

请求主体 Request Body

使用@Body注解可以指定一个对象作为request body

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

对象会被Retrofit实例中指定的转换器转换，如果没有添加转换器，只能使用RequestBody

FORM ENCODED AND MULTIPART

Methods can also be declared to send form-encoded and multipart data.
Form-encoded data is sent when @FormUrlEncoded
is present on the method. Each key-value pair is annotated with @Field
containing the name and the object providing the value.

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

Multipart requests are used when @Multipart
is present on the method. Parts are declared using the @Part
annotation.

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

Multipart parts use one of Retrofit
's converters or they can implementRequestBody
to handle their own serialization.

Header 操作

使用@Headers注解来设置固定的header

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

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

所有的header不会相互覆盖，即使名字相同，他们全都会包含在请求中。
请求头也可以使用@@Header注解来动态更新，匹配的参数必须提供给@header，如果参数值为null，这个头会被省略。不然，会使用参数值的toSting方法的返回值。

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

所有的请求都要使用的头可以用OkHttp intercepto来指定。

同步 VS 异步

call实例可以同步或异步执行，每个实例只能使用一次，调用clone()可以创建一个新的可用的实例。
在Android上，callbacks会在主线程上执行；在JVM上，callbacks会在调用HTTP Request的线程上执行。

自带转换器

默认情况下，Retrofit只能反序列化Http bodies为OkHttp的ResponseBody且只能接受它为@Body的类型。
转换器用来支持别的类型，有6个适配流行序列化库的姐妹模块方便你的使用。

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

自定义转换器

继承Converter.Factory class

混淆配置

# Platform calls Class.forName on types which do not exist on Android to determine platform.
-dontnote retrofit2.Platform
# Platform used when running on RoboVM on iOS. Will not be used at runtime.
-dontnote retrofit2.Platform$IOS$MainThreadExecutor
# Platform used when running on Java 8 VMs. Will not be used at runtime.
-dontwarn retrofit2.Platform$Java8
# Retain generic type information for use by reflection by converters and adapters.
-keepattributes Signature
# Retain declared checked exceptions for use by a Proxy instance.
-keepattributes Exceptions

---

其他框架

android-async-http
老旧，已经很久没更新

---