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 的两个方法 successfailure,你可以在对应的回调方法中实现你想在请求结束做的事情,下面的代码示例展示了一个实现的例子。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容