Springboot中执行定时任务

标签（空格分隔）： simbest开发技术博客

---

[TOC]

参考：https://blog.csdn.net/jeikerxiao/article/details/74559244
          https://blog.csdn.net/snakemoving/article/details/77480449

一、背景

      在实际项目开发中，定时任务是一种很常见的功能。通过使用定时器完成一些业务逻辑，比如天气接口的数据获取，定时发送短信，邮件，同步组织人员，以及商城中每天用户的限额，定时自动收货等等。
      创建定时器的方式大致有三种：

• Java自带的java.util.Timer类，这个类允许你调度一个java.util.TimerTask任务。 最早的时候就是这样写定时任务的。
• 开源的第三方框架： Quartz 或者 elastic-job ， 但是这个比较复杂和重量级，适用于分布式场景下的定时任务，可以根据需要多实例部署定时任务。
• 使用Spring提供的注解： @Schedule 。 如果定时任务执行时间较短，并且比较单一，可以使用这个注解。（也是我们框架中目前使用的方式）

      今天我们就来看下在sping boot中如何集成定时任务，讲解基于simbest-cores框架的应用。

---

二、环境搭建

      搭建一个sping boot项目

---

三、添加定时任务类

3.1 继承simbest-core包下的 AbstractTaskSchedule类

@Slf4j
@Component
public class SyncTimUserTask extends AbstractTaskSchedule {
   
    @Value("${app.sync.tim.user.address}")
    private String timUserAddress; //业务字段

    @Autowired
    public SyncTimUserTask(AppRuntimeMaster master, SysTaskExecutedLogRepository repository) {
        super(master, repository);
    }

    /**
     * 开启定时器
     */
    @Scheduled (cron = "${app.task.sync.tim.user}")  //何时执行这个定时任务
    public void checkAndExecute() {
        super.checkAndExecute();
    }

    @Override
    public String execute() {
       // TODO 业务代码
    }
}

从上面的代码可以看出，新建一个类，继承AbstractTaskSchedule类，就可以实现一个定时任务类。
注解@Compoment用来标明这是一个被Spring管理的Bean,这个就不用多做讲解了。
开启定时任务，通过@Scheduled (cron = "XXXXX")，即可开启定时器。

3.1 自定义XXXXTask.java类

@Slf4j
@Component
public class SyncAllOrgDataTask  {
    public final static String CHECK_FAILED = "FAILED";

    @Autowired
    private AppRuntimeMaster appRuntime;

    @Autowired
    private SysTaskExecutedLogRepository repository;

    /**
     * 开启定时器
     */
    @Scheduled (cron = "XXXXX") // 定时任务执行方式
    public void checkAndExecute() {
        checkAndExecute(true);
    }

    private void checkAndExecute(boolean writeLog) {
        if(appRuntime.getMyHost().equals( UumsConstants.IP)
                && appRuntime.getMyPort().equals(UumsConstants.PORT)) {
            Long beginTime = System.currentTimeMillis();
            Boolean executeFlag = true;
            String content = CHECK_FAILED;
            try {
                content = this.execute();
            } catch (Exception e) {
                executeFlag = false;
                log.error("Execute taskName with {} failed.", this.getClass().getSimpleName());
                Exceptions.printException(e);
            }
            if(writeLog) {
                Long endTime = System.currentTimeMillis();
                SysTaskExecutedLog log = SysTaskExecutedLog.builder()
                        .taskName(this.getClass().getSimpleName())
                        .hostname(appRuntime.getMyHost())
                        .port(appRuntime.getMyPort())
                        .durationTime(endTime - beginTime)
                        .content( StringUtils.substring(content, 0, 2000))
                        .executeFlag(executeFlag)
                        .build();
                repository.save(log);
            }
        } else {
            log.debug("Master running {} on {}, I'm running {} on {}, I couldn't execute the job",
                    appRuntime.getMasterHost(), appRuntime.getMasterPort(), appRuntime.getMyHost(), appRuntime.getMyPort());
        }
    }

    private String execute() {
      // 业务代码
    }
}

---

四、一些必要的配置

4.1 pom.xml文件

添加定时任务执行时间，这里还是以上节3.1代码为例：

<app.task.sync.tim.user>0 0/1 * * * ?</app.task.sync.tim.user>

添加定时任务要访问的地址（根据实际业务需求，自行设置），这里还是以上节3.1代码为例：

<app.sync.tim.org.address>http://10.87.13.18:9081/userlog/getorglog.json</app.sync.tim.org.address>

4.2 application.properties文件

添加pom.xml文件中所设置的定时任务执行时间 | （定时任务要访问的地址，根据实际业务需求自行设置）

app.task.sync.tim.user=${app.task.sync.tim.user}
app.sync.tim.user.address=${app.sync.tim.user.address}

---

附：定时任务 Cron表达式

附1：基础格式

• 格式

{秒数} {分钟} {小时} {日期} {月份} {星期} {年份(可为空)}

• 图示

字段	允许值	允许的特殊字符
秒	0-59	, - * /
分	0-59	, - * /
小时	0-23	, - * /
日期	1-31	, - * ? / L W C
月份	1-12 或者 JAN-DEC	, - * /
星期	1-7 或者 SUN-SAT	, - * ? / L C #
年（可为空）	留空, 1970-2099	, - * /

附2：特殊字符

• “”
  “”字符被用来指定所有的值。如："*"在分钟的字段域里表示“每分钟”。

• “?”
  “?”字符只在日期域和星期域中使用。它被用来指定“非明确的值”。当你需要通过在这两个域中的一个来指定一些东西的时候，它是有用的。看下面的例子你就会明白。 月份中的日期和星期中的日期这两个元素时互斥的一起应该通过设置一个问号来表明不想设置那个字段。

• “-”
  “-”字符被用来指定一个范围。如：“10-12”在小时域意味着“10点、11点、12点”。

• “,”
  “,”字符被用来指定另外的值。如：“MON,WED,FRI”在星期域里表示”星期一、星期三、星期五”。

• “/”
  “/”字符用于指定增量。如：“0/15”在秒域意思是每分钟的0，15，30和45秒。“5/15”在分钟域表示每小时的5，20，35和50。符号“”在“/”前面（如：/10）等价于0在“/”前面（如：0/10）。记住一条本质：表达式的每个数值域都是一个有最大值和最小值的集合，如：秒域和分钟域的集合是0-59，日期域是1-31，月份域是1-12。字符“/”可以帮助你在每个字符域中取相应的数值。如：“7/6”在月份域的时候只有当7月的时候才会触发，并不是表示每个6月。

• “L”
  L是‘last’的省略写法可以表示day-of-month和day-of-week域，但在两个字段中的意思不同，例如day-of-month域中表示一个月的最后一天。如果在day-of-week域表示‘7’或者‘SAT’，如果在day-of-week域中前面加上数字，它表示一个月的最后几天，例如‘6L’就表示一个月的最后一个星期五。

• “W”
  字符“W”只允许日期域出现。这个字符用于指定日期的最近工作日。例如：如果你在日期域中写 “15W”，表示：这个月15号最近的工作日。所以，如果15号是周六，则任务会在14号触发。如果15好是周日，则任务会在周一也就是16号触发。如果是在日期域填写“1W”即使1号是周六，那么任务也只会在下周一，也就是3号触发，“W”字符指定的最近工作日是不能够跨月份的。字符“W”只能配合一个单独的数值使用，不能够是一个数字段，如：1-15W是错误的。
  “L”和“W”可以在日期域中联合使用，LW表示这个月最后一周的工作日。

• “#”
  字符“#”只允许在星期域中出现。这个字符用于指定本月的某某天。例如：“6#3”表示本月第三周的星期五（6表示星期五，3表示第三周）。“2#1”表示本月第一周的星期一。“4#5”表示第五周的星期三。

• “C”
  字符“C”允许在日期域和星期域出现。这个字符依靠一个指定的“日历”。也就是说这个表达式的值依赖于相关的“日历”的计算结果，如果没有“日历”关联，则等价于所有包含的“日历”。如：日期域是“5C”表示关联“日历”中第一天，或者这个月开始的第一天的后5天。星期域是“1C”表示关联“日历”中第一天，或者星期的第一天的后1天，也就是周日的后一天（周一）。

附3：示例

"0 0 12 * * ?" 每天中午12点触发

"0 15 10 ? * *" 每天上午10:15触发

"0 15 10 * * ?" 每天上午10:15触发

"0 15 10 * * ? *" 每天上午10:15触发

"0 15 10 * * ? 2005" 2005年的每天上午10:15触发

"0 * 14 * * ?" 在每天下午2点到下午2:59期间的每1分钟触发

"0 0/5 14 * * ?" 在每天下午2点到下午2:55期间的每5分钟触发

"0 0/5 14,18 * * ?" 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

"0 0-5 14 * * ?" 在每天下午2点到下午2:05期间的每1分钟触发

"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发

"0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发

"0 15 10 15 * ?" 每月15日上午10:15触发

"0 15 10 L * ?" 每月最后一日的上午10:15触发

"0 15 10 ? * 6L" 每月的最后一个星期五上午10:15触发

"0 15 10 ? * 6L 2002-2005" 2002年至2005年的每月的最后一个星期五上午10:15触发

"0 15 10 ? * 6#3" 每月的第三个星期五上午10:15触发