Handing asynchronous results

Handing asynchronous results

Make controllers asynchronous

在内部,Play自下而上都是异步的。Play以asynchronous,non-blocking的方式处理每个请求。

默认的配置就开启了asynchronous controllers。换句话说,应用的代码应该避免阻塞在controllers中,即controller中的代码会因为一个操作而等待。常见的一些阻塞操作像:JDBC calls,streaming API,HTTP requests and long computations.

尽管可以通过增加默认执行环境的线程数来允许更多的并发请求让阻塞controller去处理,跟随下面的推荐,尽可能的保持controllers异步是它更容易伸缩并保持系统负载下及时的响应。

Creating non-blocking actions

由于Play的工作方式,action的代码必须尽可能的快,即 non-blocking.那么我们应该从action中返回什么如果我们还没能计算出这个结果呢?我们应该返回promise

Java 8 提供了一个通用promise API叫做CompletionStage.一个CompletionStage<Result>将最终被一个Result类型的值赎回。通过使用CompletionStage<Result>替代一个正常的Result,我们可以从action中很快的返回而不阻塞任何东西.一旦Result被赎回Play就会返回。

web client将会阻塞等待直到响应,但server不会有任何的阻塞,并且server的资源可以用来服务其他的client。

How to create a CompletionStage<Result>

去创建一个CompletionStage<Result>,我们需要其他的promise:这个promise会给我们一个真实的值-我们需要的计算结果:

CompletionStage<Double> promiseOfPIValue = computePIAsynchronously();
CompletionStage<Result> promiseOfResult = promiseOfPIValue.thenApply(pi ->
                ok("PI value computed: " + pi)
);

Play的异步API方法给你一个CompletionStage.可能是当你调用一个外部的web service使用play.libs.WSAPI,或是使用Akka to schedule asynchronous tasks又或是使用Actor通过play.libs.Akka与其通信。

一个简单的方式去异步的执行一个代码块并获取CompletionStage是去使用CompletableFuture.supplyAsync()helper:

CompletionStage<Integer> promiseOfInt = CompletableFuture.supplyAsync(() -> intensiveComputation());

注意:
知道promises的代码运行在哪一个线程上很重要。这里的密集运算将被运行在其他的线程上。
通过将其包裹在CompletionStage中是无法将synchronous IO转变为 asynchronous的。如果你不能改变这个应用的架构去避免阻塞操作,那么在一些地方操作被执行的时候,线程将会阻塞。所以使用CompletionStage去包裹操作时,需要去使其运行在分离的execution context中,这里需要配置足够的线程去处理预期的并发。可以参考Understanding Play thread pools了解更多。
这里使用Actors处理阻塞操作也是有帮助的。Actors提供了一个干净的模型处理timeouts和failures,设置阻塞执行的contexts,并且管理可能与该服务相关联的任意状态。Actors提供了类似ScatterGatherFirstCompletedRouter的模式to address simultaneous cache and database requests and allow remote execution on a cluster of backend servers.But an Actor may be overkill depending on what you need.

Using CompletionStage inside an Action

在Action中使用JavaCompletionStage时,您必须作为执行器显式提供HTTP执行上下文,以确保HTTP.Context保留在范围内。如果你没有应用HTTP execution context,你会得到“There is no HTTP Context available from here”的错误当你调用request()或是其他依赖Http.Context的方法。

你可以用play.libs.concurrent.HttpExecutionContext实例通过依赖注入:

public class Application extends Controller {
    @Inject HttpExecutionContext ec;

    public CompletionStage<Result> index() {
        someCompletableFuture.supplyAsync(() -> { 
          // do something with request()
        }, ec.current());
    }
}

Async results

We have been returning Resultup until now.要发送一个异步的结果我们的action需要返回一个CompletionStage<Result>:

public CompletionStage<Result> index() {
    return CompletableFuture.supplyAsync(() -> intensiveComputation())
            .thenApply(i -> ok("Got result: " + i));
}

Actions are asynchronous by default

Play的actions是默认异步的。例如,下面的controller代码,返回的Result的内部包裹了一个promise:

public Result index() {
    return ok("Got request " + request() + "!");
}

注意:无论action的代码返回的是一个Result或是一个CompletionStage<Result>,这两种返回对象都以同样的方式在内部处理。这里又一个单独的Action,是异步的,不是两种。返回一个CompletionStage是一个编写非阻塞代码的技术。

Handling time-outs

正确的去处理超时通常是很有用的,避免一个web浏览器的阻塞和等待如果出现了一些错误。你可以使用play.libs.concurrent.Timeout.timeout方法去包裹一个CompletionStage在一个非阻塞的超时中。

class MyClass implements play.libs.concurrent.Timeout {
    CompletionStage<Double> callWithOneSecondTimeout() {
        return timeout(computePIAsynchronously(), Duration.ofSeconds(1));
    }
}

注意:Timeout与cancellation不同,即使在超时的情况下,即使未返回完成的值,给定的future仍将完成。

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

推荐阅读更多精彩内容