Play 框架手册(9) – 异步 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<String> {

    public String doJobWithResult() {
        //在这儿执行某些逻辑
        return result;
    }

}

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

9.1. 引导程序任务 Bootstrap jobs

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

import play.jobs.*;

@OnApplicationStart
public class Bootstrap extends Job {

    public void doJob() {
        if(Page.count() == 0) {
            new Page("root").save();
            Logger.info("A root page has been created.");
        }
    }

}

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

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

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

警告! 

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

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

9.2. 预定义任务 Scheduled jobs 

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

import play.jobs.*;

@Every("1h")
public class Bootstrap extends Job {

    public void doJob() {
        List<User> 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() {
        Logger.info("Maintenance job ...");
        ...
    }

}

小建议

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

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

9.3. 触发任务 job

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

public static void encodeVideo(Long videoId) {
    new VideoEncoder(videoId).now();
    renderText("Encoding started");
}

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

9.4. 停止应用程序

使用@OnApplicationStop 注释可以在应用程序关闭时执行某些操作。

import play.jobs.*;

@OnApplicationStop
public class Bootstrap extends Job {

    public void doJob() {
        Fixture.deleteAll();
    }
}

 


前一篇:
后一篇:

发表评论