play框架手册-09.异步任务

09.异步Jobs

因为play是一个web应用程序，因此许多应用程序逻辑都是由控制器返回给http请求的。

但有些时候，我们需要在http请求外执行一些应用逻辑。比如非常有用的初始化任务，维护任务或运行不能被http请求池中断的长时运行的任务等等。

Jobs可以被框架全面进行管理。意思是play负责管理所有的数据库连接原料stuff，JPA实体管理器负责管理数据同步和事务管理。要想创建一个job，只需要继承play.jobs.Job即可。

package jobs;

import play.jobs.*;

public class MyJob extends Job {

public void doJob() {

//在这儿执行某些逻辑

}

}

有些时候需要任务返回结果，这时就需要重载doJobWithResult()方法。

package jobs;

import play.jobs.*;

public class MyJob extends Job {

public String doJobWithResult() {

//在这儿执行某些逻辑

return result;

}

}

本示例仅使用了String作为返回类型，当然可以返回任何对象类型。

引导程序任务Bootstrap jobs

引导程序任务会在play应用启动时执行。要想实现该任务，只需要在你的任务上添加@OnApplicationStart注释：

import play.jobs.*;

@OnApplicationStart

public class Bootstrap extends Job {

public void doJob() {

if(Page.count() == 0) {

new Page("root").save();

("A root page has been created.");

}

}

}

注意：在这里不需要返回结果，即使这样做了，结果也会丢失。

默认情况下，所有标识为@OnApplicationStart的任务都将以队列方式执行。当所有的job执行结束后，应用程序才正式启动并开始处理请求。

如果你打算让你的任务在应用程序启动时执行，但你又想立即管理进行请求处理，那么可以使用@OnApplicationStart(async=true)注释。然后，你的job将在后台启动。

警告！

当运行于DEV模式时，应用程序将在第一个请求到达时才启动。此外，在DEV 模式时，在需要的时候，应用程序会自动重启。

当运行于PROD模式时，应用程序将和服务器一起同步启动。

预定义任务Scheduled jobs

预定义任务由框架周期性执行。你可以使用@Every注释要求play在一个特定的周期内运行job。

import play.jobs.*;

@Every("1h")

public class Bootstrap extends Job {

public void doJob() {

List newUsers = User.find("newAccount = true").fetch(); for(User user : newUsers) {

Notifier.sayWelcome(user);

}

}

}

如果@Every注释还不足以满足需要，你可使用带有CRON表达式的@On注释来运行你的job。

import play.jobs.*;

/** Fire at 12pm (noon) every day **/

@On("0 0 12 * * ?")

public class Bootstrap extends Job {

public void doJob() {

("Maintenance job ...");

...

}

}

小建议

我们是使用Quartz library来解析CRON表达式的。

你不能返回结果，即使这样做了，结果也会被丢弃。

触发任务job

调用Job实例的now()方法可以在任何时候触发job来执行一段特定的任务。这个时候，job将以非阻塞方式立即执行。

public static void encodeVideo(Long videoId) {

new VideoEncoder(videoId).now();

renderText("Encoding started");

}

调用job的now()方法以返回一个Promise值。

停止应用程序

使用@OnApplicationStop注释可以在应用程序关闭时执行某些操作。import play.jobs.*;

@OnApplicationStop

public class Bootstrap extends Job {

public void doJob() {

Fixture.deleteAll();

}

}