cron.ts 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471
  1. /**
  2. * CRON 表达式工具类
  3. * 提供 CRON 表达式的解析、格式化、验证等功能
  4. */
  5. /** CRON 字段类型枚举 */
  6. export enum CronFieldType {
  7. SECOND = 'second',
  8. MINUTE = 'minute',
  9. HOUR = 'hour',
  10. DAY = 'day',
  11. MONTH = 'month',
  12. WEEK = 'week',
  13. YEAR = 'year'
  14. }
  15. /** CRON 字段配置 */
  16. export interface CronFieldConfig {
  17. key: CronFieldType
  18. label: string
  19. min: number
  20. max: number
  21. names?: Record<string, number> // 名称映射,如月份名称
  22. }
  23. /** CRON 字段配置常量 */
  24. export const CRON_FIELD_CONFIGS: Record<CronFieldType, CronFieldConfig> = {
  25. [CronFieldType.SECOND]: { key: CronFieldType.SECOND, label: '秒', min: 0, max: 59 },
  26. [CronFieldType.MINUTE]: { key: CronFieldType.MINUTE, label: '分', min: 0, max: 59 },
  27. [CronFieldType.HOUR]: { key: CronFieldType.HOUR, label: '时', min: 0, max: 23 },
  28. [CronFieldType.DAY]: { key: CronFieldType.DAY, label: '日', min: 1, max: 31 },
  29. [CronFieldType.MONTH]: {
  30. key: CronFieldType.MONTH,
  31. label: '月',
  32. min: 1,
  33. max: 12,
  34. names: {
  35. JAN: 1,
  36. FEB: 2,
  37. MAR: 3,
  38. APR: 4,
  39. MAY: 5,
  40. JUN: 6,
  41. JUL: 7,
  42. AUG: 8,
  43. SEP: 9,
  44. OCT: 10,
  45. NOV: 11,
  46. DEC: 12
  47. }
  48. },
  49. [CronFieldType.WEEK]: {
  50. key: CronFieldType.WEEK,
  51. label: '周',
  52. min: 0,
  53. max: 7,
  54. names: {
  55. SUN: 0,
  56. MON: 1,
  57. TUE: 2,
  58. WED: 3,
  59. THU: 4,
  60. FRI: 5,
  61. SAT: 6
  62. }
  63. },
  64. [CronFieldType.YEAR]: { key: CronFieldType.YEAR, label: '年', min: 1970, max: 2099 }
  65. }
  66. /** 解析后的 CRON 字段 */
  67. export interface ParsedCronField {
  68. type: 'any' | 'specific' | 'range' | 'step' | 'list' | 'last' | 'weekday' | 'nth'
  69. values: number[]
  70. original: string
  71. description: string
  72. }
  73. /** 解析后的 CRON 表达式 */
  74. export interface ParsedCronExpression {
  75. second: ParsedCronField
  76. minute: ParsedCronField
  77. hour: ParsedCronField
  78. day: ParsedCronField
  79. month: ParsedCronField
  80. week: ParsedCronField
  81. year?: ParsedCronField
  82. isValid: boolean
  83. description: string
  84. nextExecutionTime?: Date
  85. }
  86. /** 常用 CRON 表达式预设 */
  87. export const CRON_PRESETS = {
  88. EVERY_SECOND: '* * * * * ?',
  89. EVERY_MINUTE: '0 * * * * ?',
  90. EVERY_HOUR: '0 0 * * * ?',
  91. EVERY_DAY: '0 0 0 * * ?',
  92. EVERY_WEEK: '0 0 0 ? * 1',
  93. EVERY_MONTH: '0 0 0 1 * ?',
  94. EVERY_YEAR: '0 0 0 1 1 ?',
  95. WORKDAY_9AM: '0 0 9 ? * 2-6', // 工作日上午9点
  96. WORKDAY_6PM: '0 0 18 ? * 2-6', // 工作日下午6点
  97. WEEKEND_10AM: '0 0 10 ? * 1,7' // 周末上午10点
  98. } as const
  99. /** CRON 表达式工具类 */
  100. export class CronUtils {
  101. /** 验证 CRON 表达式格式 */
  102. static validate(cronExpression: string): boolean {
  103. if (!cronExpression || typeof cronExpression !== 'string') {
  104. return false
  105. }
  106. const parts = cronExpression.trim().split(/\s+/)
  107. // 支持 5-7 个字段的 CRON 表达式
  108. if (parts.length < 5 || parts.length > 7) {
  109. return false
  110. }
  111. // 基本格式验证
  112. const cronRegex = /^[0-9*\/\-,?LW#]+$/
  113. return parts.every((part) => cronRegex.test(part))
  114. }
  115. /** 解析单个 CRON 字段 */
  116. static parseField(
  117. fieldValue: string,
  118. fieldType: CronFieldType,
  119. config: CronFieldConfig
  120. ): ParsedCronField {
  121. const field: ParsedCronField = {
  122. type: 'any',
  123. values: [],
  124. original: fieldValue,
  125. description: ''
  126. }
  127. // 处理特殊字符
  128. if (fieldValue === '*' || fieldValue === '?') {
  129. field.type = 'any'
  130. field.description = `每${config.label}`
  131. return field
  132. }
  133. // 处理最后一天 (L)
  134. if (fieldValue === 'L' && fieldType === CronFieldType.DAY) {
  135. field.type = 'last'
  136. field.description = '每月最后一天'
  137. return field
  138. }
  139. // 处理范围 (-)
  140. if (fieldValue.includes('-')) {
  141. const [start, end] = fieldValue.split('-').map(Number)
  142. if (!isNaN(start) && !isNaN(end) && start >= config.min && end <= config.max) {
  143. field.type = 'range'
  144. field.values = Array.from({ length: end - start + 1 }, (_, i) => start + i)
  145. field.description = `${config.label} ${start}-${end}`
  146. }
  147. return field
  148. }
  149. // 处理步长 (/)
  150. if (fieldValue.includes('/')) {
  151. const [base, step] = fieldValue.split('/')
  152. const stepNum = Number(step)
  153. if (!isNaN(stepNum) && stepNum > 0) {
  154. field.type = 'step'
  155. if (base === '*') {
  156. field.description = `每${stepNum}${config.label}`
  157. } else {
  158. const startNum = Number(base)
  159. field.description = `从${startNum}开始每${stepNum}${config.label}`
  160. }
  161. }
  162. return field
  163. }
  164. // 处理列表 (,)
  165. if (fieldValue.includes(',')) {
  166. const values = fieldValue
  167. .split(',')
  168. .map(Number)
  169. .filter((n) => !isNaN(n))
  170. if (values.length > 0) {
  171. field.type = 'list'
  172. field.values = values
  173. field.description = `${config.label} ${values.join(',')}`
  174. }
  175. return field
  176. }
  177. // 处理具体数值
  178. const numValue = Number(fieldValue)
  179. if (!isNaN(numValue) && numValue >= config.min && numValue <= config.max) {
  180. field.type = 'specific'
  181. field.values = [numValue]
  182. field.description = `${config.label} ${numValue}`
  183. }
  184. return field
  185. }
  186. /** 解析完整的 CRON 表达式 */
  187. static parse(cronExpression: string): ParsedCronExpression {
  188. const result: ParsedCronExpression = {
  189. second: { type: 'any', values: [], original: '*', description: '每秒' },
  190. minute: { type: 'any', values: [], original: '*', description: '每分' },
  191. hour: { type: 'any', values: [], original: '*', description: '每时' },
  192. day: { type: 'any', values: [], original: '*', description: '每日' },
  193. month: { type: 'any', values: [], original: '*', description: '每月' },
  194. week: { type: 'any', values: [], original: '?', description: '任意周' },
  195. isValid: false,
  196. description: ''
  197. }
  198. if (!this.validate(cronExpression)) {
  199. result.description = '无效的 CRON 表达式'
  200. return result
  201. }
  202. const parts = cronExpression.trim().split(/\s+/)
  203. const fieldTypes = [
  204. CronFieldType.SECOND,
  205. CronFieldType.MINUTE,
  206. CronFieldType.HOUR,
  207. CronFieldType.DAY,
  208. CronFieldType.MONTH,
  209. CronFieldType.WEEK
  210. ]
  211. // 如果只有5个字段,则第一个字段是分钟
  212. const startIndex = parts.length === 5 ? 1 : 0
  213. for (let i = 0; i < parts.length; i++) {
  214. const fieldType = fieldTypes[i + startIndex]
  215. if (fieldType && CRON_FIELD_CONFIGS[fieldType]) {
  216. const config = CRON_FIELD_CONFIGS[fieldType]
  217. result[fieldType] = this.parseField(parts[i], fieldType, config)
  218. }
  219. }
  220. // 处理年份字段(如果存在)
  221. if (parts.length === 7) {
  222. const yearConfig = CRON_FIELD_CONFIGS[CronFieldType.YEAR]
  223. result.year = this.parseField(parts[6], CronFieldType.YEAR, yearConfig)
  224. }
  225. result.isValid = true
  226. result.description = this.generateDescription(result)
  227. return result
  228. }
  229. /** 生成 CRON 表达式的可读描述 */
  230. static generateDescription(parsed: ParsedCronExpression): string {
  231. const parts: string[] = []
  232. // 构建时间部分描述
  233. if (parsed.hour.type === 'specific' && parsed.minute.type === 'specific') {
  234. const hour = parsed.hour.values[0]
  235. const minute = parsed.minute.values[0]
  236. parts.push(`${hour.toString().padStart(2, '0')}:${minute.toString().padStart(2, '0')}`)
  237. } else if (parsed.hour.type === 'specific') {
  238. parts.push(`每天${parsed.hour.values[0]}点`)
  239. } else if (parsed.minute.type === 'specific' && parsed.minute.values[0] === 0) {
  240. if (parsed.hour.type === 'any') {
  241. parts.push('每小时整点')
  242. }
  243. } else if (parsed.minute.type === 'step') {
  244. const step = parsed.minute.original.split('/')[1]
  245. parts.push(`每${step}分钟`)
  246. } else if (parsed.hour.type === 'step') {
  247. const step = parsed.hour.original.split('/')[1]
  248. parts.push(`每${step}小时`)
  249. }
  250. // 构建日期部分描述
  251. if (parsed.day.type === 'specific') {
  252. parts.push(`每月${parsed.day.values[0]}日`)
  253. } else if (parsed.week.type === 'specific') {
  254. const weekNames = ['周日', '周一', '周二', '周三', '周四', '周五', '周六']
  255. const weekDay = parsed.week.values[0]
  256. if (weekDay >= 0 && weekDay <= 6) {
  257. parts.push(`每${weekNames[weekDay]}`)
  258. }
  259. } else if (parsed.week.type === 'range') {
  260. parts.push('工作日')
  261. }
  262. // 构建月份部分描述
  263. if (parsed.month.type === 'specific') {
  264. parts.push(`${parsed.month.values[0]}月`)
  265. }
  266. return parts.length > 0 ? parts.join(' ') : '自定义时间规则'
  267. }
  268. /** 格式化 CRON 表达式为可读文本 */
  269. static format(cronExpression: string): string {
  270. if (!cronExpression) return ''
  271. const parsed = this.parse(cronExpression)
  272. return parsed.isValid ? parsed.description : cronExpression
  273. }
  274. /** 获取预设的 CRON 表达式列表 */
  275. static getPresets() {
  276. return Object.entries(CRON_PRESETS).map(([key, value]) => ({
  277. label: this.format(value),
  278. value,
  279. key
  280. }))
  281. }
  282. /** 计算 CRON 表达式的下次执行时间 */
  283. static getNextExecutionTime(cronExpression: string, fromDate?: Date): Date | null {
  284. const parsed = this.parse(cronExpression)
  285. if (!parsed.isValid) {
  286. return null
  287. }
  288. const now = fromDate || new Date()
  289. // eslint-disable-next-line prefer-const
  290. let nextTime = new Date(now.getTime() + 1000) // 从下一秒开始
  291. // 简化版本:处理常见的 CRON 表达式模式
  292. // 对于复杂的 CRON 表达式,建议使用专门的库如 node-cron 或 cron-parser
  293. // 处理每分钟执行
  294. if (parsed.second.type === 'specific' && parsed.minute.type === 'any') {
  295. const targetSecond = parsed.second.values[0]
  296. nextTime.setSeconds(targetSecond, 0)
  297. if (nextTime <= now) {
  298. nextTime.setMinutes(nextTime.getMinutes() + 1)
  299. }
  300. return nextTime
  301. }
  302. // 处理每小时执行
  303. if (
  304. parsed.second.type === 'specific' &&
  305. parsed.minute.type === 'specific' &&
  306. parsed.hour.type === 'any'
  307. ) {
  308. const targetSecond = parsed.second.values[0]
  309. const targetMinute = parsed.minute.values[0]
  310. nextTime.setMinutes(targetMinute, targetSecond, 0)
  311. if (nextTime <= now) {
  312. nextTime.setHours(nextTime.getHours() + 1)
  313. }
  314. return nextTime
  315. }
  316. // 处理每天执行
  317. if (
  318. parsed.second.type === 'specific' &&
  319. parsed.minute.type === 'specific' &&
  320. parsed.hour.type === 'specific'
  321. ) {
  322. const targetSecond = parsed.second.values[0]
  323. const targetMinute = parsed.minute.values[0]
  324. const targetHour = parsed.hour.values[0]
  325. nextTime.setHours(targetHour, targetMinute, targetSecond, 0)
  326. if (nextTime <= now) {
  327. nextTime.setDate(nextTime.getDate() + 1)
  328. }
  329. return nextTime
  330. }
  331. // 处理步长执行
  332. if (parsed.minute.type === 'step') {
  333. const step = parseInt(parsed.minute.original.split('/')[1])
  334. const currentMinute = nextTime.getMinutes()
  335. const nextMinute = Math.ceil(currentMinute / step) * step
  336. if (nextMinute >= 60) {
  337. nextTime.setHours(nextTime.getHours() + 1, 0, 0, 0)
  338. } else {
  339. nextTime.setMinutes(nextMinute, 0, 0)
  340. }
  341. return nextTime
  342. }
  343. // 对于其他复杂情况,返回一个估算时间
  344. return new Date(now.getTime() + 60000) // 1分钟后
  345. }
  346. /** 获取 CRON 表达式的执行频率描述 */
  347. static getFrequencyDescription(cronExpression: string): string {
  348. const parsed = this.parse(cronExpression)
  349. if (!parsed.isValid) {
  350. return '无效表达式'
  351. }
  352. // 计算大概的执行频率
  353. if (parsed.second.type === 'any' && parsed.minute.type === 'any') {
  354. return '每秒执行'
  355. }
  356. if (parsed.minute.type === 'any' && parsed.hour.type === 'any') {
  357. return '每分钟执行'
  358. }
  359. if (parsed.hour.type === 'any' && parsed.day.type === 'any') {
  360. return '每小时执行'
  361. }
  362. if (parsed.day.type === 'any' && parsed.month.type === 'any') {
  363. return '每天执行'
  364. }
  365. if (parsed.month.type === 'any') {
  366. return '每月执行'
  367. }
  368. return '按计划执行'
  369. }
  370. /** 检查 CRON 表达式是否会在指定时间执行 */
  371. static willExecuteAt(cronExpression: string, targetDate: Date): boolean {
  372. const parsed = this.parse(cronExpression)
  373. if (!parsed.isValid) {
  374. return false
  375. }
  376. // 检查各个字段是否匹配
  377. const second = targetDate.getSeconds()
  378. const minute = targetDate.getMinutes()
  379. const hour = targetDate.getHours()
  380. const day = targetDate.getDate()
  381. const month = targetDate.getMonth() + 1
  382. const weekDay = targetDate.getDay()
  383. return (
  384. this.fieldMatches(parsed.second, second) &&
  385. this.fieldMatches(parsed.minute, minute) &&
  386. this.fieldMatches(parsed.hour, hour) &&
  387. this.fieldMatches(parsed.day, day) &&
  388. this.fieldMatches(parsed.month, month) &&
  389. (parsed.week.type === 'any' || this.fieldMatches(parsed.week, weekDay))
  390. )
  391. }
  392. /** 检查字段值是否匹配 */
  393. private static fieldMatches(field: ParsedCronField, value: number): boolean {
  394. if (field.type === 'any') {
  395. return true
  396. }
  397. if (field.type === 'specific' || field.type === 'list') {
  398. return field.values.includes(value)
  399. }
  400. if (field.type === 'range') {
  401. return value >= field.values[0] && value <= field.values[field.values.length - 1]
  402. }
  403. if (field.type === 'step') {
  404. const [base, step] = field.original.split('/').map(Number)
  405. if (base === 0 || field.original.startsWith('*')) {
  406. return value % step === 0
  407. }
  408. return value >= base && (value - base) % step === 0
  409. }
  410. return false
  411. }
  412. }