dcron

README

分布式定时任务

原理

基于redis同步节点数据，模拟服务注册。然后将任务名 根据一致性hash 选举出执行该任务的节点。

特性

• 负载均衡：根据任务数据和节点数据均衡分发任务。
• 故障转移：单个节点故障，10s后会自动将任务自动转移至其他正常节点。
• 任务唯一：同一个服务内同一个任务只会启动单个运行实例，不会重复执行。
• 自定义存储：通过实现driver接口来增加节点数据存储方式。

使用说明

1.指定服务名，使用redis配置初始化dcron。服务名为执行相同任务的单元

   dcron := NewDcronUseRedis("服务名称",driver.DriverConnOpt{
   		Host:"127.0.0.1",
   		Port:"6379",
   		Password:"",
   })

2.使用cron语法添加任务，需要指定任务名。任务名作为任务的唯一标识，必须保证唯一。

    dcron.AddFunc("test1","*/3 * * * *",func(){
		fmt.Println("执行 test1 任务",time.Now().Format("15:04:05"))
	})

3.开始任务。

dcron.Start()

关于服务名的说明

服务名只是为了定义相同一组任务，节点在启动时会产生一个uuid，然后绑定到这个服务内，不会存在多个节点使用同一个服务明出现冲突的问题。

比如有个服务叫【课堂服务】里面包含了 【上课】【下课】 等各类定时任务，那么就可以有n个不同的服务节点（可以在同一台或者不同机器上），服务都叫课堂服务。

其他

注意：一般定时如果和http服务在一起时不用特殊处理；但如果程序内只有该定时任务，需要阻塞主进程以防止主线程直接退出。

Documentation

Index

• type Dcron
  • func NewDcron(serverName, driverName string, dataSourceOption driver.DriverConnOpt) *Dcron
  • func NewDcronUseRedis(serverName string, dataSourceOption driver.DriverConnOpt) *Dcron
  • func (this *Dcron) AddFunc(jobName, cronStr string, cmd func())
  • func (this *Dcron) Start()
  • func (this *Dcron) Stop()
• type JobWarpper
  • func (job JobWarpper) Run()
• type NodePool
  • func (this *NodePool) PickNodeByJobName(jobName string) string
• type PoolOptions

Types

type Dcron

type Dcron struct {
	ServerName string
	// contains filtered or unexported fields
}

func NewDcron

func NewDcron(serverName, driverName string, dataSourceOption driver.DriverConnOpt) *Dcron

func NewDcronUseRedis

func NewDcronUseRedis(serverName string, dataSourceOption driver.DriverConnOpt) *Dcron

func (*Dcron) AddFunc

func (this *Dcron) AddFunc(jobName, cronStr string, cmd func())

func (*Dcron) Start

func (this *Dcron) Start()

func (*Dcron) Stop

func (this *Dcron) Stop()

type JobWarpper

type JobWarpper struct {
	Dcron   *Dcron
	Name    string
	CronStr string
	Func    func()
}

func (JobWarpper) Run

func (job JobWarpper) Run()

type NodePool

type NodePool struct {
	NodeId string

	Driver driver.Driver
	// contains filtered or unexported fields
}

func (*NodePool) PickNodeByJobName

func (this *NodePool) PickNodeByJobName(jobName string) string

使用一致性hash算法根据任务名获取一个执行节点

type PoolOptions

type PoolOptions struct {
	Replicas int
	HashFn   consistenthash.Hash
}