Retrofit-同步和异步请求

原文地址

Retrofit — Synchronous and Asynchronous Requests

同步请求

在Retrofit1.9中，同步请求通过声明一个返回类型，下面的例子展示了在执行 getTasks 方法时会返回一个task类型的列表

Retrofit 1.9

public interface TaskService {  
    @GET("/tasks")
    List<Task> getTasks();
}

Retrofit 2

public interface TaskService {  
    @GET("/tasks")
    Call<List<Task>> getTasks();
}

在Retrofit 2中，每个请求被包装成一个 Call 对象，实际上同步和异步请求在执行请求方法后创建了一个Call类型的对象。在Retrofit2中，同步和异步请求的接口定义是一样的。同步方法被执行在主线程，这意味着UI线程将会被阻塞在请求执行的时间段内。

Warning: 同步请求可能是导致APP在4.0及以上版本崩溃的原因，你可能会得到一个 NetworkOnMainThreadException 的异常错误

同步方法提供了直接实时返回值的能力，因为这个操作在进行网络请求时会阻塞一切，为了不阻塞UI，你不得不将这个操作放在其他的线程中并将请求结果handle出来，这样就能在等待返回期间继续操作主线程。

从同步请求中取数据

让我们先回到请求上，同步请求在Retrofit从v1版本到v2版本已经有了改变，下面的代码示例展示了用Retrofit进行同步请求， ServiceGenerator 这个在前面的文章中已经有说明。

Retrofit 1.9

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
List<Task> tasks = taskService.getTasks();  

Retrofit 2

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
Call<List<Task>> call = taskService.getTasks();  
List<Task>> tasks = call.execute().body();

在Retrofit 2中调用这个call对象的 execute() 方法会产生同步请求，返回的对象通过 body() 方法获取反序列化出来的数据。

异步请求

相对于同步请求，Retrofit也同时支持异步请求，Retrofit 1.9中异步请求是没有返回值的，定义的方法需要一个 callback 作为最后一个参数。

Retrofit 1.9

public interface TaskService {  
    @GET("/tasks")
    void getTasks(Callback<List<Task>> cb);
}

Retrofit 2

public interface TaskService {  
    @GET("/tasks")
    Call<List<Task>> getTasks();
}

Retrofit在一个另外的线程中执行这个方法，这个 Callback 是一个通用的类并且会匹配你定义的返回类型。我们的例子返回了一个tasks的list，在Callback内部自己做了映射。
前面已经提到在Retrofit 2中同步请求和异步请求定义的接口是一样的，目标返回类型被封装成一个 Call 对象，实际的请求类型在泛型中。

从异步请求中取数据

使用异步请求会让你强制实现 Callback 的两个方法 success 和 failure，你可以在对应的回调方法中实现你想在请求结束做的事情，下面的代码示例展示了一个实现的例子。

Retrofit 1.9

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
taskService.getTasks(new Callback<List<Task>>() {  
    @Override
    public void success(List<Task> tasks, Response response) {
        // here you do stuff with returned tasks
    }

    @Override
    public void failure(RetrofitError error) {
        // you should handle errors, too
    }
});

Retrofit 2

TaskService taskService = ServiceGenerator.createService(TaskService.class);  
Call<List<Task>> call = taskService.getTasks();  
call.enqueue(new Callback<List<Task>>() {  
    @Override
    public void onResponse(Call<List<Task>> call, Response<List<Task>> response) {
        if (response.isSuccessful()) {
            // tasks available
        } else {
            // error response, no access to resource?
        }
    }

    @Override
    public void onFailure(Call<List<Task>> call, Throwable t) {
        // something went completely south (like no internet connection)
        Log.d("Error", t.getMessage());
    }
}

得到原始的HTTP请求返回数据

有时候我们需要拿到原始的HTTP返回的数据而不是经过映射后的数据，只需要将 Response 定义成函数的返回，这个类的使用方法和其他的类一样。

Retrofit 1.9

// synchronous
@GET("/tasks")
Response getTasks();

// asynchronous
@GET("/tasks")
void getTasks(Callback<Response> cb);  

Retrofit 2

接收原始返回数据的方式从Retrofit v1到v2版本定义上是一样的（无论是同步还是异步），也就是说，你不需要额外定义一个 Response 类做为一个返回类型，但是你可以拿到返回值在 onResponse() 的回调中，下面就是代码的示例展示如何获取原始的数据。

call.enqueue(new Callback<List<Task>>() {  
    @Override
    public void onResponse(Call<List<Task>> call, Response<List<Task>> response) {
        // get raw response
        Response raw = response.raw();
    }

    @Override
    public void onFailure(Call<List<Task>> call, Throwable t) {}
}

Additional Resources

Retrofit API declaration, section synchronous vs. asynchronous vs. observable