# YTask

**Repository Path**: gojuukaze/YTask

## Basic Information

- **Project Name**: YTask
- **Description**: YTask is an asynchronous task queue for handling distributed jobs in golang （go异步任务队列）
- **Primary Language**: Go
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 43
- **Forks**: 12
- **Created**: 2019-08-31
- **Last Updated**: 2023-04-23

## Categories & Tags

**Categories**: task-schedule

**Tags**: None

## README

YTask
-----------

YTask is an asynchronous task queue for handling distributed jobs in golang  
golang异步任务/队列 框架

* [中文文档](https://doc.ikaze.cn/YTask) (中文文档更加全面，优先阅读中文文档)
* [En Doc](https://github.com/gojuukaze/YTask/wiki)
* [Github](https://github.com/gojuukaze/YTask)
* [Brokers And Backends](./drives)
* [V2 Doc](https://doc.ikaze.cn/YTaskV2) 

# install
```bash
# install core
go get -u github.com/gojuukaze/YTask/v3

#install broker and backend
go get -u github.com/gojuukaze/YTask/drives/redis/v3
go get -u github.com/gojuukaze/YTask/drives/rabbitmq/v3
go get -u github.com/gojuukaze/YTask/drives/mongo2/v3
go get -u github.com/gojuukaze/YTask/drives/memcache/v3

```

# architecture diagram
<img src="./architecture_diagram.png" alt="architecture_diagram" width="80%">



# Quick Start

## server demo

```go
package main

import (
	"context"
	"os"
	"os/signal"
	"syscall"
	"github.com/gojuukaze/YTask/drives/redis/v3"
	"github.com/gojuukaze/YTask/v3"
)

// 定义两个任务，任务参数、返回值支持所有能被序列化为json的类型

func add(a int, b int) int {
	return a + b
}

type User struct {
	Id   int
	Name string
}

func appendUser(user User, ids []int, names []string) []User {
	var r = make([]User, 0)
	r = append(r, user)
	for i := range ids {
		r = append(r, User{ids[i], names[i]})
	}
	return r
}

func main() {
	// RedisBroker最后一个参数是连接池大小， 若不需要 任务流 功能可以设为0（为0时使用默认值，server端默认为3）
	// 否则根据需要设置，最大不要超过并发任务数
	broker := redis.NewRedisBroker("127.0.0.1", "6379", "", 0, 3)

	// RedisBackend最后一个参数是连接池大小，对于server端 如果<=0 会使用默认值，
	// 默认值是 min(10, numWorkers)
	backend := redis.NewRedisBackend("127.0.0.1", "6379", "", 0, 0)

	ser := ytask.Server.NewServer(
		ytask.Config.Broker(&broker),
		ytask.Config.Backend(&backend), // 可不设置
		ytask.Config.Debug(true),
		ytask.Config.StatusExpires(60*5),
		ytask.Config.ResultExpires(60*5),
	)

	// 注册任务
	ser.Add("group1", "add", add)
	ser.Add("group1", "append_user", appendUser)

	// 运行server，并发数3
	ser.Run("group1", 3)

	quit := make(chan os.Signal, 1)

	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
	<-quit
	ser.Shutdown(context.Background())

}

```

## client demo

```go
package main

import (
	"fmt"
	"github.com/gojuukaze/YTask/drives/redis/v3"
	"github.com/gojuukaze/YTask/v3"
	"github.com/gojuukaze/YTask/v3/server"
	"time"
)

type User struct {
	Id   int
	Name string
}

var client server.Client

func main() {
	// 对于client端你需要设置连接池大小
	broker := redis.NewRedisBroker("127.0.0.1", "6379", "", 0, 5)
	backend := redis.NewRedisBackend("127.0.0.1", "6379", "", 0, 5)

	ser := ytask.Server.NewServer(
		ytask.Config.Broker(&broker),
		ytask.Config.Backend(&backend),
		ytask.Config.Debug(true),
		ytask.Config.StatusExpires(60*5),
		ytask.Config.ResultExpires(60*5),
	)

	client = ser.GetClient()

	// 提交任务
	taskId, _ := client.Send("group1", "add", 123, 44)
	// 获取结果
	result, _ := client.GetResult(taskId, 2*time.Second, 300*time.Millisecond)

	if result.IsSuccess() {
		// 有多种方法获取返回值，具体可以参考： https://doc.ikaze.cn/YTask/client.html#id4
		sum, _ := result.GetInt64(0)
		// or
		var sum2 int
		result.Get(0, &sum2)

		fmt.Println("add(123,44) =", int(sum))
	}

	// 提交结构体，slice等
	taskId, _ = client.Send("group1", "append_user", User{1, "aa"}, []int{322, 11}, []string{"bb", "cc"})
	result, _ = client.GetResult(taskId, 2*time.Second, 300*time.Millisecond)
	var users []User
	result.Get(0, &users)
	fmt.Println(users)

}


```

# Example

Also take a look at [example](https://github.com/gojuukaze/YTask/tree/master/example) directory.

```bash
cd example/server
go run main.go 

cd example/send
go run send/main.go
```

捐赠 / Sponsor
================

开源不易，如果你觉得对你有帮助，求打赏个一块两块的

![](https://gitee.com/gojuukaze/liteAuth/raw/master/shang.jpg)