任务调度
任务调度，简单的说就是定时任务的执行。本文实现两种方法，其中第二种方法参考了优秀的开源框架RuoYi的任务调度方法。
-
SpringTask
将注解@Scheduler标注在要执行的方法上，在括号中标注上Cron表达式。本种方法适用于简单的、少量的定时任务，而且是单机的。
首先，引入所需依赖。
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>5.3.15</version> <scope>compile</scope> </dependency> 然后在启动类上标注@EnableScheduling，开启定时任务
@SpringBootApplication @EnableScheduling public class App { public static void main( String[] args ) { SpringApplication.run(App.class,args); } } 接下来就是使用注解，标注定时任务
@Scheduled(cron = "* * * * * ?") public void scheduled(){ //逻辑代码 } Cron表达式，一般是六位，分别代表的是 {秒数} {分钟} {小时} {日期} {月份} {星期}，如果七位，最后一位代表年份。
如果定时任务很多，为了便于管理，定时任务是否执行，以及Cron配置，可以在resource包下新建 ".properties"资源文件，统一管理。
首先，加入依赖。
<!--配置依赖，可以使用@ConfigurationProperties、@PropertySource等配置注解--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>2.6.4</version> </dependency> 然后在定时任务类上标注@PropertySource加载资源文件，用@Component交给spring管理，然后使用@Value(" " ) 获 取 配 置 值 ， c r o n 也 通 过 {}")获取配置值，cron也通过 ")获取配置值，cron也通过{}获取配置的表达式。注意，@Value直接赋值给静态变量是获取不到值的，可以直接赋值给非静态变量。也可以在静态变量的set方法上标注@Value，但是要把set方法上的static去掉，否则也是获取不到值的。
@Component @PropertySource("classpath:test.properties") public class ScheduledTest { private static final Logger logger = LoggerFactory.getLogger(ScheduledTest.class); private static Boolean updateInfoStatus; private static Boolean deleteInfoStatus; public static Boolean getUpdateInfoStatus() { return updateInfoStatus; } @Value("${updateInfo.status}") public void setUpdateInfoStatus(Boolean status) { updateInfoStatus = status; } public static Boolean getDeleteInfoStatus() { return deleteInfoStatus; } @Value("${deleteInfo.status}") public void setDeleteInfoStatus(Boolean status) { deleteInfoStatus = status; } /** * 定时更新 * @auther: YSL * @date: 16:43 2022/3/8 */ @Scheduled(cron = "${updateInfo.cron}") public void updateInfo(){ //没有开启任务，直接退出 if(!updateInfoStatus){ return; } try { //逻辑代码 int i = 1/0; } catch (Exception e) { logger.info("定时任务执行发生异常",e); } } /** * 定时删除 * @auther: YSL * @date: 16:43 2022/3/8 */ @Scheduled(cron = "${deleteInfo.cron}") public void deleteInfo(){ //没有开启任务，直接退出 if(!deleteInfoStatus){ return; } try { //逻辑代码 int i = 1/0; } catch (Exception e) { logger.info("定时任务执行发生异常",e); } } } 本方法最后，直接使用@Scheduler，没有其他配置，则所有的定时任务是单线程执行。意思就是，线程a/b，线程a执行，b不会执行，就算是b时间到了也不执行。
如果要开启多线程的话，增加配置类，设置线程池。同时再启动类上添加@EnableAsync开启异步，否则不执行。
@Configuration public class ScheduledConfig implements SchedulingConfigurer { @Override public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { taskRegistrar.setTaskScheduler(executor()); } @Bean("scheduled") public ThreadPoolTaskScheduler executor(){ ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler(); scheduler.setPoolSize(5); scheduler.setWaitForTasksToCompleteOnShutdown(true);//等待所有线程执行完，再销毁bean scheduler.setAwaitTerminationSeconds(120);//等待多少秒后 强制销毁，避免线程一直阻塞 return scheduler; } } -
Quartz
Quartz功能强大，可以将任务信息持久化到数据库中。可以动态的修改、新增、删除、暂停、回复、立即执行等操作。而且它还支持分布式。
Quartz由三部分组成：
Scheduler容器，所有的启停等操作均由它控制；
Tigger触发器，通俗的理解就是定时器，通过它可以设置任务执行周期、执行时间，通常使用CronTrigger和Trigger分别对应CronScheduleBuilder(cron表达式)和SimpleScheduleBuilder(可以设置时分秒，通过withRepeatCount和repeatForever控制执行次数)，它还可以设置执行策略，立刻开始执行一次，之后按设定触发条件执行、不进行任何操作，按触发条件执行、立即执行，从错过的第一个频率开始立刻执行，执行完错过的所有频率后，按正常触发条件执行。
JobDetail，包含了Job实例的各种属性，Job实例需要实现execute()方法，该方法内是任务执行的各种逻辑，JobDetail包含JobDataMap()可以存放任务信息或者是任务执行时要用到的数据，便于在后面任务执行是获取一些要传递的信息。注：实现execute()方法时要注意，该任务是否可以并发执行，判断条件是：多个线程同时执行该任务对最终结果是否有影响，有影响@DisallowConcurrentExecution注解可以使该任务串行处理，不加这个注解则是并行处理。
下面对Quartz的具体实现流程进行代码演示（从左至右）：
3. 拓展使用
首先我们选择持久化到数据库，所以要先建立两个表格，一个是任务详情表，一个是任务执行日志表，可自行拓展，结构如下：
其次，实现Job类，如果每个定时任务都要实现execute()，很麻烦，为了精简代码，可做如下处理：
1. 只用一个类去实现execute()方法，在方法内部，利用反射或者getBean()等方法去获取任务对应的方法；
2. 因为任务有可串行和不可串行执行两种，所以进一步拓展。用两个类去实现execute()，不可串行的类添加@DisallowConcurrentExecution注解。
3. 进一步精简，用一个抽象类去继承Job并实现execute()，再添加一个抽象方法doExecute()方法，将第二步的两个类改成，去实现抽象类中的抽象方法。然后execute()调用doExecute();
//抽象类去实现Job，因为抽象类无法生成实例所以无法被spring管理，所以如果该类无法使用@Autowired注入，要用getBean()方法获取
public abstract class AbstractJob implements Job {
//打印日志
private static final Logger logger = LoggerFactory.getLogger(AbstractJob.class);
//用本地线程的方式记录时间，保证安全性
private static ThreadLocal<Date> threadLocal = new ThreadLocal<>();
@Override
public void execute(JobExecutionContext context){
before();
SysQuartz sysQuartz = new SysQuartz();
//获取运行前放入的参数
BeanUtils.copyProperties(context.getMergedJobDataMap().get(QuartzUtils.TASK_JOB_DATA_MAP),sysQuartz);
try {
doExecute(context,sysQuartz);
after(sysQuartz,null);
} catch (Exception e) {
logger.info("任务发生异常",e);
after(sysQuartz,e);
}
}
/**
* 运行前操作
*/
private void before(){
threadLocal.set(new Date());
}
/**
* 运行后操作，记录日志
*/
private void after(SysQuartz sysQuartz, Exception e){
Date endTime = new Date();
Date startTime = threadLocal.get();
threadLocal.remove();
String logMsg = "任务"+sysQuartz.getJobName()+"执行耗时 - "+(endTime.getTime()-startTime.getTime()) +" 毫秒";
logger.info(logMsg);
SysQuartzLog sysQuartzLog = new SysQuartzLog();
sysQuartzLog.setStopTime(endTime);
sysQuartzLog.setStartTime(startTime);
sysQuartzLog.setJobName(sysQuartz.getJobName());
sysQuartzLog.setInvokeTarget(sysQuartz.getInvokeTarget());
sysQuartzLog.setJobGroup(sysQuartz.getJobGroup());
sysQuartzLog.setJobMessage(logMsg);
if (e!=null){
// 执行状态（0正常 1失败）
sysQuartzLog.setStatus("1");
sysQuartzLog.setExceptionInfo(e.toString().substring(0,200));
}else {
sysQuartzLog.setStatus("0");
}
//将日志存入数据库中
SpringBeanUtils.getBean(SysQuartzLogService.class).saveQuartzLog(sysQuartzLog);
}
/**
* 抽象方法执行具体的定时任务
*/
abstract void doExecute(JobExecutionContext context, SysQuartz sysQuartz) throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException;
}
//本类支持并行
public class AllowQuartz extends AbstractJob {
@Override
void doExecute(JobExecutionContext context, SysQuartz sysQuartz) throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException {
//工具类，将字符串解析成方法名、类名(全路径类名)、参数，并执行对应的方法
MethodUtil.analysisMethod(sysQuartz);
}
}
//本类不支持并行
@DisallowConcurrentExecution
public class DisallowQuartz extends AbstractJob{
@Override
void doExecute(JobExecutionContext context, SysQuartz sysQuartz) throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException {
//工具类，将字符串解析成方法名、类名(全路径类名)、参数，并执行对应的方法
MethodUtil.analysisMethod(sysQuartz);
}
}
下面对解析工具类中的方法做简要解释
/**
* 解析对应的定时任务方法 并 执行
* StringUtils需要引入apache的commons.lang3
* 当前工具类还未实现解析参数的方法
*/
public static void analysisMethod(SysQuartz sysQuartz) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException {
//录入的目标方法串
String targetString = sysQuartz.getInvokeTarget();
//目标类
String beanName = getBeanName(targetString);
//目标方法
String methodName = getMethodName(targetString);
Object object ;
if(beanName.contains(".")){
//如果截取的beanName中还有 ‘.’ 则beanName是全路径 反射
object = Class.forName(beanName).newInstance();
}else {
// spring上下文
object = SpringBeanUtils.getBean(beanName);
}
//获取bean下对应的方法
Method method = object.getClass().getMethod(methodName);
//执行
method.invoke(object);
}
private static String getBeanName(String str){
//截取（ 之前的字符串
String s = StringUtils.substringBefore(str,"(");
//截取最后一个"."之前的字符串
String beanName = StringUtils.substringBeforeLast(s,".");
return beanName;
}
private static String getMethodName(String str){
//截取（ 之前的字符串
String s = StringUtils.substringBefore(str,"(");
//截取最后一个"."之后的串
String methodName = StringUtils.substringAfterLast(s,".");
return methodName;
}
构建JobDetail的时候即可根据相关任务的需要传入DisallowQuartz.class或者AllowQuartz.class\
/**
* 判断是并行还是串行
* @return java.lang.Class<? extends org.quartz.Job>
*/
public static Class<? extends Job> getJobClass(String concurrent){
return "0".equals(concurrent) ? AllowQuartz.class : DisallowQuartz.class;
}
//创建JobDetail
JobDetail jobDetail = JobBuilder.newJob(getJobClass).withIdentity(jobKey).build();
任务初始化，保证任务在项目启动的时候即可执行，所以，新建一个类去实现CommandLineRunner的run方法，也可以使用@PostConstruct注解，在方法中查询数据库中的任务详情，然后遍历，挨个创建。CommandLineRunner的好处是，项目启动成功之后任务才开始初始化，即使用问题也不会影响程序启动。
本文结束，仅供参考 ~ _ ~
3193
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
