xxl

Documentation

Index

• Constants
• Variables
• func Int64ToStr(i int64) string
• type ExecuteResult
• type Executor
  • func NewExecutor(opts ...Option) Executor
• type LogFunc
• type LogHandler
• type LogLevel
• type LogReq
• type LogRes
• type LogResContent
• type Logger
• type Middleware
• type Option
  • func AccessToken(token string) Option
  • func AppName(appName string) Option
  • func ExecutorIp(ip string) Option
  • func ExecutorPort(port string) Option
  • func RegistryKey(registryKey string) Option
  • func ServerAddr(addr string) Option
  • func SetLogDepth(depth int) Option
  • func SetLogLevel(level LogLevel) Option
  • func SetLogger(l Logger) Option
• type Options
• type Registry
• type RunReq
• type Task
  • func (t *Task) Info() string
  • func (t *Task) Run(callback func(er *ExecuteResult))
• type TaskFunc

Constants

const (
	SuccessCode = 200
	FailureCode = 500
)

响应码

const (
	DebugLevel = "debug"
	InfoLevel  = "info"
	WarnLevel  = "warn"
	ErrorLevel = "error"
)

Variables

var (
	DefaultExecutorPort = "9999"
	DefaultRegistryKey  = "golang-jobs"
)

Functions

func Int64ToStr

func Int64ToStr(i int64) string

Int64ToStr int64 to str

Types

type ExecuteResult

type ExecuteResult struct {
	Code int64  `json:"code"`
	Msg  string `json:"msg"`
}

ExecuteResult 任务执行结果 200 表示任务执行正常，500表示失败

type Executor

type Executor interface {
	// Init 初始化
	Init(...Option)
	// LogHandler 日志查询
	LogHandler(handler LogHandler)
	// Use 使用中间件
	Use(middlewares ...Middleware)
	// RegTask 注册任务
	RegTask(pattern string, task TaskFunc)
	// RunTask 运行任务
	RunTask(writer http.ResponseWriter, request *http.Request)
	// KillTask 杀死任务
	KillTask(writer http.ResponseWriter, request *http.Request)
	// TaskLog 任务日志
	TaskLog(writer http.ResponseWriter, request *http.Request)
	// Beat 心跳检测
	Beat(writer http.ResponseWriter, request *http.Request)
	// IdleBeat 忙碌检测
	IdleBeat(writer http.ResponseWriter, request *http.Request)
	// Run 运行服务
	Run() error
	// Stop 停止服务
	Stop()
}

Executor 执行器

func NewExecutor

func NewExecutor(opts ...Option) Executor

NewExecutor 创建执行器

type LogFunc

type LogFunc func(req LogReq, res *LogRes) []byte

LogFunc 应用日志

type LogHandler

type LogHandler func(req *LogReq) *LogRes

type LogLevel

type LogLevel string

type LogReq

type LogReq struct {
	LogDateTim  int64 `json:"logDateTim"`  // 本次调度日志时间
	LogID       int64 `json:"logId"`       // 本次调度日志ID
	FromLineNum int   `json:"fromLineNum"` // 日志开始行号，滚动加载日志
}

LogReq 日志请求

type LogRes

type LogRes struct {
	Code    int64         `json:"code"`    // 200 表示正常、其他失败
	Msg     string        `json:"msg"`     // 错误提示消息
	Content LogResContent `json:"content"` // 日志响应内容
}

LogRes 日志响应

type LogResContent

type LogResContent struct {
	FromLineNum int    `json:"fromLineNum"` // 本次请求，日志开始行数
	ToLineNum   int    `json:"toLineNum"`   // 本次请求，日志结束行号
	LogContent  string `json:"logContent"`  // 本次请求日志内容
	IsEnd       bool   `json:"isEnd"`       // 日志是否全部加载完
}

LogResContent 日志响应内容

type Logger

type Logger interface {
	Debug(format string, a ...interface{})
	Info(format string, a ...interface{})
	Warn(format string, a ...interface{})
	Error(format string, a ...interface{})
}

Logger 系统日志

type Middleware

type Middleware func(TaskFunc) TaskFunc

Middleware 中间件构造函数

type Option

type Option func(o *Options)

func AccessToken

func AccessToken(token string) Option

AccessToken 请求令牌

func AppName

func AppName(appName string) Option

AppName 设置AppName

func ExecutorIp

func ExecutorIp(ip string) Option

ExecutorIp 设置执行器IP

func ExecutorPort

func ExecutorPort(port string) Option

ExecutorPort 设置执行器端口

func RegistryKey

func RegistryKey(registryKey string) Option

RegistryKey 设置执行器标识

func ServerAddr

func ServerAddr(addr string) Option

ServerAddr 设置调度中心地址

func SetLogDepth

func SetLogDepth(depth int) Option

SetLogDepth 设置日志级别

func SetLogLevel

func SetLogLevel(level LogLevel) Option

SetLogLevel 设置日志级别

func SetLogger

func SetLogger(l Logger) Option

SetLogger 设置日志处理器

type Options

type Options struct {
	ServerAddr   string        `json:"server_addr"`   // 调度中心地址
	AccessToken  string        `json:"access_token"`  // 请求令牌
	Timeout      time.Duration `json:"timeout"`       // 接口超时时间
	ExecutorIp   string        `json:"executor_ip"`   // 本地(执行器)IP(可自行获取)
	ExecutorPort string        `json:"executor_port"` // 本地(执行器)端口
	RegistryKey  string        `json:"registry_key"`  // 执行器名称
	LogDir       string        `json:"log_dir"`       // 日志目录
	AppName      string        `json:"app_name"`      // 应用名称
	LogLevel     LogLevel      `json:"log_level"`     // 日志级别
	// contains filtered or unexported fields
}

type Registry

type Registry struct {
	RegistryGroup string `json:"registryGroup"`
	RegistryKey   string `json:"registryKey"`
	RegistryValue string `json:"registryValue"`
}

Registry 注册参数

type RunReq

type RunReq struct {
	JobID                 int64  `json:"jobId"`                 // 任务ID
	ExecutorHandler       string `json:"executorHandler"`       // 任务标识
	ExecutorParams        string `json:"executorParams"`        // 任务参数
	ExecutorBlockStrategy string `json:"executorBlockStrategy"` // 任务阻塞策略
	ExecutorTimeout       int64  `json:"executorTimeout"`       // 任务超时时间，单位秒，大于零时生效
	LogID                 int64  `json:"logId"`                 // 本次调度日志ID
	LogDateTime           int64  `json:"logDateTime"`           // 本次调度日志时间
	GlueType              string `json:"glueType"`              // 任务模式，可选值参考 com.xxl.job.core.glue.GlueTypeEnum
	GlueSource            string `json:"glueSource"`            // GLUE脚本代码
	GlueUpdatetime        int64  `json:"glueUpdatetime"`        // GLUE脚本更新时间，用于判定脚本是否变更以及是否需要刷新
	BroadcastIndex        int64  `json:"broadcastIndex"`        // 分片参数：当前分片
	BroadcastTotal        int64  `json:"broadcastTotal"`        // 分片参数：总分片
}

RunReq 触发任务请求参数

type Task

type Task struct {
	Id    int64
	Name  string
	Ext   context.Context
	Param *RunReq

	Cancel    context.CancelFunc
	StartTime int64
	EndTime   int64
	// contains filtered or unexported fields
}

Task 任务

func (*Task) Info

func (t *Task) Info() string

Info 任务信息

func (*Task) Run

func (t *Task) Run(callback func(er *ExecuteResult))

Run 运行任务

type TaskFunc

type TaskFunc func(cxt context.Context, param *RunReq) *ExecuteResult

TaskFunc 任务执行函数