GoCron 项目使用教程

GoCron 项目使用教程

1. 项目目录结构及介绍

GoCron 项目的目录结构如下：

gocron/
├── cmd/
│   ├── main.go
├── config/
│   ├── config.yaml
├── internal/
│   ├── scheduler/
│   │   ├── scheduler.go
│   ├── job/
│   │   ├── job.go
├── pkg/
│   ├── utils/
│   │   ├── utils.go
├── go.mod
├── go.sum
├── README.md

目录结构介绍

• cmd/: 包含项目的启动文件 main.go。
• config/: 包含项目的配置文件 config.yaml。
• internal/: 包含项目的核心逻辑代码。
  • scheduler/: 调度器相关代码。
  • job/: 任务相关代码。
• pkg/: 包含项目的公共库代码。
  • utils/: 工具类代码。
• go.mod 和 go.sum: Go 模块依赖管理文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

cmd/main.go

main.go 是 GoCron 项目的启动文件，负责初始化配置、启动调度器和执行任务。以下是 main.go 的主要内容：

package main

import (
    "log"
    "gocron/config"
    "gocron/internal/scheduler"
)

func main() {
    // 加载配置文件
    err := config.LoadConfig("config/config.yaml")
    if err != nil {
        log.Fatalf("Failed to load config: %v", err)
    }

    // 初始化调度器
    s := scheduler.NewScheduler()

    // 启动调度器
    s.Start()
}

主要功能

1. 加载配置文件: 通过 config.LoadConfig 函数加载配置文件 config/config.yaml。
2. 初始化调度器: 创建一个新的调度器实例 scheduler.NewScheduler()。
3. 启动调度器: 调用调度器的 Start 方法启动调度器，开始执行任务。

3. 项目的配置文件介绍

config/config.yaml

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

scheduler:
  interval: 10s
  maxConcurrentJobs: 5

jobs:
  - name: "job1"
    interval: "5s"
    command: "echo 'Job 1 executed'"

  - name: "job2"
    interval: "1m"
    command: "echo 'Job 2 executed'"

配置项说明

• scheduler: 调度器配置。

  • interval: 调度器的轮询间隔时间，例如 10s 表示每 10 秒轮询一次。
  • maxConcurrentJobs: 调度器允许同时运行的最大任务数。

• jobs: 任务列表。

  • name: 任务名称。
  • interval: 任务执行的时间间隔。
  • command: 任务执行的命令或脚本。

通过配置文件，可以灵活地调整调度器的行为和任务的执行频率。

---

以上是 GoCron 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你快速上手使用 GoCron 项目。