# qtask

**Repository Path**: micro-plat/qtask

## Basic Information

- **Project Name**: qtask
- **Description**: 提供稳定，可靠的任务管理机制，直到任务被成功处理
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-08-25
- **Last Updated**: 2022-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# qtask

提供稳定，可靠的任务管理服务。支持两种任务：

* 实时任务
将任务放入消息队列，同时备份到DB。发生异常后从DB恢复到队列。


* 延时任务
将任务放入DB，达到延时时间后从DB拉取放入消息队列。发生异常后从DB恢复到队列。




特性:

√ 　实时任务

√ 　延时任务

√ 　自动备份

√ 　自动恢复

√ 　过期清理

√ 　一键安装

√ 　代码集成

√ 　基于 hydra 构建


## 一. 创建任务

任务分为实时任务和延时任务

### 1.实时任务  

```go

import "gitee.com/micro-plat/qtask"

// 创建实时任务，将任务放入指定的消息队列，并备份到DB
// taskID:任务编号
// invoke:执行函数句柄
taskID, invoke, err:=qtask.Create(c,"订单绑定任务",map[string]interface{}{
    "order_no":"8973097380045"
},3600,"ORDER:BIND")

//立即执行
err:=invoke(c)
```


### 2.延迟任务

```go

import "gitee.com/micro-plat/qtask"


//创建延时任务，将任务保存到数据库(状态为等待处理),超时后放入消息队列
// taskID:任务编号
taskID, err:=qtask.Delay(c,"订单绑定任务",map[string]interface{}{
    "order_no":"8973097380045"
},60,3600,"ORDER:BIND", qtask.WithDeadline(86400))
```

### 3.参数说明
* qtask.WithDeadline 任务截止执行时间,单位：秒，默认值604800秒(7天)
* qtask.WithDeleteDeadline任务删除截止时间，单位：秒。未设置时,任务执行成功立即删除;未执行成功,则为任务添加后的604800秒(7天)后
* qtask.WithMaxCount 任务最多执行次数,默认为100次
* qtask.WithOrderNO 外部业务单号


## 二. 处理任务

### 1. 消息队列配置

```go
    hydra.Conf.Vars().Queue().Redis("queue", "192.168.0.111:6379"))
```

###  2. 添加、注册任务

```go
    //添加队列ORDER:BIND的处理任务
    hydra.Conf.MQC(mqc.WithRedis("queue")).Queue(queue.NewQueue("ORDER:BIND", "/order/bind"))

    //注册/order/bind服务
    hydra.S.CRON("/order/bind", OrderBind)     //业务处理服务
```

### 3. 编写处理代码
```go

import "gitee.com/micro-plat/qtask"


func OrderBind(ctx hydra.IContext) (r interface{}) {
    //检查输入参数...

    //业务处理前调用，修改任务状态为处理中(超时前未调用qtask.Finish，任务会被重新放入队列)
    qtask.Processing(ctx,ctx.Request().GetInt64("task_id"))


    //处理业务逻辑...


    //业务处理成功，修改任务状态为完成(任务不再放入队列),并修改删除截止时间
    qtask.Finish(ctx,ctx.Request().GetInt64("task_id"))
}

```

## 三、创建数据表

当前应用`flowserver`中引用了qtask：

```sh
:~/work/bin$ flowserver db install --debug
安装到数据库 					[OK]
```

查看数据库，则已创建好qtask所需的数据表(mysql:2张表,oracle:1张表)



## 四、其它

### 1. 配置

```go
import "gitee.com/micro-plat/qtask"

qtask.Config(qtask.WithDBName("oracle"), //数据库配置
    qtask.WithQueueName("redis")) //队列配置
```

### 2. 数据库

* 使用 mysql 数据库

```sh
 go install
```

* 使用 oracle 数据库

```sh
 go install -tags "oracle"
```

[完整示例](https://gitee.com/micro-plat/qtask/tree/master/examples/flowserver)