Golang解析Cron时间范围表达式插件库cronrange的使用

cronrange是一个用于解析和计算Cron时间范围表达式的Golang库，它扩展了标准Cron表达式，支持时间范围的表示和计算。

安装

go get github.com/1set/cronrange

基本概念

cronrange在标准Cron表达式的基础上增加了时间范围的支持，格式如下：

<开始Cron表达式> <结束Cron表达式> <时区> <持续时间>

使用示例

1. 解析CronRange表达式

package main

import (
	"fmt"
	"time"
	
	"github.com/1set/cronrange"
)

func main() {
	// 解析一个CronRange表达式
	// 表示从每周一9:00(UTC)开始，持续8小时
	expr := "0 9 * * 1 0 9 * * 1 UTC 8h"
	cr, err := cronrange.ParseString(expr)
	if err != nil {
		panic(err)
	}

	fmt.Printf("开始表达式: %s\n", cr.StartCron())
	fmt.Printf("结束表达式: %s\n", cr.EndCron())
	fmt.Printf("时区: %v\n", cr.TimeZone())
	fmt.Printf("持续时间: %v\n", cr.Duration())
}

2. 检查时间是否在范围内

func checkTimeInRange() {
	expr := "0 9 * * 1 0 17 * * 1 UTC 8h"
	cr, _ := cronrange.ParseString(expr)
	
	// 周一上午10点(UTC)
	t1 := time.Date(2023, time.June, 12, 10, 0, 0, 0, time.UTC)
	// 周一下午6点(UTC)
	t2 := time.Date(2023, time.June, 12, 18, 0, 0, 0, time.UTC)
	
	fmt.Println(cr.IsWithin(t1)) // true
	fmt.Println(cr.IsWithin(t2)) // false
}

3. 获取下一个时间范围

func getNextTimeRange() {
	expr := "0 9 * * 1 0 17 * * 1 UTC 8h"
	cr, _ := cronrange.ParseString(expr)
	
	// 从当前时间开始计算下一个时间范围
	now := time.Now()
	nextTimeRange, err := cr.NextTimeRange(now)
	if err != nil {
		panic(err)
	}
	
	fmt.Printf("下一个时间范围: %v - %v\n", 
		nextTimeRange.StartTime(), 
		nextTimeRange.EndTime())
}

4. 获取所有匹配的时间范围

func getAllTimeRanges() {
	expr := "0 9 * * 1 0 17 * * 1 UTC 8h"
	cr, _ := cronrange.ParseString(expr)
	
	start := time.Date(2023, time.June, 1, 0, 0, 0, 0, time.UTC)
	end := time.Date(2023, time.July, 1, 0, 0, 0, 0, time.UTC)
	
	ranges, err := cr.TimeRangesBetween(start, end)
	if err != nil {
		panic(err)
	}
	
	for _, tr := range ranges {
		fmt.Printf("时间范围: %v - %v\n", tr.StartTime(), tr.EndTime())
	}
}

高级用法

自定义时区

func customTimeZone() {
	loc, _ := time.LoadLocation("Asia/Shanghai")
	expr := "0 9 * * 1 0 17 * * 1 Asia/Shanghai 8h"
	cr, _ := cronrange.ParseString(expr)
	
	// 检查北京时间周一上午10点是否在范围内
	t := time.Date(2023, time.June, 12, 10, 0, 0, 0, loc)
	fmt.Println(cr.IsWithin(t)) // true
}

复杂的时间范围

func complexRange() {
	// 每天上午9点到11点，下午2点到4点
	expr := "0 9-11,14-16 * * * * 0 11,16 * * * * UTC 2h"
	cr, _ := cronrange.ParseString(expr)
	
	// 检查上午10点是否在范围内
	t1 := time.Date(2023, time.June, 12, 10, 0, 0, 0, time.UTC)
	// 检查下午3点是否在范围内
	t2 := time.Date(2023, time.June, 12, 15, 0, 0, 0, time.UTC)
	
	fmt.Println(cr.IsWithin(t1)) // true
	fmt.Println(cr.IsWithin(t2)) // true
}

注意事项

1. 时区参数是可选的，默认为UTC
2. 持续时间支持的单位包括: “ns”, “us”, “ms”, “s”, “m”, “h”
3. 如果开始和结束的Cron表达式相同，表示瞬时事件

cronrange库为处理复杂的时间范围提供了便利，特别适合需要精确控制时间段的调度场景。