Spring定时任务之fixedRateString的实现示例

在 Spring Framework 的开发中，@Scheduled 注解是我们实现定时任务的利器。其中，fixedRateString 属性允许我们通过字符串来配置任务执行的固定速率。从 Spring 5 开始，为了更好地支持 Java 8 的日期时间 API，fixedRateString（以及 fixedDelayString, initialDelayString）开始支持 java.time.Duration 的格式进行解析。

这为我们提供了比毫秒数字更优雅、更易读的配置方式。今天，我们就来深入探讨一下这个强大的功能。

从毫秒到 Duration：为何要改变？

在旧版本中，我们通常这样配置：

@Scheduled(fixedRate = 5000) // 每5秒执行一次
public void doTask() {
    // 任务逻辑
}

或者使用字符串形式（为了支持占位符）：

@Scheduled(fixedRateString = "5000") // 从配置文件中读取，例如：scheduled.rate=5000
public void doTask() {
    // 任务逻辑
}

这种方式php虽然直接，但可读性较差。看到 5000，你需要反应一下才知道是 5 秒。而 Duration 格式则一目了然：

@Scheduled(fixedRateString = "PT5S") // 清晰明了：Period of Time 5 Seconds
public void doTask() {
    // 任务逻辑
}

核心：java.time.Duration.parse 支持的格式

Spring 底层使用 java.time.Duration.parse(CharSequence) 方法来解析 fixedRateString 的值。该方法遵循 ISO-8601 持续时间格式。

其正则表达式定义如下： ([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?

看起来复杂，但其结构非常清晰，可以分解为：

基本结构： P[n]Y[n]M[n]W[n]D[T[n]H[n]M[n]S]]

• P (必需): 是“Period”的缩写，表示持续时间段的开始。
• T (可选): 是“Time”的缩写，用于分隔日期部分和时间部分。如果要指定小时、分钟或China编程秒，则必须有 T。

日期部分 (在 P 之后，T 之前)：

• Y - 年
• M - 月
• W - 周
• D - 天

时间部分 (在 T 之后)：

• H - 小时
• M - 分钟
• S - 秒 (可以包含小数，使用 . 或 , 分隔，例如 PT30.5S 是 30.5 秒)

重要提示： 对于 Duratiojsn 类型，它主要用于衡量精确的时间段，而不是用于基于日历的、不精确的时间段。因此，在解析时，年（Y） 和 月（M） 会被忽略（一个月的天数不固定，无法精确转换为 Duration）。周（W） 和 天（D） 则会被正常转换（1天=24小时，1周=7天）。

这意味着，虽然格式允许 Y 和 M，但在 Duration 的语境下，它们是没有意义的。你应该专注于使用 D, H, M, S。

实战示例

让我们看一些在 @Scheduled 中有效的配置示例：

1. 5 秒: PT5S
2. 30 分钟: PT30M 或 PT1800S
3. 2 小时: PT2H
4. 2 小时 30 分钟: PT2H30M
5. 1 天: P1D (相当于 PT24H)
6. 1 天 6 小时: P1DT6H
7. 1.5 秒 (1500毫秒): PT1.5S
8. 从配置文件读取:
   • application.properties:

     my.task.rate=PT10S
     my.task.delay=P1DT12H
     

   • Java Code:

     @Scheduled(fixedRateString = "${my.task.rate}", initialDelayString = "${my.task.delay}")
     public void DOScheduledTask() {
         // 应用启动后，先延迟 1天半 (36小时)，然后每10秒执行一次
     }
     

常见错误与陷阱

1. 忘记 T 分隔符：

   • 错误: P1H30M (试图在日期部分指定小时)
   • 正确: PT1H30M (必须用 T 引入时间部分)

2. 使用 Y 或 M：

   • 无效: P1M (期望是1个月，但实际会被解析为 0)
   • 无效: P1Y1M (年份和月份都会被忽略，解析结果也是 0)
   • 如果需要“大约一个月”这种基于日历的概念，Duration 不是正确的工具，应考虑 Cron 表达式。

3. 负php值： 格式支持负值（-PT5S），但这在调度场景中没有意义，会导致异常。

总结

将 java.time.Duration 的 ISO-8601 格式与 Spring 的 @Scheduled 注解结合使用，极大地提升了配置的可读性和可维护性。

记住这个口诀：先写 P，要时间再加 T，忽略 Y 和 M，D/H/M/S 放心用。

到此这篇关于Spring定时任务之fi编程xedRateString的实现示例的文章就介绍到这了,更多相关Spring定时任务fixedRateString内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)！