grapeTimer

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 17, 2020 License: Apache-2.0 Imports: 14 Imported by: 0

README

Go Report Card Build Status

grapeTimer 时间调度器

一款粗粒度的时间调度器，可以帮你通过一些字符串快速并简单的创建时间任务。

用于游戏服务端的优化设计，大量并行的时间调度方式。

目前可支持任意类型的函数(无返回值)以及任意参数数量和参数类型。

grapeTimer填坑完毕的库，已做测试。

简单介绍：
  • 通过命令格式创建time.Time
  • 简洁的Api格式，轻度且可拆分的函数库
  • 快速创建调度器
  • 可控的调度器时间粒度
  • 高性能的并发调度
  • 支持任意类型函数的任意参数[自动推导参数以及类型]
  • 时间周期，次数多模式可控[支持每天、每周、每月]
  • 可以获取下一次执行时间的字符串[支持自定义格式]
  • 可选择对调度器保存或内存执行
  • 生成可保存的调度器字符串并反向分析他生成调度器[保存到Json再通过Json创建Timer]
  • 不依赖第三方库
  • 处理Panic打印相关的数据信息，用于记录崩溃原因
  • 通过atomic预测下一个ID[该方法不适合并发场景，可能存在争抢ID错误的风险]
  • 自定义起始TimerId的种子
  • 自定义TimerId的生成函数[自生成ID请注意并发场景下的线程争抢]
  • TimerId扩展为int64，支持大ID和CRC64ID生成器对应

简单测试

100W个TIMER压入4秒钟，每个执行1S的话，完成执行大概不到4S，基本上达到性能需求。 如果超过100W个并发TIMER，建议切分服务，所有执行采用异步行为。

安装方法

go get -u github.com/koangel/grapeTimer

基本用法

// 初始化一个1秒钟粒度的调度器，ars代表是否自动设置运行为并行模式
grapeTimer.InitGrapeScheduler(1*time.Second, true)
// 设置GUID种子
grapeTimer.SetGuidSeed(1000)
// 设置GUID生成函数
autoId := int64(10222)
grapeTimer.SetCreateGUID(func() int64 {
	return atomic.AddInt64(&autoId,1)
})
// 获取但不增加下一个TimerId（预测函数，可能存在偏差，请自行管理）
nextId := grapeTimer.PeekNextId()
// 启动一个单次执行的调度器，1秒时间，基本tick单位为毫秒
Id := grapeTimer.NewTickerOnce(1000, exec100,"exec100 this arg1",2000,float32(200.5))
// 启动一个单次执行的调度器，1秒时间，基本tick单位为毫秒 (需要返回参数的代码)
Id := grapeTimer.NewTickerOnce(1000, exec100Result,"exec100 this arg1",2000,float32(200.5),func(v float32){
	fmt.Println("i'm call back:", v)
})
// 启动一个1秒为周期的 循环timer 循环100次 -1为永久循环
Id = grapeTimer.NewTickerLoop(1000,100, exec100Loop,"exec100Loop this arg1",2000,float32(200.5))
// 启动一个每日规则的定时器，参数为args data
Id = grapeTimer.NewTimeDataOnce("Day 13:59:59", exeDayTime,"exeDayTime this arg1",2000,float32(200.5))
// 启动一个每日循环规则的定时器，参数为args data 循环100次 -1为永久循环
Id = grapeTimer.NewTimeDataLoop("Day 13:59:59",100, exeDayTime,"exeDayTime this arg1",2000,float32(200.5))
// 通过json启动一个定时器
Id = grapeTimer.NewFromJson(jsonBody,"exec100Loop this arg1",2000,float32(200.5))

函数可以为任意类型的任意参数数量的函数，会自动保存参数以及数值，CALLBACK线程安全：

func exec100(arg1 string, arg2 int, arg3 float32) {
	fmt.Println(arg1, arg2, arg3)
}

// 需要返回参数
func exec100Result(arg1 string, arg2 int, arg3 float32,rscall func(v float32)) {
	fmt.Println(arg1, arg2, arg3)

	rscall(arg3)
}


func exec100Loop(arg1 string, arg2 int, arg3 float32) {
	fmt.Println(arg1, arg2, arg3)
}

func exeDayTime(arg1 string, arg2 int, arg3 float32) {
	fmt.Println(arg1, arg2, arg3)
}

停止计时器

// 将自动返回的ID作为参数传入可停止持续循环的TIMER
grapeTimer.StopTimer(Id)

参数设置

// 设置启用日志调试模式，建议正式版本关闭他
grapeTimer.CDebugMode = true
// 调用分析器使用的时区，可以个根据不同国家地区设置 
grapeTimer.LocationFormat = "Asia/Shanghai"
// 开启异步调度模式，在此模式下 timer执行时会建立一个go，不会阻塞其他timer执行调度，建议开启
grapeTimer.UseAsyncExec = true

获取下一次执行的时间

// 将自动返回的ID作为参数传入可停止持续循环的TIMER
 nextTimeStr := grapeTimer.String(Id) // 标准格式获取
 nextTimeStr = grapeTimer.Format("2006-01-02 15:04:05") // 通过自定义格式化获取
 allTimer := grapeTimer.List() // 全部Id对应日期的下一次执行时间

保存调度器

nextJson := grapeTimer.ToJson(Id) // 获取单个调度器保存到JSON格式下
allJson := grapeTimer.SaveAll()

生成调度器字符串

Id = grapeTimer.NewFromJson(jsonBody,"exec100Loop this arg1",2000,float32(200.5))

可用格式说明

调度器有轻度的日期模式分析体系，可提供每日，每周，每月的时间日期生成方式，具体格式如下：

关键字 格式 说明
Day Day 00:00:00 生成每日的日期时间
Week Week 1 00:00:00 生成每周的日期时间， 0~6 分别代表周日到周六
Month Month 1 00:00:00 生成每月该日期的时间，建议不要使用20日之后的日期

以上日期如果超过时间自动生成下一个时间，每月时间使用时，如本月不存在该日期，则直接返回错误。

代码示例：

	vtime, err := grapeTimer.Parser("Day 13:59:59") // 返回值为标准的*time.Time
	if err != nil {
		// 处理错误...
	}

        vtime, err = grapeTimer.Parser("Week 6 23:59:59")
	if err != nil {
		// 处理错误...
	}

	vtime, err = grapeTimer.Parser("Month 26 13:59:59")
	if err != nil {
		// 处理错误...
	}

代码输出：

2017-05-24 13:59:59 +0800 CST

Documentation

Overview

/ Author:koangel / jackliu100@gmail.com / 负责分析并解析字符串格式并转换成一个time

/ Author:koangel / jackliu100@gmail.com / 每个单独的执行模块，结构中越简单越好

/ Author:koangel / jackliu100@gmail.com / 负责分析并解析字符串格式并转换成一个time

/ Author:koangel / jackliu100@gmail.com / 调度器负责单独的timer处理以及调度器行为

Index

Constants

View Source 
const (
	TimeFormat = "2006-01-02 15:04:05"
	DateFormat = "2006-01-02"

	// Day 00:00:00 每天的几点几分执行
	DayRegexp = `Day\s[0-9]{2}:[0-9]{2}:[0-9]{2}`
	// Week 1 00:00:00 每周几的几点执行
	WeekRegexp = `Week\s[0-9]{1,2}\s[0-9]{2}:[0-9]{2}:[0-9]{2}`
	// Month 1 00:00:00 每月几日的几点几分执行
	// 但是如果本月不存在该日期则不执行并报错
	MonthRegexp = `Month\s[0-9]{1,2}\s[0-9]{2}:[0-9]{2}:[0-9]{2}`
)
View Source 
const (
	Day   = "Day"
	Week  = "Week"
	Month = "Month"
)
View Source 
const (
	LoopOnce    = 1
	UnlimitLoop = -1
)

Variables

View Source 
var CDebugMode bool = true

开启日志调试模式 默认开启 错误类信息不受该控制

View Source 
var DayCRegexp, _ = regexp.Compile(DayRegexp)
View Source 
var LocationFormat = "Asia/Shanghai"

默认的通用时区字符串，通过修改他会更改分析后的日期结果 默认为上海时区

View Source 
var MonthCRegexp, _ = regexp.Compile(MonthRegexp)
View Source 
var RecoverPanic = func(err error) {
	fmt.Println(err.Error())
}

对于默认Panic Recover函数处理

View Source 
var SkipWaitTask bool = true

如果上次任务未执行完成，默认方式还是跳过 默认跳过,单协程模式下，不处理

View Source 
var UseAsyncExec bool = true

创建GO去执行到期的任务 默认开启

View Source 
var WeekCRegexp, _ = regexp.Compile(WeekRegexp)

Functions

func AtTime 

func AtTime(timeFmt string, startAt time.Time, loc *time.Location) (*time.Time, error)

func Format 

func Format(Id int64, layout string) string

func InitGrapeScheduler 

func InitGrapeScheduler(t time.Duration, ars bool)

初始化全局整个调度器 调度器的粒度不建议小于1秒，会导致Cpu爆炸 不建议低于1秒钟,如果低于100毫秒 则自动设置为100毫秒有效防止CPU爆炸 ars = auto set runtime,自动设置Cpu数量

func List 

func List() map[int64]string

func NewFromJson 

func NewFromJson(json string, fn GrapeExecFn, args ...interface{}) int64

通过json构造timer

func NewTickerLoop 

func NewTickerLoop(tick, count int, startAt time.Time, endAt time.Time, fn GrapeExecFn, args ...interface{}) int64

循环可控版本

func NewTickerOnce 

func NewTickerOnce(tick int, startAt time.Time, endAt time.Time, fn GrapeExecFn, args ...interface{}) int64

以下函数均为自动ID 间隔为毫秒 运行一个tick并返回一个Id

func NewTimeDataLoop 

func NewTimeDataLoop(data string, count int, startAt time.Time, endAt time.Time, fn GrapeExecFn, args ...interface{}) int64

func NewTimeDataOnce 

func NewTimeDataOnce(data string, startAt time.Time, endAt time.Time, fn GrapeExecFn, args ...interface{}) int64

格式分析时钟

func PanicTrace 

func PanicTrace(kb int) []byte

func Parser 

func Parser(dateFmt string) (*time.Time, error)

/ 基本格式 Day or Week or Month or Year / like : Type DayNum Time / format: Day 00:00:00 / 返回一个处理好的下一个时间

func ParserLoc 

func ParserLoc(dateFmt string, startAt time.Time, loc *time.Location) (*time.Time, error)

// 带有时区的分析体系

func ParserStartAt added in v0.0.3 

func ParserStartAt(startAt time.Time, dateFmt string) (*time.Time, error)

func PeekNextId 

func PeekNextId() int64

func SaveAll 

func SaveAll() []string

func SetCreateGUID 

func SetCreateGUID(fn func() int64)

func SetGuidSeed 

func SetGuidSeed(seed int64) error

func StopTimer 

func StopTimer(Id int64)

func String 

func String(Id int64) string

func ToJson 

func ToJson(Id int64) string

所有的时间参数保存到JSON

Types

type GrapeExecFn 

type GrapeExecFn interface{}

type GrapeScheduler 

type GrapeScheduler struct {
	// contains filtered or unexported fields
}
var GScheduler *GrapeScheduler = nil

func (*GrapeScheduler) Format 

func (c *GrapeScheduler) Format(id int64, layout string) string

func (*GrapeScheduler) List 

func (c *GrapeScheduler) List() map[int64]string

列出全部timer的下一次执行周期

func (*GrapeScheduler) SaveAll 

func (c *GrapeScheduler) SaveAll() []string

func (*GrapeScheduler) StopTimer 

func (c *GrapeScheduler) StopTimer(Id int64)

停止这个timer

func (*GrapeScheduler) String 

func (c *GrapeScheduler) String(id int64) string

func (*GrapeScheduler) ToJson 

func (c *GrapeScheduler) ToJson(id int64) string

type GrapeTimer 

type GrapeTimer struct {
	Id        int64  `json:"id"`
	NextTime  int64  `json:"next_time"`
	RunMode   int    `json:"run_mode"`
	TimeData  string `json:"time_data"`
	LoopCount int32  `json:"loop_count"` // -1为无限执行
	//控制任务执行区间,如果为空则忽略区间
	StartTime time.Time `json:"start_time"`
	EndTime   time.Time `json:"end_time"`
	// contains filtered or unexported fields
}

func (*GrapeTimer) Execute 

func (c *GrapeTimer) Execute()

/ 执行Timer

func (*GrapeTimer) Format 

func (c *GrapeTimer) Format(layout string) string

func (*GrapeTimer) IsDestroy 

func (c *GrapeTimer) IsDestroy() bool

/ 是否可销毁

func (*GrapeTimer) IsExpired 

func (c *GrapeTimer) IsExpired() bool

/ 是否到时间

func (*GrapeTimer) ParserJson 

func (c *GrapeTimer) ParserJson(s string) *GrapeTimer

func (*GrapeTimer) Stop 

func (c *GrapeTimer) Stop()

func (*GrapeTimer) String 

func (c *GrapeTimer) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.