GoCron 项目使用教程

1. 项目的目录结构及介绍

GoCron 项目的目录结构如下：

gocron/
├── README.md
├── LICENSE
├── scheduler_test.go
├── goscheduler_test.go
├── util/
│   ├── goutil.go
│   └── goutil_test.go
├── main.go
├── config/
│   └── config.yaml

目录结构介绍

• README.md: 项目介绍文档。
• LICENSE: 项目许可证文件。
• scheduler_test.go 和 goscheduler_test.go: 调度器相关的测试文件。
• util/: 工具函数目录，包含 goutil.go 和 goutil_test.go。
• main.go: 项目的主启动文件。
• config/: 配置文件目录，包含 config.yaml。

2. 项目的启动文件介绍

main.go 是 GoCron 项目的主启动文件，其主要功能是初始化调度器并添加任务。以下是 main.go 的代码示例：

package main

import (
    "fmt"
    "time"
    "github.com/go-co-op/gocron/v2"
)

func main() {
    // 创建一个调度器
    s := gocron.NewScheduler(time.UTC)

    // 添加一个任务到调度器
    j, err := s.Every(10).Seconds().Do(func() {
        fmt.Println("任务执行中...")
    })
    if err != nil {
        fmt.Println("添加任务失败:", err)
        return
    }

    // 启动调度器
    s.StartBlocking()

    fmt.Println("任务ID:", j.GetID())
}

启动文件介绍

• NewScheduler(time.UTC): 创建一个新的调度器实例。
• Every(10).Seconds().Do(func() { ... }): 每 10 秒执行一次指定的函数。
• StartBlocking(): 启动调度器并阻塞主线程，直到调度器停止。

3. 项目的配置文件介绍

config/config.yaml 是 GoCron 项目的配置文件，用于配置调度器的相关参数。以下是一个示例配置文件内容：

scheduler:
  timezone: UTC
  interval: 10s
tasks:
  - name: Task1
    interval: 5s
    command: echo "Task1 executed"
  - name: Task2
    interval: 15s
    command: echo "Task2 executed"

配置文件介绍

• scheduler: 调度器配置。
  • timezone: 调度器使用的时区。
  • interval: 调度器的默认执行间隔。
• tasks: 任务列表。
  • name: 任务名称。
  • interval: 任务执行间隔。
  • command: 任务执行的命令。

通过以上配置文件，可以灵活地配置调度器的时区和任务的执行间隔及命令。