Documentation
¶
Index ¶
- type Context
- func (ctx *Context) Failure(args ...any)
- func (ctx *Context) GetSafeGPCVal(fieldPath string) (value any)
- func (ctx *Context) GetSafeGPCValBool(fieldPath string) (value bool)
- func (ctx *Context) GetSafeGPCValInt(fieldPath string) (value int)
- func (ctx *Context) GetSafeGPCValStr(fieldPath string) (value string)
- func (ctx *Context) GetSafeGPCValTime(fieldPath string) (value time.Time)
- func (ctx *Context) GetSafeMapGPC(key ...string) (mapData map[string]any)
- func (ctx *Context) Result(code int, msg string, args ...any)
- func (ctx *Context) Success(args ...any)
- type ControllerInterface
- type NewContextOpt
- type Trait
- func (t *Trait) ActionAll(c *gin.Context)
- func (t *Trait) ActionCreate(c *gin.Context)
- func (t *Trait) ActionDelete(c *gin.Context)
- func (t *Trait) ActionDetail(c *gin.Context)
- func (t *Trait) ActionList(c *gin.Context)
- func (t *Trait) ActionSave(c *gin.Context)
- func (t *Trait) ActionSetValue(c *gin.Context)
- func (t *Trait) ActionUpdate(c *gin.Context)
- func (t *Trait) AllEach(ctx *Context, item interface{}) interface{}
- func (t *Trait) AllOrder(ctx *Context) interface{}
- func (t *Trait) AllQuery(ctx *Context, query *gorm.DB) *gorm.DB
- func (t *Trait) AllReturn(ctx *Context, results interface{}) bool
- func (t *Trait) AllSelect(ctx *Context, query *gorm.DB) *gorm.DB
- func (t *Trait) BindMapToStruct(mapData map[string]any, modelValue interface{}) error
- func (t *Trait) CreateAfter(ctx *Context, tx *gorm.DB, modelValue interface{}) error
- func (t *Trait) CreateBefore(ctx *Context, modelValue interface{}, mapData map[string]any) (interface{}, map[string]any, error)
- func (t *Trait) CreateFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) CreateReturn(ctx *Context, item any) bool
- func (t *Trait) DeleteAfter(ctx *Context, delIds []interface{}, delArr []map[string]interface{}) error
- func (t *Trait) DeleteBefore(ctx *Context, delArr []map[string]interface{}, delIds []interface{}) ([]interface{}, error)
- func (t *Trait) DeleteCondition(ctx *Context, delArr []map[string]interface{}) map[string]interface{}
- func (t *Trait) DeleteFields(ctx *Context) []string
- func (t *Trait) DeleteReturn(ctx *Context, delIds []interface{}, delArr []map[string]interface{})
- func (t *Trait) Detail(ctx *Context, item interface{}) interface{}
- func (t *Trait) DetailFormData(ctx *Context) (map[string]any, error)
- func (t *Trait) DetailQuery(ctx *Context, query *gorm.DB, mapData map[string]any) *gorm.DB
- func (t *Trait) DetailReturn(ctx *Context, detail interface{}) bool
- func (t *Trait) DetailSelect(ctx *Context, query *gorm.DB) *gorm.DB
- func (t *Trait) ExtractPkId(ctx *Context) (pkValue uint, err error)
- func (t *Trait) GetDeleteWhere(ctx *Context, deleteQuery *gorm.DB, ids []interface{}) *gorm.DB
- func (t *Trait) InitCrud(ginContext *gin.Context, args ...any) (ctx *Context)
- func (t *Trait) ListEach(ctx *Context, item interface{}) interface{}
- func (t *Trait) ListOrder(ctx *Context) (order interface{})
- func (t *Trait) ListQuery(ctx *Context, query *gorm.DB) (*gorm.DB, error)
- func (t *Trait) ListReturn(ctx *Context, listData jcbaseGo.ListData) bool
- func (t *Trait) ListSelect(ctx *Context, query *gorm.DB) *gorm.DB
- func (t *Trait) SaveAfter(ctx *Context, tx *gorm.DB, modelValue interface{}) error
- func (t *Trait) SaveBefore(ctx *Context, modelValue interface{}, mapData map[string]any, ...) (interface{}, map[string]any, error)
- func (t *Trait) SaveFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) SetValueAfter(ctx *Context, tx *gorm.DB, modelValue interface{}) error
- func (t *Trait) SetValueBefore(ctx *Context, modelValue interface{}, mapData map[string]any, ...) (interface{}, map[string]any, error)
- func (t *Trait) SetValueCheckField(ctx *Context, field string) error
- func (t *Trait) SetValueFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) SetValueReturn(ctx *Context, value interface{}, field string, id uint) bool
- func (t *Trait) UpdateAfter(ctx *Context, tx *gorm.DB, modelValue interface{}, originalData interface{}) error
- func (t *Trait) UpdateBefore(ctx *Context, modelValue interface{}, mapData map[string]any, ...) (interface{}, map[string]any, error)
- func (t *Trait) UpdateFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) UpdateReturn(ctx *Context, item interface{}) bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Context ¶ added in v0.11.0
type Context struct {
ActionName string // Action名称(如: "create", "update", "delete", "detail", "list", "all", "set-value")
Debug bool // 调试模式
GinContext *gin.Context // 请求上下文
SafeMapGPCAll map[string]any // GPC 数据映射
// SerializerOpts 为响应数据序列化选项。
// 可通过此字段统一配置时间格式化、ID 加密、字段跳过等策略。
// 留空时默认使用旧版 json 序列化路径,保证已有项目行为不变。
SerializerOpts []serializer.Option
}
func NewContext ¶ added in v0.11.0
func NewContext(opt *NewContextOpt) *Context
NewContext 创建一个新的控制器上下文对象 这个方法用于初始化一个新的上下文对象,包含Gin上下文和调试模式。 参数说明:
- opt *NewContextOpt: 上下文选项,包含Gin上下文和调试模式
返回值:
- *Context: 新创建的上下文对象
func (*Context) Failure ¶ added in v0.11.0
Failure 返回失败的响应 这个方法用于简化失败响应的构建,接收可变参数 并根据参数类型自动识别并分配到对应的字段(code、message、data、additionalParams)。 参数:
- args ...any: 可变参数,支持任意顺序传递以下类型:
- int: 错误码(默认使用errcode.BadRequest)
- string: 返回的消息内容
- any: 返回的数据(除int、string、map[string]any外的其他类型)
- map[string]any: 附加参数
示例:
ctx.Failure("操作失败") // 只传递消息
ctx.Failure(data) // 只传递数据
ctx.Failure("操作失败", data) // 消息和数据
ctx.Failure(data, "操作失败") // 数据在前,消息在后
ctx.Failure(500, "操作失败", data) // 错误码、消息和数据
ctx.Failure("操作失败", data, params) // 消息、数据和附加参数
func (*Context) GetSafeGPCVal ¶ added in v0.13.5
GetSafeGPCVal 安全获取GPC值 这个方法用于从Gin上下文的GPC(全局请求上下文)中安全获取指定路径的字段值。 它首先调用ensureSafeMapGPC方法确保GPC数据已初始化,然后使用helper.NewMap方法将其转换为可操作的Map类型, 最后使用Extract方法根据指定的字段路径提取对应的值。 参数:
- fieldPath string: 要获取的字段路径,支持嵌套路径(如"user.name")。
返回值:
- value any: 安全获取到的字段值,如果路径不存在或类型断言失败,返回nil。
func (*Context) GetSafeGPCValBool ¶ added in v0.13.5
GetSafeGPCValBool 安全获取GPC布尔值 这个方法用于从Gin上下文的GPC(全局请求上下文)中安全获取指定路径的字段值。 它首先调用ensureSafeMapGPC方法确保GPC数据已初始化,然后使用helper.NewMap方法将其转换为可操作的Map类型, 最后使用ExtractBool方法根据指定的字段路径提取对应的值。 参数:
- fieldPath string: 要获取的字段路径,支持嵌套路径(如"user.isActive")。
返回值:
- value any: 安全获取到的字段值,如果路径不存在或类型断言失败,返回false。
func (*Context) GetSafeGPCValInt ¶ added in v0.13.5
GetSafeGPCValInt 安全获取GPC整数值 这个方法用于从Gin上下文的GPC(全局请求上下文)中安全获取指定路径的字段值。 它首先调用ensureSafeMapGPC方法确保GPC数据已初始化,然后使用helper.NewMap方法将其转换为可操作的Map类型, 最后使用ExtractInt方法根据指定的字段路径提取对应的值。 参数:
- fieldPath string: 要获取的字段路径,支持嵌套路径(如"user.age")。
返回值:
- value any: 安全获取到的字段值,如果路径不存在或类型断言失败,返回0。
func (*Context) GetSafeGPCValStr ¶ added in v0.13.5
GetSafeGPCValStr 安全获取GPC字符串值 这个方法用于从Gin上下文的GPC(全局请求上下文)中安全获取指定路径的字段值。 它首先调用ensureSafeMapGPC方法确保GPC数据已初始化,然后使用helper.NewMap方法将其转换为可操作的Map类型, 最后使用ExtractString方法根据指定的字段路径提取对应的值。 参数:
- fieldPath string: 要获取的字段路径,支持嵌套路径(如"user.name")。
返回值:
- value any: 安全获取到的字段值,如果路径不存在或类型断言失败,返回空字符串。
func (*Context) GetSafeGPCValTime ¶ added in v0.13.5
GetSafeGPCValTime 安全获取GPC时间值 这个方法用于从Gin上下文的GPC(全局请求上下文)中安全获取指定路径的字段值。 它首先调用ensureSafeMapGPC方法确保GPC数据已初始化,然后使用helper.NewMap方法将其转换为可操作的Map类型, 最后使用ExtractTime方法根据指定的字段路径提取对应的值。 参数:
- fieldPath string: 要获取的字段路径,支持嵌套路径(如"user.birthday")。
返回值:
- value any: 安全获取到的字段值,如果路径不存在或类型断言失败,返回time.Time零值。
func (*Context) GetSafeMapGPC ¶ added in v0.11.0
GetSafeMapGPC 安全获取map类型GPC数据 这个方法用于从Gin上下文的GPC(全局请求上下文)中安全获取map[string]any类型的数据。 它首先检查GPC是否存在,然后根据提供的键(默认为"all")获取对应的数据。 如果键不存在或类型断言失败,会返回空map。 参数:
- key ...string: 可选参数,指定要获取的GPC键,枚举值为"query", "header", "cookie", "data","all"。如果为空,默认使用"all"。
返回值:
- mapData map[string]any: 安全获取到的map[string]any类型数据。
func (*Context) Result ¶ added in v0.11.0
Result 整理结果输出 这个方法用于统一返回API响应结果。接收状态码、消息以及可选的额外参数, 并根据传入的数据类型对结果进行格式化和处理,最终返回JSON格式的响应。 参数:
- ginContext *gin.Context: Gin框架的上下文对象
- code int: 状态码,通常为HTTP状态码。
- msg string: 返回的消息内容。
- data any 选填,主要数据内容,可以是结构体、map、string或slice。
- additionalParams map[string]any 选填,附加参数
func (*Context) Success ¶ added in v0.11.0
Success 返回成功的响应 这个方法用于简化成功响应的构建,接收可变参数, 并根据参数类型自动识别并分配到对应的字段(code、message、data、additionalParams)。 参数:
- args ...any: 可变参数,支持任意顺序传递以下类型:
- int: 状态码(通常使用errcode.Success)
- string: 返回的消息内容
- any: 返回的数据(除int、string、map[string]any外的其他类型)
- map[string]any: 附加参数
示例:
ctx.Success("操作成功") // 只传递消息
ctx.Success(data) // 只传递数据
ctx.Success("操作成功", data) // 消息和数据
ctx.Success(data, "操作成功") // 数据在前,消息在后
ctx.Success("操作成功", data, params) // 消息、数据和附加参数
type ControllerInterface ¶ added in v0.11.0
type ControllerInterface interface {
// CheckInit 控制器初始化确认方法
// 参数:
// - ctx any: crud上下文对象(*crud.Context或者*gin.Context,不同的传入,处理不同的逻辑)
// 功能:在CRUD初始化时调用,用于控制器级别的初始化确认
CheckInit(ctx any) *Context
// GetLogger 获取日志记录器
// 返回值:
// - debugger.LoggerInterface: 日志记录器接口实例
// - bool: 是否成功获取日志记录器
GetLogger() debugger.LoggerInterface
}
ControllerInterface 定义控制器接口 该接口用于规范CRUD控制器必须实现的方法 必选方法:CheckInit - 用于控制器初始化检查
type NewContextOpt ¶ added in v0.11.0
type NewContextOpt = Context
NewContextOpt 目前由于配置项没有分离,所以直接用相等,后续有可能会分离
type Trait ¶
type Trait struct {
PkId string `default:"id"` // 数据表主键
Model any // 模型指针
ModelTableAlias string // 模型表别名
DBI orm.Instance // 数据库实例
ListResultStruct interface{} // 列表返回结构体
DetailResultStruct interface{} // 详情返回结构体
Controller ControllerInterface // 控制器
ModelTableName string // 模型表名
ModelFields []string // 模型所有字段
SoftDeleteField string // 软删除字段名(如: "deleted_at"、"is_deleted" 等)
SoftDeleteCondition string // 软删除判断条件(如: "IS NULL" 或 "= '0000-00-00 00:00:00'",不包含字段名)
OperateTime string // 操作时间
TableAlias string // 表别名(仅用于拼接查询语句,配置别名请用ModelTableAlias)
}
func (*Trait) ActionSetValue ¶
ActionSetValue 设置单个字段值的主要处理方法 参数说明:
- c *gin.Context: Gin框架的上下文对象,包含请求和响应信息
func (*Trait) AllEach ¶
AllEach 对获取的每个数据项进行处理 参数说明:
- ctx *Context: 上下文对象
- item interface{}: 数据列表中的单个数据项
返回值:
- interface{}: 处理后的数据项
func (*Trait) AllOrder ¶
AllOrder 设置获取所有数据的排序规则 参数说明:
- ctx *Context: 上下文对象
返回值:
- interface{}: 排序规则,可以是字符串或其他GORM支持的排序格式
func (*Trait) AllQuery ¶
AllQuery 设置获取所有数据的WHERE条件和其他查询参数 参数说明:
- ctx *Context: 上下文对象
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了查询条件的查询对象
func (*Trait) AllReturn ¶
AllReturn 获取所有数据成功后的返回处理方法 参数说明:
- ctx *Context: 上下文对象
- results interface{}: 查询到的所有数据
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) AllSelect ¶ added in v0.10.7
AllSelect 设置获取所有数据的SELECT字段 参数说明:
- ctx *Context: 上下文对象
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了SELECT字段的查询对象
func (*Trait) BindMapToStruct ¶
BindMapToStruct 将map数据绑定到struct,并处理类型转换 参数说明:
- mapData map[string]any: 要绑定的map数据
- modelValue interface{}: 目标struct的指针,必须是非nil的指针类型
返回值:
- error: 绑定过程中的错误信息
func (*Trait) CreateAfter ¶
CreateAfter 创建后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- ctx *Context: crud上下文对象
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 已创建的模型实例
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) CreateBefore ¶
func (t *Trait) CreateBefore(ctx *Context, modelValue interface{}, mapData map[string]any) (interface{}, map[string]any, error)
CreateBefore 创建前的钩子方法,用于数据预处理和验证 参数说明:
- ctx *Context: crud上下文对象
- modelValue interface{}: 要创建的模型实例
- mapData map[string]any: 表单数据映射
返回值:
- interface{}: 处理后的模型实例
- map[string]any: 处理后的表单数据映射
- error: 处理过程中的错误信息
func (*Trait) CreateFormData ¶
func (t *Trait) CreateFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
CreateFormData 获取创建操作的表单数据 参数说明:
- ctx *Context: crud上下文对象
返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) CreateReturn ¶
CreateReturn 创建成功后的返回处理方法 参数说明:
- ctx *Context: 自定义上下文对象
- item any: 创建成功的数据项
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) DeleteAfter ¶
func (t *Trait) DeleteAfter(ctx *Context, delIds []interface{}, delArr []map[string]interface{}) error
DeleteAfter 删除后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- ctx *Context: crud请求上下文对象
- delIds []interface{}: 已删除的ID列表
- delArr []map[string]interface{}: 已删除的数据记录列表
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) DeleteBefore ¶
func (t *Trait) DeleteBefore(ctx *Context, delArr []map[string]interface{}, delIds []interface{}) ([]interface{}, error)
DeleteBefore 删除前的钩子方法,用于数据预处理和验证 参数说明:
- ctx *Context: crud请求上下文对象
- delArr []map[string]interface{}: 要删除的数据记录列表
- delIds []interface{}: 要删除的ID列表
返回值:
- []interface{}: 处理后的ID列表
- error: 处理过程中的错误信息
func (*Trait) DeleteCondition ¶
func (t *Trait) DeleteCondition(ctx *Context, delArr []map[string]interface{}) map[string]interface{}
DeleteCondition 获取软删除的条件数据 参数说明:
- ctx *Context: crud请求上下文对象
- delArr []map[string]interface{}: 要删除的数据记录列表
返回值:
- map[string]interface{}: 软删除时要更新的字段和值
func (*Trait) DeleteFields ¶
DeleteFields 获取删除操作时需要查询的字段列表 参数说明:
- ctx *Context: crud请求上下文对象
返回值:
- []string: 字段名称列表,默认只包含主键字段
func (*Trait) DeleteReturn ¶
DeleteReturn 删除成功后的返回处理方法 参数说明:
- ctx *Context: crud请求上下文对象
- delIds []interface{}: 已删除的ID列表
- delArr []map[string]interface{}: 已删除的数据记录列表
func (*Trait) Detail ¶
Detail 对详情数据进行处理 参数说明:
- ctx *Context: crud上下文对象
- item interface{}: 查询到的详情数据
返回值:
- interface{}: 处理后的详情数据
func (*Trait) DetailFormData ¶ added in v0.8.0
DetailFormData 获取详情查询的参数数据 参数说明:
- ctx *Context: crud上下文对象
返回值:
- map[string]any: 请求参数映射
- error: 处理过程中的错误信息
func (*Trait) DetailQuery ¶
DetailQuery 设置详情查询的WHERE条件和其他查询参数 参数说明:
- ctx *Context: crud上下文对象
- query *gorm.DB: 数据库查询对象
- mapData map[string]any: 请求参数映射
返回值:
- *gorm.DB: 设置了查询条件的查询对象
func (*Trait) DetailReturn ¶
DetailReturn 详情查询成功后的返回处理方法 参数说明:
- ctx *Context: crud上下文对象
- detail interface{}: 详情数据
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) DetailSelect ¶ added in v0.9.1
DetailSelect 设置详情查询的SELECT字段 参数说明:
- ctx *Context: crud上下文对象
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了SELECT字段的查询对象
func (*Trait) ExtractPkId ¶
ExtractPkId 从不同类型的请求中提取主键ID 参数:
- c *gin.Context: Gin框架的上下文对象
返回值:
- pkValue uint: 提取到的主键ID值
- err error: 提取过程中的错误信息
func (*Trait) GetDeleteWhere ¶
GetDeleteWhere 构建删除操作的WHERE条件 参数说明:
- ctx *Context: crud请求上下文对象
- deleteQuery *gorm.DB: 数据库查询对象
- ids []interface{}: 要删除的ID列表
返回值:
- *gorm.DB: 添加了WHERE条件的查询对象
func (*Trait) InitCrud ¶ added in v0.8.0
InitCrud 初始化CRUD,仅当初始化完成才可以使用 参数说明:
- c *gin.Context: Gin框架的上下文对象,包含请求和响应信息
- args ...any: 可选的参数列表 -- actionName string: 操作名称(如: "create", "update", "delete", "detail", "list", "all", "set-value")
返回值:
- *Context: 新创建的上下文对象
func (*Trait) ListEach ¶
ListEach 对列表中的每个数据项进行处理 参数说明:
- ctx *Context: 上下文对象
- item interface{}: 列表中的单个数据项
返回值:
- interface{}: 处理后的数据项
func (*Trait) ListOrder ¶
ListOrder 设置列表查询的排序规则 参数说明:
- ctx *Context: 上下文对象
返回值:
- order interface{}: 排序规则,可以是字符串或其他GORM支持的排序格式
func (*Trait) ListQuery ¶
ListQuery 设置列表查询的WHERE条件和其他查询参数 参数说明:
- ctx *Context: 上下文对象
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了查询条件的查询对象
- error: 处理过程中的错误信息
func (*Trait) ListReturn ¶
ListReturn 列表查询成功后的返回处理方法 参数说明:
- ctx *Context: 上下文对象
- listData jcbaseGo.ListData: 包含列表数据和分页信息的结构体
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) ListSelect ¶
ListSelect 设置列表查询的SELECT字段 参数说明:
- ctx *Context: 上下文对象
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了SELECT字段的查询对象
func (*Trait) SaveAfter ¶ added in v0.8.0
SaveAfter 保存后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- ctx *Context: crud上下文对象
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 已保存的模型实例
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) SaveBefore ¶
func (t *Trait) SaveBefore(ctx *Context, modelValue interface{}, mapData map[string]any, originalData ...interface{}) (interface{}, map[string]any, error)
SaveBefore 保存前 参数说明:
- ctx *Context: crud上下文对象
- modelValue interface{}: 要保存的模型数据
- mapData map[string]any: 表单数据映射
- originalData ...interface{}: 原始数据(仅在更新操作时提供,创建操作时为nil)
返回值:
- modelValue interface{}: 处理后的模型实例
- mapData map[string]any: 处理后的表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) SaveFormData ¶
func (t *Trait) SaveFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
SaveFormData 获取保存操作的表单数据 参数说明:
- ctx *Context: crud上下文对象
返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) SetValueAfter ¶
SetValueAfter 设置字段值后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- ctx *Context: crud上下文对象
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 包含设置字段值的模型实例(与其他钩子不同的是,其他钩子的modelValue是处理后的模型实例,而set-value的modelValue是表单数据绑定的模型实例,因为set-value是直接更新指定字段)
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) SetValueBefore ¶
func (t *Trait) SetValueBefore(ctx *Context, modelValue interface{}, mapData map[string]any, originalData interface{}) (interface{}, map[string]any, error)
SetValueBefore 设置字段值前的钩子方法,用于数据预处理和验证 参数说明:
- ctx *Context: crud上下文对象
- modelValue interface{}: 表单数据绑定的模型实例
- mapData map[string]any: 表单数据映射
- originalData interface{}: 数据库中的数据
返回值:
- interface{}: 处理后的模型实例
- map[string]any: 处理后的表单数据映射
- error: 处理过程中的错误信息
func (*Trait) SetValueCheckField ¶
SetValueCheckField 验证传入的字段名是否有效 参数说明:
- ctx *Context: crud上下文对象
- field string: 要验证的字段名
返回值:
- error: 验证失败时的错误信息
func (*Trait) SetValueFormData ¶
func (t *Trait) SetValueFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
SetValueFormData 获取设置字段值操作的表单数据 参数说明:
- ctx *Context: crud上下文对象
返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) SetValueReturn ¶
SetValueReturn 设置字段值成功后的返回处理方法 参数说明:
- ctx *Context: crud上下文对象
- value interface{}: 设置的值
- field string: 设置的字段名
- id uint: 被设置的记录ID
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) UpdateAfter ¶
func (t *Trait) UpdateAfter(ctx *Context, tx *gorm.DB, modelValue interface{}, originalData interface{}) error
UpdateAfter 更新后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- ctx *Context: crud上下文对象
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 已更新的模型实例
- originalData interface{}: 数据库中的原始数据
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) UpdateBefore ¶
func (t *Trait) UpdateBefore(ctx *Context, modelValue interface{}, mapData map[string]any, originalData interface{}) (interface{}, map[string]any, error)
UpdateBefore 更新前的钩子方法,用于数据预处理和验证 参数说明:
- ctx *Context: crud上下文对象
- modelValue interface{}: 要更新的模型实例(包含新数据)
- mapData map[string]any: 表单数据映射
- originalData interface{}: 数据库中的原始数据
返回值:
- interface{}: 处理后的模型实例
- map[string]any: 处理后的表单数据映射
- error: 处理过程中的错误信息
func (*Trait) UpdateFormData ¶
func (t *Trait) UpdateFormData(ctx *Context) (modelValue interface{}, mapData map[string]any, err error)
UpdateFormData 获取更新操作的表单数据 参数说明:
- ctx *Context: 自定义上下文对象
返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) UpdateReturn ¶
UpdateReturn 更新成功后的返回处理方法 参数说明:
- ctx *Context: crud上下文对象
- item interface{}: 更新成功的数据项
返回值:
- bool: 处理结果,通常返回true表示成功