go-admin/common/apis/api.go

package apis

import (
	"encoding/json"
	"net/http"

	"github.com/gin-gonic/gin"
	"go-admin/pkg/logger"
	"gorm.io/gorm"

	"go-admin/common/models"
	"go-admin/tools"
)

type Api struct {
}

// GetLogger 获取上下文提供的日志
func (e *Api) GetLogger(c *gin.Context) logger.Logger {
	return logger.GetRequestLogger(c)
}

// GetOrm 获取Orm DB
func (e *Api) GetOrm(c *gin.Context) (*gorm.DB, error) {
	return tools.GetOrm(c)
}

// Error 通常错误数据处理
func (e *Api) Error(c *gin.Context, code int, err error, msg string) {
	var res models.Response
	if err != nil {
		res.Msg = err.Error()
	}
	if msg != "" {
		res.Msg = msg
	}
	res.RequestId = tools.GenerateMsgIDFromContext(c)
	Return := res.ReturnError(code)
	e.setResult(c, Return, res.RequestId, code)
	c.AbortWithStatusJSON(http.StatusOK, Return)
}

// OK 通常成功数据处理
func (e *Api) OK(c *gin.Context, data interface{}, msg string) {
	var res models.Response
	res.Data = data
	if msg != "" {
		res.Msg = msg
	}
	res.RequestId = tools.GenerateMsgIDFromContext(c)
	Return := res.ReturnOK()
	e.setResult(c, Return, res.RequestId, 200)
	c.AbortWithStatusJSON(http.StatusOK, Return)
}

// PageOK 分页数据处理
func (e *Api) PageOK(c *gin.Context, result interface{}, count int, pageIndex int, pageSize int, msg string) {
	var res models.Page
	res.List = result
	res.Count = count
	res.PageIndex = pageIndex
	res.PageSize = pageSize
	e.OK(c, res, msg)
}

// Custom 兼容函数
func (e *Api) Custom(c *gin.Context, data gin.H) {
	msgID := tools.GenerateMsgIDFromContext(c)
	Return := data
	e.setResult(c, Return, msgID, 200)
	c.AbortWithStatusJSON(http.StatusOK, Return)
}

func (e *Api) setResult(c *gin.Context, Return interface{}, msgID string, status int) {
	requestLogger := e.GetLogger(c)
	jsonStr, err := json.Marshal(Return)
	if err != nil {
		requestLogger.Debugf("setResult error: %#v", msgID, err.Error())
	}
	c.Set("result", string(jsonStr))
	c.Set("status", status)
}