本篇內容介紹了“Spring Boot集成quartz如何實現(xiàn)定時任務并支持切換任務數(shù)據源”的有關知識,在實際案例的操作過程中,不少人都會遇到這樣的困境,接下來就讓小編帶領大家學習一下如何處理這些情況吧!希望大家仔細閱讀,能夠學有所成!

創(chuàng)新互聯(lián)是專業(yè)的紅崗網站建設公司,紅崗接單;提供做網站、網站制作,網頁設計,網站設計,建網站,PHP網站建設等專業(yè)做網站服務;采用PHP框架,可快速的進行紅崗網站開發(fā)網頁制作和功能擴展;專業(yè)做搜索引擎喜愛的網站,專業(yè)的做網站團隊,希望更多企業(yè)前來合作!
在工作中經常會需要使用到定時任務處理各種周期性的任務,org.quartz是處理此類定時任務的一個優(yōu)秀框架。隨著項目一點點推進,此時我們并不滿足于任務僅僅是定時執(zhí)行,我們還想要對任務進行更多的控制,隨時能對任務進行人為干預,就需要對quartz有更深入的了解。而隨著微服務的流行,項目中多數(shù)據源的情況也越來越常見,在定時任務中集成多數(shù)據源切換的功能也需要集成進來。
集成quartz實現(xiàn)定時任務
通過實現(xiàn)Job類,在實現(xiàn)方法中寫我們具體想要定時任務完成的工作,然后交給quartz管理。
Job只負責實現(xiàn)具體任務,所以還需要借助JobDetail來存儲一些描述Job的基本信息。
為構造JobDetail實體提供的builder-style API。你可以這樣使用它來構建一個JobDetail:
@Bean
public JobDetail jobDetail() {
return JobBuilder.newJob().ofType(SampleJob.class)
.storeDurably()
.withIdentity("Qrtz_Job_Detail")
.withDescription("Invoke Sample Job service...")
.build();
}在Spring中配置JobDetail的方式:
@Bean
public JobDetailFactoryBean jobDetail() {
JobDetailFactoryBean jobDetailFactory = new JobDetailFactoryBean();
jobDetailFactory.setJobClass(SampleJob.class);
jobDetailFactory.setDescription("Invoke Sample Job service...");
jobDetailFactory.setDurability(true);
return jobDetailFactory;
}觸發(fā)器,代表一個調度參數(shù)的配置,什么時候去調度:
@Bean
public Trigger trigger(JobDetail job) {
return TriggerBuilder.newTrigger().forJob(job)
.withIdentity("Qrtz_Trigger")
.withDescription("Sample trigger")
.withSchedule(simpleSchedule().repeatForever().withIntervalInHours(1))
.build();
}調度器,通過Job和Trigger來注冊一個調度器:
@Bean
public Scheduler scheduler(Trigger trigger, JobDetail job) {
StdSchedulerFactory factory = new StdSchedulerFactory();
factory.initialize(new ClassPathResource("quartz.properties").getInputStream());
Scheduler scheduler = factory.getScheduler();
scheduler.setJobFactory(springBeanJobFactory());
scheduler.scheduleJob(job, trigger);
scheduler.start();
return scheduler;
}在quartz中Job就是我們需要去執(zhí)行的任務,由Scheduler調度器負責調度任務們依靠制定好的Trigger來定時執(zhí)行任務。
因此首先我們需要結合以上基礎給系統(tǒng)添加一個Job。
public void addJob(BaseJob job) throws SchedulerException {
/** 創(chuàng)建JobDetail實例,綁定Job實現(xiàn)類
* JobDetail 表示一個具體的可執(zhí)行的調度程序,job是這個可執(zhí)行調度程序所要執(zhí)行的內容
* 另外JobDetail還包含了這個任務調度的方案和策略**/
// 指明job的名稱,所在組的名稱,以及綁定job類
JobDetail jobDetail = JobBuilder.newJob(job.getBeanClass())
.withIdentity(job.getJobKey())
.withDescription(job.getDescription())
.usingJobData(job.getDataMap())
.build();
/**
* Trigger代表一個調度參數(shù)的配置,什么時候去調度
*/
//定義調度觸發(fā)規(guī)則, 使用cronTrigger規(guī)則
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity(job.getJobName(),job.getJobGroup())
.withSchedule(CronScheduleBuilder.cronSchedule(job.getCronExpression()))
.startNow()
.build();
//將任務和觸發(fā)器注冊到任務調度中去
scheduler.scheduleJob(jobDetail,trigger);
//判斷調度器是否啟動
if(!scheduler.isStarted()){
scheduler.start();
}
log.info(String.format("定時任務:%s.%s-已添加到調度器!", job.getJobGroup(),job.getJobName()));
}首先需要定義好我們的Job,之后通過Job初始化JobDetail和Trigger,最后將JobDetail和Trigger注冊到調度器中。
Job的結構如下:
public abstract class BaseJob implements Job,Serializable {
private static final long serialVersionUID = 1L;
private static final String JOB_MAP_KEY = "self";
/**
* 任務名稱
*/
private String jobName;
/**
* 任務分組
*/
private String jobGroup;
/**
* 任務狀態(tài) 是否啟動任務
*/
private String jobStatus;
/**
* cron表達式
*/
private String cronExpression;
/**
* 描述
*/
private String description;
/**
* 任務執(zhí)行時調用哪個類的方法 包名+類名
*/
private Class beanClass = this.getClass();
/**
* 任務是否有狀態(tài)
*/
private String isConcurrent;
/**
* Spring bean
*/
private String springBean;
/**
* 任務調用的方法名
*/
private String methodName;
/**
* 該任務所使用的數(shù)據源
*/
private String dataSource = DataSourceEnum.DB1.getName();
/**
* 為了將執(zhí)行后的任務持久化到數(shù)據庫中
*/
@JsonIgnore
private JobDataMap dataMap = new JobDataMap();
public JobKey getJobKey(){
return JobKey.jobKey(jobName, jobGroup);// 任務名稱和組構成任務key
}
...
}可以看到Job中定義了任務的一些基本信息,重點關注其中的dataSource和dataMap屬性。其中dataSource是任務所使用的數(shù)據源,并給了一個默認值;由于任務在添加后會持久化到數(shù)據庫中,之后解析任務就會用到dataMap。
在添加Job的時候,JobDetail和Trigger都是通過關鍵字new生成的,而調度器Scheduler則需要放在容器中維護。
@Configuration
@Order
public class SchedulerConfig {
@Autowired
private MyJobFactory myJobFactory;
@Value("${spring.profiles.active}")
private String profile;
/*
* 通過SchedulerFactoryBean獲取Scheduler的實例
*/
@Bean(name = "scheduler")
public Scheduler scheduler() throws Exception {
return schedulerFactoryBean().getScheduler();
}
@Bean
public SchedulerFactoryBean schedulerFactoryBean() throws IOException {
SchedulerFactoryBean factory = new SchedulerFactoryBean();
factory.setOverwriteExistingJobs(true);
// 延時啟動
factory.setStartupDelay(20);
// 加載quartz數(shù)據源配置
factory.setQuartzProperties(quartzProperties());
// 自定義Job Factory,用于Spring注入
factory.setJobFactory(myJobFactory);
/*********全局監(jiān)聽器配置************/
JobListener myJobListener = new SchedulerListener();
factory.setGlobalJobListeners(myJobListener);//直接添加為全局監(jiān)聽器
return factory;
}
@Bean
public Properties quartzProperties() throws IOException {
PropertiesFactoryBean propertiesFactoryBean = new PropertiesFactoryBean();
if (Util.PRODUCT.equals(profile)) {//正式環(huán)境
System.out.println("正式環(huán)境quartz配置");
propertiesFactoryBean.setLocation(new ClassPathResource("/quartz-prod.properties"));
} else {
System.out.println("測試環(huán)境quartz配置");
propertiesFactoryBean.setLocation(new ClassPathResource("/quartz.properties"));
}
//在quartz.properties中的屬性被讀取并注入后再初始化對象
propertiesFactoryBean.afterPropertiesSet();
return propertiesFactoryBean.getObject();
}
/*
* quartz初始化監(jiān)聽器
*/
@Bean
public QuartzInitializerListener executorListener() {
return new QuartzInitializerListener();
}
}上述代碼中,將scheduler加入到Spring容器中。scheduler是由SchedulerFactoryBean進行維護的,在SchedulerFactoryBean中對調度器工廠做了一些基本設置并從配置文件中加載了quartz數(shù)據源配置(配置文件的讀取會根據運行環(huán)境profile來進行自動切換),配置了一個全局監(jiān)聽器用以監(jiān)聽任務的執(zhí)行過程。
使用Spring提供的JobFactory。
@Component
public class MyJobFactory extends AdaptableJobFactory {
@Autowired
private AutowireCapableBeanFactory capableBeanFactory;
@Override
protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
// 調用父類的方法
Object jobInstance = super.createJobInstance(bundle);
// 進行注入
capableBeanFactory.autowireBean(jobInstance);
return jobInstance;
}
}quartz.properties中是quartz連接數(shù)據庫的一些配置信息。
# \u56FA\u5B9A\u524D\u7F00org.quartz # \u4E3B\u8981\u5206\u4E3Ascheduler\u3001threadPool\u3001jobStore\u3001plugin\u7B49\u90E8\u5206 # # org.quartz.scheduler.instanceName = DefaultQuartzScheduler org.quartz.scheduler.rmi.export = false org.quartz.scheduler.rmi.proxy = false org.quartz.scheduler.wrapJobExecutionInUserTransaction = false # \u5B9E\u4F8B\u5316ThreadPool\u65F6\uFF0C\u4F7F\u7528\u7684\u7EBF\u7A0B\u7C7B\u4E3ASimpleThreadPool org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool # threadCount\u548CthreadPriority\u5C06\u4EE5setter\u7684\u5F62\u5F0F\u6CE8\u5165ThreadPool\u5B9E\u4F8B # \u5E76\u53D1\u4E2A\u6570 org.quartz.threadPool.threadCount = 5 # \u4F18\u5148\u7EA7 org.quartz.threadPool.threadPriority = 5 org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true org.quartz.jobStore.misfireThreshold = 5000 # \u9ED8\u8BA4\u5B58\u50A8\u5728\u5185\u5B58\u4E2D #org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore #\u6301\u4E45\u5316 org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX #org.quartz.jobStore.useProperties=false org.quartz.jobStore.tablePrefix = QRTZ_ org.quartz.jobStore.dataSource = qzDS org.quartz.dataSource.qzDS.driver = com.MySQL.jdbc.Driver org.quartz.dataSource.qzDS.URL=jdbc:mysql://127.0.0.1:3306/quartz?characterEncoding=UTF-8&useSSL=false&testOnBorrow=true&testWhileIdle=true org.quartz.dataSource.qzDS.user=quartz org.quartz.dataSource.qzDS.password=123456 org.quartz.dataSource.qzDS.maxConnections = 30 org.quartz.dataSource.qzDS.validationQuery = SELECT 1 FROM DUAL org.quartz.dataSource.qzDS.validateOnCheckout = true org.quartz.dataSource.qzDS.idleConnectionValidationSeconds = 40 #org.quartz.dataSource.qzDS.discardIdleConnectionsSeconds = 60
quartz會根據這個配置文件將Job持久化到數(shù)據庫中,也因此quartz會需要初始化一些數(shù)據庫表,表結構文件在文末。
調度器監(jiān)聽器用以監(jiān)聽任務的執(zhí)行狀態(tài)。
public class SchedulerListener implements JobListener {
private final Logger LOG = LoggerFactory.getLogger(SchedulerListener.class);
public static final String LISTENER_NAME = "QuartSchedulerListener";
@Override
public String getName() {
return LISTENER_NAME; //must return a name
}
//任務被調度前
@Override
public void jobToBeExecuted(JobExecutionContext context) {
String dataSource = context.getJobDetail().getJobDataMap().getString("dataSource");
// 切換任務的數(shù)據源
DataSourceContextHolder.setDB(dataSource);
String jobName = context.getJobDetail().getKey().toString();
LOG.info("Job {} is going to start,switch dataSource to {},Thread name {}", jobName, dataSource, Thread.currentThread().getName());
}
//任務調度被拒了
@Override
public void jobExecutionVetoed(JobExecutionContext context) {
String jobName = context.getJobDetail().getKey().toString();
LOG.error("job {} is jobExecutionVetoed", jobName);
//可以做一些日志記錄原因
}
//任務被調度后
@Override
public void jobWasExecuted(JobExecutionContext context,
JobExecutionException jobException) {
// 清空存儲的數(shù)據源
String jobName = context.getJobDetail().getKey().toString();
DataSourceContextHolder.clearDB();
LOG.info("Job : {} is finished", jobName);
if (jobException != null && !jobException.getMessage().equals("")) {
LOG.error("Exception thrown by: " + jobName
+ " Exception: " + jobException.getMessage());
}
}
}SchedulerListener監(jiān)聽任務被調度前、調度后和調度被拒絕時的狀態(tài),在任務被調度之前和之后對任務所使用的數(shù)據源進行了處理。如果項目中不需要數(shù)據源切換的話,這個監(jiān)聽器是不需要的,到此已經完成了quartz的集成。
多數(shù)據源切換
通過自定義DynamicDataSource來覆蓋Spring Boot中原有的數(shù)據源。
通過讀取配置文件中不同的數(shù)據源,初始化項目中可能用到的數(shù)據源用以切換。
/**
* 多數(shù)據源配置類
*/
@Configuration
public class DataSourceConfig {
//數(shù)據源1
@Bean(name = "datasource1")
@ConfigurationProperties(prefix = "spring.datasource.db1") // application.properteis中對應屬性的前綴
public DataSource dataSource1() {
return DataSourceBuilder.create().build();
}
//數(shù)據源2
@Bean(name = "datasource2")
@ConfigurationProperties(prefix = "spring.datasource.db2") // application.properteis中對應屬性的前綴
public DataSource dataSource2() {
return DataSourceBuilder.create().build();
}
/**
* 動態(tài)數(shù)據源: 通過AOP在不同數(shù)據源之間動態(tài)切換
*
* @return
*/
@Primary
@Bean(name = "dynamicDataSource")
public DataSource dynamicDataSource() {
DynamicDataSource dynamicDataSource = new DynamicDataSource();
// 默認數(shù)據源
dynamicDataSource.setDefaultTargetDataSource(dataSource1());
// 配置多數(shù)據源
Map<Object, Object> dsMap = new HashMap();
dsMap.put(DataSourceEnum.DB1.getName(), dataSource1());
dsMap.put(DataSourceEnum.DB2.getName(), dataSource2());
dynamicDataSource.setTargetDataSources(dsMap);
return dynamicDataSource;
}
@Bean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
//設置數(shù)據源
sqlSessionFactoryBean.setDataSource(dataSource);
return sqlSessionFactoryBean.getObject();
}
/**
* 配置@Transactional注解事物
*
* @return
*/
@Bean
public PlatformTransactionManager transactionManager() {
return new DataSourceTransactionManager(dynamicDataSource());
}
}spring: datasource: db1: driver-class-name: com.mysql.cj.jdbc.Driver username: doctor password: 123456 type: com.zaxxer.hikari.HikariDataSource jdbc-url: jdbc:mysql://127.0.0.1:3306/doctor?useSSL=false&testOnBorrow=true&testWhileIdle=true db2: driver-class-name: com.mysql.cj.jdbc.Driver username: quartz password: 123456 type: com.zaxxer.hikari.HikariDataSource jdbc-url: jdbc:mysql://127.0.0.1:3307/quartz?useSSL=false&testOnBorrow=true&testWhileIdle=true
由于quartz在執(zhí)行過程中是通過不同的線程來執(zhí)行Job的,因此此處通過ThreadLocal來保存線程所使用的數(shù)據源情況。
/**
* 保存本地數(shù)據源
*/
public class DataSourceContextHolder {
private static final Logger LOG = LoggerFactory.getLogger(DataSourceContextHolder.class);
/**
* 默認數(shù)據源
*/
public static final String DEFAULT_DS = DataSourceEnum.DB1.getName();
/**
* ThreadLocal之后會進行講解
*/
private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();
// 設置數(shù)據源名
public static void setDB(String dbType) {
LOG.info("切換到{}數(shù)據源", dbType);
contextHolder.set(dbType);
}
// 獲取數(shù)據源名
public static String getDB() {
return (contextHolder.get());
}
// 清除數(shù)據源名
public static void clearDB() {
contextHolder.remove();
}
}獲取執(zhí)行中所使用的數(shù)據源。由于數(shù)據源被保存在了DataSourceContextHolder中的ThreadLocal中,所以直接獲取就行了。
/**
* 獲取本地數(shù)據源
*/
public class DynamicDataSource extends AbstractRoutingDataSource {
private static final Logger LOG = LoggerFactory.getLogger(DynamicDataSource.class);
@Override
protected Object determineCurrentLookupKey() {
LOG.info("數(shù)據源為{}", DataSourceContextHolder.getDB());
return DataSourceContextHolder.getDB();
}
}至此就完成了集成quartz及數(shù)據源切換的功能。然后就是具體的任務了。
具體的任務需要繼承BaseJob并在execute方法中重寫具體需要執(zhí)行的任務。
@Slf4j
@Service
public class ReadNumJob extends BaseJob {
@Autowired
private redisService redisService;
@Autowired
private JdbcTemplate jdbcTemplate;
private final Logger LOG = LoggerFactory.getLogger(ReadNumJob.class);
@Override
public void execute(JobExecutionContext context) {
doSomething();
}
}然后在添加任務時指定任務所使用的數(shù)據源
ReadNumJob job = new ReadNumJob();
job.setJobName("test");
job.setJobGroup("hys");
job.setDescription("test");
// 指定數(shù)據源
job.getDataMap().put("dataSource", DataSourceEnum.DB1.getName());
job.setCronExpression(
"0 */1 * * * ?"
);
try {
jobAndTriggerService.addJob(job);
} catch (SchedulerException e) {
e.printStackTrace();
}“Spring Boot集成quartz如何實現(xiàn)定時任務并支持切換任務數(shù)據源”的內容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業(yè)相關的知識可以關注創(chuàng)新互聯(lián)網站,小編將為大家輸出更多高質量的實用文章!
網站欄目:SpringBoot集成quartz如何實現(xiàn)定時任務并支持切換任務數(shù)據源
文章出自:http://chinadenli.net/article48/goishp.html
成都網站建設公司_創(chuàng)新互聯(lián),為您提供靜態(tài)網站、響應式網站、營銷型網站建設、手機網站建設、App設計、Google
聲明:本網站發(fā)布的內容(圖片、視頻和文字)以用戶投稿、用戶轉載內容為主,如果涉及侵權請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內容未經允許不得轉載,或轉載時需注明來源: 創(chuàng)新互聯(lián)