play框架08--Job异步处理

8.1、Job实现

    在Play中建立Job只需要继承play.jobs.Job类:

package jobs;
 
import play.jobs.*;
 
public class MyJob extends Job {
   
   
public void doJob() {
       
// 执行一些业务逻辑
   
}
}

      如果希望创建具有返回值的Job,那么需要覆盖doJobWithResult()方法:

package jobs;
 
import play.jobs.*;
 
public class MyJob extends Job<String> {
   
   
public String doJobWithResult() {
       
// 执行一些业务逻辑
       
return result;
   
}
   
}

      上例自定义的Job覆盖了doJobWithResult()方法,并且方法的返回类型为String,事实上Job可以返回任何类型的值。

8.2、Bootstrap Job

8.2.1 应用启动#

      Bootstrap Job,顾名思义就是在应用开始时运行的任务,只需要添加@OnApplicationStart注解就可以把当前Job设置为Bootstrap Job:

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.");
       
}
   
}
   
}
      需要注意的是,Bootstrap Job不需要任何返回值。如果有多个带有@OnApplicationStart注解的Bootstrap Job,那么默认情况下这些Job会按照定义的先后顺序执行。当所有的Bootstrap Job执行完成之后,Web应用就处于等待阶段,等待处理那些即将到来的请求。

      如果希望Web应用启动后,能够在执行Bootstrap Job的同时,又能很快地处理到来的请求,可以为@OnApplicationStart注解添加async=true属性:@OnApplicationStart(async=true)。这样应用程序开启后,Bootstrap Job就会作为后台程序异步执行了。不仅如此,所有的异步Job(async=true)也会在Web应用开启之后同时运行。


注意:

Play具有两种不同的工作模式:开发模式(DEV)和产品模式(PROD),因此Job的启动时间也有略微差异。在DEV模式下,直到第一个HTTP请求到达时才会开启应用,且不会预先编译Java文件。如果在该模式下更改Java源文件可以立即生效,刷新浏览器即可查看修改后的结果。此外,应用还会在需要的时候自动重启;而在PROD模式下,应用会在服务器启动时同步开启,一旦应用开启就会自动编译所有的Java文件,之后不再重载任何文件(包括模板文件和配置文件),所以如果有文件修改必须重启应用才能生效。所以DEV模式下Job会延迟启动。

8.2.2 应用停止#

      Web应用停止或关闭的时候,常常也需要进行一些额外的操作,如进行数据的清理、日志的打印等。如果开发者需要这类任务调度操作,可以使用Play提供的@OnApplicationStop注解。

import play.jobs.*;
 
@OnApplicationStop
public class Bootstrap extends Job {
 
   
public void doJob() {
       
Fixture.deleteAll();
   
}
}

      用法非常简单,继承Job类之后,重写doJob()方法即可。

8.3、Scheduled Job

  Scheduled Job是指可以被框架周期性执行的任务,可以使用@Every注解指定时间间隔控制Scheduled 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注解并不能够完全满足开发需求,比如有时候需要指定Scheduled Job在具体的某个时间点执行。这时候可以使用@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 ...");
       
...
   
}
   
}

      与Bootstrap Job一样,Scheduled Job也是不需要任何返回值的,即使返回了也会丢失。


补充:

@On标签中使用的是Quartz库的CRON表达式。CRON表达式是由7个子表达式组成的字符串,每个子表达式都描述了单独的日程细节。这些子表达式用空格分隔,分别表示:

  • Seconds 秒
  • Minutes 分钟
  • Hours 小时
  • Day-of-Month 一个月中的某一天
  • Month 月
  • Day-of-Week 一周中的某一天
  • Year 年(可选)

具体CRON表达式的例子:"0 0 12 ? * WED",表示“每周三的中午12:00”。

«

8.4、Job的直接调用

Play的Job除了被框架自动调用外,也可以通过now()方法手动调用Job对象的实例,随时触发Job来执行指定任务。使用now()方法调用Job后,任务会立即执行:

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

      now()方法的返回值是Promise对象,通过该值可以在结束后获得Job的执行结果。


猜你喜欢

转载自blog.csdn.net/J_M_S_H_T/article/details/80840941