Go语言中编写定时任务

2023-12-06后端3 分钟140 次阅读
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面

前言

定时任务是指让程序按照我们特定的时间点或者预定的时间间隔,自动执行的相关的逻辑操作任务。这些任务通常用于自动化重复性的工作,以减轻人员操作的负担,提高效率。

在 Java 中我们一般常用 SpringBoot 开发项目,编写定时任务只需要在启动类加一个注解 @EnableScheduling,在需要执行的方法上加一个注解 @Scheduled 即可实现,当然 Java 还可以使用 Timer 和 ScheduledExecutorService 来实现定时任务。

那在 Go 语言中要如何实现呢?在 Go 语言中,你可以使用标准库中的 time 包,或使用第三方库如 github.com/go-co-op/gocron 来实现定时任务。

time 使用示例

使用 time.Tick 函数

time.Tick 函数返回一个通道,它会在指定的时间间隔后发送一个时间。你可以使用 for 循环和这个通道来执行定时任务。以下是一个示例:

go 复制代码
package main

import (
	"fmt"
	"time"
)

func main() {
	// 创建一个每2秒触发一次的定时器
	ticker := time.NewTicker(2 * time.Second)
	defer ticker.Stop()

	for {
		select {
		case <-ticker.C:
			timeStr := time.Now().Format("2006-01-02 15:04:05")
			fmt.Printf("执行定时任务--%s\n", timeStr)
		}
	}
}
image.png

使用 time.AfterFunc 函数

time.AfterFunc 函数会在指定的延迟后执行一个函数。以下是一个示例:

go 复制代码
package main

import (
	"fmt"
	"time"
)

func myTask() {
	timeStr := time.Now().Format("2006-01-02 15:04:05")
	fmt.Printf("执行定时任务--%s\n", timeStr)
}

func main() {
	// 函数将在2秒后执行
	duration := 2 * time.Second
	timer := time.AfterFunc(duration, myTask)

	// 等待任务完成
	timeStr := time.Now().Format("2006-01-02 15:04:05")
	fmt.Printf("阻塞等待5s,等待任务完成--%s\n", timeStr)
	<-time.After(5 * time.Second)
	timeStr = time.Now().Format("2006-01-02 15:04:05")
	fmt.Printf("任务完成--%s\n", timeStr)
	timer.Stop()
}
image.png

第三方库 gocron

gocron 是一个在 Go 中创建和管理定时任务的第三方库。它提供了一种方便的方式来定义和调度重复性任务。下面是如何使用 gocron 来实现定时任务的步骤:

  1. 首先我们需要安装 gocron 包。你可以使用 go get 命令来安装它:
    sh 复制代码
    go get github.com/go-co-op/gocron
  2. 在需要使用的代码处导入 gocron 包;
  3. 使用 gocron.NewScheduler() 创建一个新的调度器,为其设置任务的执行时间周期;
  4. 定义要执行的任务函数;
  5. 启动调度器。可以使用两种方式启动:
    1. s.StartAsync():启动所有任务,非阻塞当前 goroutine
    2. s.StartBlocking():启动所有任务,并阻塞当前 goroutine
  6. 保持程序运行,为了使程序一直运行,你可以使用一个无限循环或使用 select{} 语句来等待。这样可以确保程序不会在启动定时任务后立即退出;
  7. 停止调度器(可选)。如果你需要停止调度器并清除所有任务,你可以使用 s.Clear() 和 s.Stop()。

下边是示例代码:

go 复制代码
package main

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

func taskFunction() {
	// 执行你的任务代码
	fmt.Println("任务执行时间:", time.Now())
}

func main() {
	// 创建调度器
	s := gocron.NewScheduler(time.UTC)
	// 每分钟执行一次任务
	_, err := s.Every(1).Minute().Do(taskFunction)
	// 表示每隔 1 小时执行一次
	//_, err := s.Every(1).Hours().Do(taskFunction)
	// 每天的固定时间执行任务
	//_, err := s.Every(1).Day().At("15:35").Do(taskFunction)
	if err != nil {
		fmt.Println("任务出错...")
		return
	}
	// 运行调度器
	s.StartBlocking()
}
image.png

使用 Cron 表达式

go 复制代码
package main

import (
	"fmt"
	"github.com/robfig/cron/v3"
	"time"
)

func taskFunction() {
	// 执行你的任务代码
	fmt.Println("任务执行时间:", time.Now())
}

func main() {
	// 创建一个 cron 实例
	c := cron.New(cron.WithSeconds())
	// 添加一个定时任务,每隔 1 分钟执行一次
	_, err := c.AddFunc("*/5 * * * * *", taskFunction)
	if err != nil {
		panic(err)
	}
	// 启动定时任务
	c.Start()
	// 阻塞当前 goroutine
	select {}
}

image.png
以上就是使用 gocron 库创建和管理定时任务的基本步骤。你可以根据自己的需求定义多个不同的任务,并设置它们的执行时间。这个工具常用在 Go 应用程序中执行周期性任务。

觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句