utils:1.简化并优化redis锁代码,2.支持传入自定义redis连接客户端;schedule:1.支持设定自定义redis连接客户端;http:响应器时间戳响应字段赋值位置调整,2.分页器json tag修正;other:更新README

Author: keepchen

README.md

@@ -120,7 +120,7 @@ func main() {
 
 ## 使用案例  
 <table style="text-align: center">
-  <tr>
+  <tr style="height:200px">
     <td style="border: 1px solid black; padding: 8px;">
       <a href="https://stardots.io?ref=go-sail" target="_blank"><img src="static/usecases/stardots-logo.png" alt="stardots.io" width="200" title="https://stardots.io"/></a>
     </td>
@@ -131,7 +131,7 @@ func main() {
       <img src="static/usecases/miniprogram-hpp.png" alt="生活好评助手-小程序" width="200" />
     </td>
   </tr>
-  <tr>
+  <tr style="height:200px">
     <td style="border: 1px solid black; padding: 8px;">
       <img src="static/usecases/wingoal-metaland.png" alt="WinGoal" width="200" />
     </td>

README_EN.md

@@ -123,7 +123,7 @@ Thank you to everyone who provided valuable suggestions and comments during the
 
 ## Use cases  
 <table style="text-align: center">
-  <tr>
+  <tr style="height:200px">
     <td style="border: 1px solid black; padding: 8px;">
       <a href="https://stardots.io?ref=go-sail" target="_blank"><img src="static/usecases/stardots-logo.png" alt="stardots.io" width="200" title="https://stardots.io"/></a>
     </td>
@@ -134,7 +134,7 @@ Thank you to everyone who provided valuable suggestions and comments during the
       <img src="static/usecases/miniprogram-hpp.png" alt="生活好评助手-小程序" width="200" />
     </td>
   </tr>
-  <tr>
+  <tr style="height:200px">
     <td style="border: 1px solid black; padding: 8px;">
       <img src="static/usecases/wingoal-metaland.png" alt="WinGoal" width="200" />
     </td>

http/api/response.go

@@ -275,12 +275,7 @@ func (a *responseEngine) mergeBody(code constants.ICodeType, resp interface{}, m
 		body.Code = anotherErrNoneCode.Int()
 	}
 	body.Message = constants.CodeType(body.Code).String(language...)
-	if loc != nil {
-		//loc可能用于后续其他字段，这里暂时这样调用
-		body.Timestamp = time.Now().In(loc).UnixMilli()
-	} else {
-		body.Timestamp = time.Now().UnixMilli()
-	}
+
 	switch code {
 	case anotherErrNoneCode:
 		body.Success = constants.Success
@@ -354,6 +349,13 @@ func (a *responseEngine) mergeBody(code constants.ICodeType, resp interface{}, m
 		}
 	}
 
+	if loc != nil {
+		//loc可能用于后续其他字段，这里暂时这样调用
+		body.Timestamp = time.Now().In(loc).UnixMilli()
+	} else {
+		body.Timestamp = time.Now().UnixMilli()
+	}
+
 	a.requestId = requestId
 	a.data = body
 

http/pojo/vo/paginate.go

@@ -2,6 +2,6 @@ package vo
 
 // Paginate 分页器
 type Paginate struct {
-	Page     int `json:"page" query:"page" form:"page" path:"page" format:"int" example:"1"`                  //页码，从1开始
-	PageSize int `json:"pageSize" query:"pageSize" form:"pageSize" path:"pageSize" format:"int" example:"20"` //页面条数
+	Page     int `json:"page" query:"page" form:"page" path:"page" format:"number" example:"1"`                  //页码，从1开始
+	PageSize int `json:"pageSize" query:"pageSize" form:"pageSize" path:"pageSize" format:"number" example:"20"` //页面条数
 }

sail/schedule.go

@@ -0,0 +1,16 @@
+package sail
+
+import (
+	redisLib "github.com/go-redis/redis/v8"
+	"github.com/keepchen/go-sail/v3/schedule"
+)
+
+// SetScheduleRedisClient 设置计划任务使用的redis客户端
+func SetScheduleRedisClient(client redisLib.UniversalClient) {
+	schedule.SetRedisClientOnce(client)
+}
+
+// Schedule 计划任务
+func Schedule(name string, task func()) schedule.Scheduler {
+	return schedule.NewJob(name, task)
+}

sail/schedule_test.go

@@ -0,0 +1,25 @@
+package sail
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/keepchen/go-sail/v3/lib/redis"
+)
+
+func TestSetScheduleRedisClient(t *testing.T) {
+	t.Run("SetScheduleRedisClient", func(t *testing.T) {
+		SetScheduleRedisClient(redis.GetInstance())
+		SetScheduleRedisClient(redis.GetInstance())
+		SetScheduleRedisClient(redis.GetClusterInstance())
+		SetScheduleRedisClient(redis.GetClusterInstance())
+	})
+}
+
+func TestSchedule(t *testing.T) {
+	t.Run("Schedule", func(t *testing.T) {
+		t.Log(Schedule("test-sail-schedule", func() {
+			fmt.Println("test-sail-schedule")
+		}))
+	})
+}

schedule/interval.go

@@ -34,9 +34,9 @@ func (j *taskJob) run() {
 				j.task()
 				return
 			}
-			if utils.RedisLocker().TryLock(j.lockerKey) {
+			if utils.RedisLocker(redisClients...).TryLock(j.lockerKey) {
 				defer func() {
-					utils.RedisLocker().Unlock(j.lockerKey)
+					utils.RedisLocker(redisClients...).Unlock(j.lockerKey)
 					j.lockedByMe = false
 				}()
 				j.lockedByMe = true
@@ -51,7 +51,7 @@ func (j *taskJob) run() {
 			//收到退出信号，终止任务
 			case <-j.cancelTaskChan:
 				if j.withoutOverlapping && j.lockedByMe {
-					utils.RedisLocker().Unlock(j.lockerKey)
+					utils.RedisLocker(redisClients...).Unlock(j.lockerKey)
 				}
 
 				taskSchedules.mux.Lock()

schedule/schedule.go

@@ -5,6 +5,8 @@ import (
 	"sync"
 	"time"
 
+	redisLib "github.com/go-redis/redis/v8"
+
 	"github.com/keepchen/go-sail/v3/utils"
 	"github.com/robfig/cron/v3"
 )
@@ -157,6 +159,18 @@ func generateJobNameKey(name string) string {
 	return fmt.Sprintf("go-sail:task-schedule-locker:%s", utils.Base64().Encode([]byte(name)))
 }
 
+var (
+	setRedisOnce = &sync.Once{}
+	redisClients = make([]redisLib.UniversalClient, 0)
+)
+
+// SetRedisClientOnce 设置redis连接客户端
+func SetRedisClientOnce(client redisLib.UniversalClient) {
+	setRedisOnce.Do(func() {
+		redisClients = append(redisClients, client)
+	})
+}
+
 // NewJob 实例化任务
 //
 // name 任务名称唯一标识

schedule/schedule_test.go

@@ -2,9 +2,12 @@ package schedule
 
 import (
 	"fmt"
+	"net"
 	"testing"
 	"time"
 
+	"github.com/keepchen/go-sail/v3/lib/redis"
+
 	"github.com/stretchr/testify/assert"
 )
 
@@ -92,3 +95,21 @@ func TestMustCall(t *testing.T) {
 		time.Sleep(time.Second * 2)
 	})
 }
+
+func TestSetRedisClientOnce(t *testing.T) {
+	t.Run("Run-SetRedisClientOnce", func(t *testing.T) {
+		conn, err := net.Dial("tcp", fmt.Sprintf("%s:%d", sConf.Host, sConf.Port))
+		if err != nil {
+			return
+		}
+		_ = conn.Close()
+		redisClient, err := redis.New(sConf)
+
+		assert.NoError(t, err)
+
+		SetRedisClientOnce(redisClient)
+		//multiple set
+		SetRedisClientOnce(redisClient)
+		SetRedisClientOnce(redisClient)
+	})
+}

schedule/specs.go

@@ -46,9 +46,9 @@ func (j *taskJob) RunAt(crontabExpr string) (cancel CancelFunc) {
 			j.task()
 			return
 		}
-		if utils.RedisLocker().TryLock(j.lockerKey) {
+		if utils.RedisLocker(redisClients...).TryLock(j.lockerKey) {
 			defer func() {
-				utils.RedisLocker().Unlock(j.lockerKey)
+				utils.RedisLocker(redisClients...).Unlock(j.lockerKey)
 				j.lockedByMe = false
 			}()
 			j.lockedByMe = true