Files
go-gin-api/internal/api/controller/cron_handler/func_modify.go
新亮 b382919cb5 feature(1.2.7): 新增 WEB 模块 - 后台任务
- 新增数据表:cron_task;
- 后台新增后台任务模块,支持(创建、编辑、启用/禁用、列表);
- 调整项目初始化,使其支持安装后台任务模块;
- 调整服务升级指引,1.2.6 -> 1.2.7;
2021-08-21 21:04:42 +08:00

112 lines
4.6 KiB
Go
Executable File

package cron_handler
import (
"github.com/xinliangnote/go-gin-api/internal/api/service/cron_service"
"github.com/xinliangnote/go-gin-api/internal/pkg/code"
"github.com/xinliangnote/go-gin-api/internal/pkg/core"
"github.com/xinliangnote/go-gin-api/internal/pkg/validation"
"github.com/xinliangnote/go-gin-api/pkg/errno"
"net/http"
)
type modifyRequest struct {
Id string `form:"id" binding:"required"` // 任务ID
Name string `form:"name" binding:"required"` // 任务名称
Spec string `form:"spec" binding:"required"` // crontab 表达式
Command string `form:"command" binding:"required"` // 执行命令
Protocol int32 `form:"protocol" binding:"required"` // 执行方式 1:shell 2:http
HttpMethod int32 `form:"http_method"` // http 请求方式 1:get 2:post
Timeout int32 `form:"timeout" binding:"required"` // 超时时间(单位:秒)
RetryTimes int32 `form:"retry_times" binding:"required"` // 重试次数
RetryInterval int32 `form:"retry_interval" binding:"required"` // 重试间隔(单位:秒)
NotifyStatus int32 `form:"notify_status" binding:"required"` // 执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知
NotifyType int32 `form:"notify_type"` // 通知类型 1:邮件 2:webhook
NotifyReceiverEmail string `form:"notify_receiver_email"` // 通知者邮箱地址(多个用,分割)
NotifyKeyword string `form:"notify_keyword"` // 通知匹配关键字(多个用,分割)
Remark string `form:"remark"` // 备注
IsUsed int32 `form:"is_used" binding:"required"` // 是否启用 1:是 -1:否
}
type modifyResponse struct {
Id int32 `json:"id"` // 主键ID
}
// Modify 编辑任务
// @Summary 编辑任务
// @Description 编辑任务
// @Tags API.cron
// @Accept multipart/form-data
// @Produce json
// @Param id formData string true "Hashid"
// @Param name formData string true "任务名称"
// @Param spec formData string true "crontab 表达式"
// @Param command formData string true "执行命令"
// @Param protocol formData int true "执行方式 1:shell 2:http"
// @Param http_method formData int false "http 请求方式 1:get 2:post"
// @Param timeout formData int true "超时时间(单位:秒)"
// @Param retry_times formData int true "重试次数"
// @Param retry_interval formData int true "重试间隔(单位:秒)"
// @Param notify_status formData int true "执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知"
// @Param notify_type formData int false "通知类型 1:邮件 2:webhook"
// @Param notify_receiver_email formData string false "通知者邮箱地址(多个用,分割)"
// @Param notify_keyword formData string false "通知匹配关键字(多个用,分割)"
// @Param remark formData string false "备注"
// @Param is_used formData int true "是否启用 1:是 -1:否"
// @Success 200 {object} modifyResponse
// @Failure 400 {object} code.Failure
// @Router /api/cron/{id} [post]
func (h *handler) Modify() core.HandlerFunc {
return func(ctx core.Context) {
req := new(modifyRequest)
res := new(modifyResponse)
if err := ctx.ShouldBindForm(req); err != nil {
ctx.AbortWithError(errno.NewError(
http.StatusBadRequest,
code.ParamBindError,
validation.Error(err)).WithErr(err),
)
return
}
ids, err := h.hashids.HashidsDecode(req.Id)
if err != nil {
ctx.AbortWithError(errno.NewError(
http.StatusBadRequest,
code.HashIdsDecodeError,
code.Text(code.HashIdsDecodeError)).WithErr(err),
)
return
}
id := int32(ids[0])
modifyData := new(cron_service.ModifyCronTaskData)
modifyData.Name = req.Name
modifyData.Spec = req.Spec
modifyData.Command = req.Command
modifyData.Protocol = req.Protocol
modifyData.HttpMethod = req.HttpMethod
modifyData.Timeout = req.Timeout
modifyData.RetryTimes = req.RetryTimes
modifyData.RetryInterval = req.RetryInterval
modifyData.NotifyStatus = req.NotifyStatus
modifyData.NotifyType = req.NotifyType
modifyData.NotifyReceiverEmail = req.NotifyReceiverEmail
modifyData.NotifyKeyword = req.NotifyKeyword
modifyData.Remark = req.Remark
modifyData.IsUsed = req.IsUsed
if err := h.cronService.Modify(ctx, id, modifyData); err != nil {
ctx.AbortWithError(errno.NewError(
http.StatusBadRequest,
code.CronUpdateError,
code.Text(code.CronUpdateError)).WithErr(err),
)
return
}
res.Id = id
ctx.Payload(res)
}
}