Trong bài viết trước, chúng ta đã cùng nhau tìm hiểu về Quartz Scheduler. Spring framework cũng có một wrapper cho Quartz Scheduler, nên nếu ứng dụng của các bạn sử dụng Spring framework và có nhu cầu sử dụng Quartz Scheduler thì hãy đọc tiếp bài viết này. Mình sẽ hướng dẫn các bạn sử dụng Quartz Scheduler với Spring framework trong bài viết này các bạn nhé!
Đầu tiên, mình sẽ tạo mới một Maven project để làm ví dụ:
Để sử dụng Quartz với Spring framework, các bạn cần khai báo Spring Context Support, Spring Transaction và Quartz Scheduler dependencies như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>5.1.5.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-tx</artifactId> <version>5.1.5.RELEASE</version> </dependency> <dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.3.0</version> </dependency> |
Chúng ta cũng cần khai báo để sử dụng các khái niệm về Job, Trigger và Scheduler tương tự như Quartz Scheduler standalone, trong Spring.
Đầu tiên là về Job.
Chúng ta có 2 cách để khai báo một Quartz Job với Spring bao gồm:
* Khai báo một class với một method của class này sẽ đóng vai trò định nghĩa tác vụ mà chúng ta cần chạy.
* Cách thứ hai là chúng ta sẽ tạo mới một class extend class QuartzJobBean của Spring Quartz.
Mình sẽ tạo mới tập tin cấu hình của Spring spring.xml trong thư mục src/main/resources
như sau:
|
1 2 3 4 5 |
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> </beans> |
Đối với cách thứ nhất, các bạn cần tạo một class với một method bất kỳ, ví dụ của mình như sau:
|
1 2 3 4 5 6 7 8 9 |
package com.huongdanjava.springquartz; public class Hello { public void sayHello() { System.out.println("Hello from Huong Dan Java"); } } |
sau đó, các bạn khai báo Quartz Job trong tập tin spring.xml sử dụng đối tượng MethodInvokingJobDetailFactoryBean như sau:
|
1 2 3 4 5 6 |
<bean id="hello" class="com.huongdanjava.springquartz.Hello"/> <bean id="jobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> <property name="targetObject" ref="hello"/> <property name="targetMethod" value="sayHello"/> </bean> |
với targetObject property của MethodInvokingJobDetailFactoryBean sẽ refer tới bean “hello” của class chúng ta trong Spring container và targetMethod sẽ có giá trị là tên method trong class Hello sẽ thực thi tác vụ.
Đối với cách thứ hai thì chúng ta cần tạo mới class extend abstract class QuartzJobBean (nếu các bạn xem code của QuartzJobBean, các bạn sẽ thấy class này đã implement interface Job của Quartz Scheduler):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
package com.huongdanjava.springquartz; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.springframework.scheduling.quartz.QuartzJobBean; public class Hello extends QuartzJobBean { @Override protected void executeInternal(JobExecutionContext context) throws JobExecutionException { System.out.println("Hello from Huong Dan Java"); } } |
Như các bạn thấy, ở đây chúng ta cần implement phương thức executeInternal() để thực thi tác vụ.
Sau đó, khai báo class này trong Spring container sử dụng đối tượng JobDetailFactoryBean như sau:
|
1 2 3 |
<bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean"> <property name="jobClass" value="com.huongdanjava.springquartz.Hello"/> </bean> |
Nếu các bạn có nhu cầu truyền data vào class Hello, các bạn có thể khai báo sử dụng Setter method để set data này vào class Hello, sau đó sử dụng property jobDataMap của đối tượng JobDetailFactoryBean để ingest data này.
Ví dụ, mình có class Student như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
package com.huongdanjava.springquartz; public class Student { private String name; public Student(String name) { this.name = name; } public String getName() { return name; } public void setName(String name) { this.name = name; } } |
Bây giờ nếu mình muốn sử dụng đối tượng Student trong class Hello thì mình sẽ sử dụng Setter method như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
package com.huongdanjava.springquartz; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.springframework.scheduling.quartz.QuartzJobBean; public class Hello extends QuartzJobBean { private Student student; @Override protected void executeInternal(JobExecutionContext context) throws JobExecutionException { System.out.println("Hello from Huong Dan Java, " + student.getName()); } public void setStudent(Student student) { this.student = student; } } |
Sau đó thì khai báo để ingest đối tượng Student vào class Hello trong khai báo của class JobDetailFactoryBean trong Spring container như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
<bean id="student" class="com.huongdanjava.springquartz.Student"> <constructor-arg value="Khanh"/> </bean> <bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean"> <property name="jobClass" value="com.huongdanjava.springquartz.Hello"/> <property name="jobDataMap"> <map> <entry key="student" value-ref="student"/> </map> </property> </bean> |
Tiếp theo là về Trigger.
Spring cũng hỗ trợ cho chúng ta 2 cách để tạo Trigger giống như Quartz Scheduler standalone bao gồm: Simple Trigger và Cron Trigger.
Với Simple Trigger, chúng ta sẽ sử dụng class SimpleTriggerFactoryBean để tạo trigger.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
<bean id="student" class="com.huongdanjava.springquartz.Student"> <constructor-arg value="Khanh"/> </bean> <bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean"> <property name="jobClass" value="com.huongdanjava.springquartz.Hello"/> <property name="jobDataMap"> <map> <entry key="student" value-ref="student" /> </map> </property> </bean> <bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean"> <property name="jobDetail" ref="jobDetail" /> <property name="startDelay" value="1000" /> <property name="repeatInterval" value="2000" /> </bean> |
Với Cron Trigger thì chúng ta sẽ sử dụng class CronTriggerFactoryBean:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
<bean id="student" class="com.huongdanjava.springquartz.Student"> <constructor-arg value="Khanh"/> </bean> <bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean"> <property name="jobClass" value="com.huongdanjava.springquartz.Hello"/> <property name="jobDataMap"> <map> <entry key="student" value-ref="student"/> </map> </property> </bean> <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean"> <property name="jobDetail" ref="jobDetail"/> <property name="cronExpression" value="0/5 * * * * ?"/> </bean> |
Nếu các bạn để ý, các bạn sẽ thấy, điểm khác biệt khi khai báo Trigger trong Spring là Spring cho phép chúng ta cấu hình Trigger sẽ chạy cho Job nào luôn và khi cấu hình cho Scheduler, chúng ta sẽ không cần cấu hình Job cho Scheduler nữa.
Cuối cùng là phần cấu hình cho Scheduler.
Chúng ta sẽ cấu hình Scheduler trong Spring sử dụng class SchedulerFactoryBean như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
<bean id="student" class="com.huongdanjava.springquartz.Student"> <constructor-arg value="Khanh"/> </bean> <bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean"> <property name="jobClass" value="com.huongdanjava.springquartz.Hello"/> <property name="jobDataMap"> <map> <entry key="student" value-ref="student"/> </map> </property> </bean> <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean"> <property name="jobDetail" ref="jobDetail"/> <property name="cronExpression" value="0/5 * * * * ?"/> </bean> <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref bean="cronTrigger" /> </list> </property> </bean> |
OK, đến đây thì chúng ta đã cấu hình xong Job, Trigger và Scheduler của Quartz Scheduler với Spring framework rồi đó các bạn.
Nội dung tập tin cấu hình của Spring lúc này sẽ như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> <bean id="student" class="com.huongdanjava.springquartz.Student"> <constructor-arg value="Khanh"/> </bean> <bean id="jobDetail" class="org.springframework.scheduling.quartz.JobDetailFactoryBean"> <property name="jobClass" value="com.huongdanjava.springquartz.Hello"/> <property name="jobDataMap"> <map> <entry key="student" value-ref="student"/> </map> </property> </bean> <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean"> <property name="jobDetail" ref="jobDetail"/> <property name="cronExpression" value="0/5 * * * * ?"/> </bean> <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref bean="cronTrigger" /> </list> </property> </bean> </beans> |
Mình sẽ tạo mới class main để chạy ứng dụng này:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
package com.huongdanjava.springquartz; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class Application { public static void main(String[] args) { ApplicationContext ac = new ClassPathXmlApplicationContext("spring.xml"); } } |
Kết quả:
