Documentation
¶
Index ¶
- 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(item interface{}) interface{}
- func (t *Trait) AllOrder() interface{}
- func (t *Trait) AllQuery(query *gorm.DB) *gorm.DB
- func (t *Trait) AllReturn(results interface{}) bool
- func (t *Trait) AllSelect(query *gorm.DB) *gorm.DB
- func (t *Trait) BindMapToStruct(mapData map[string]any, modelValue interface{}) error
- func (t *Trait) CreateAfter(tx *gorm.DB, modelValue interface{}) error
- func (t *Trait) CreateBefore(modelValue interface{}, mapData map[string]any) (interface{}, map[string]any, error)
- func (t *Trait) CreateFormData() (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) CreateReturn(item any) bool
- func (t *Trait) DeleteAfter(delIds []interface{}, delArr []map[string]interface{}) error
- func (t *Trait) DeleteBefore(delArr []map[string]interface{}, delIds []interface{}) ([]interface{}, error)
- func (t *Trait) DeleteCondition(delArr []map[string]interface{}) map[string]interface{}
- func (t *Trait) DeleteFields() []string
- func (t *Trait) DeleteReturn(delIds []interface{}, delArr []map[string]interface{})
- func (t *Trait) Detail(item interface{}) interface{}
- func (t *Trait) DetailFormData() (map[string]any, error)
- func (t *Trait) DetailQuery(query *gorm.DB, mapData map[string]any) *gorm.DB
- func (t *Trait) DetailReturn(detail interface{}) bool
- func (t *Trait) DetailSelect(query *gorm.DB) *gorm.DB
- func (t *Trait) ExtractPkId() (pkValue uint, err error)
- func (t *Trait) Failure(args ...any)
- func (t *Trait) GetDeleteWhere(deleteQuery *gorm.DB, ids []interface{}) *gorm.DB
- func (t *Trait) GetSafeMapGPC(key ...string) (mapData map[string]any)
- func (t *Trait) InitCrud(c *gin.Context, args ...any)
- func (t *Trait) ListEach(item interface{}) interface{}
- func (t *Trait) ListOrder() (order interface{})
- func (t *Trait) ListQuery(query *gorm.DB) (*gorm.DB, error)
- func (t *Trait) ListReturn(listData jcbaseGo.ListData) bool
- func (t *Trait) ListSelect(query *gorm.DB) *gorm.DB
- func (t *Trait) Result(code int, msg string, args ...any)
- func (t *Trait) SaveAfter(tx *gorm.DB, modelValue interface{}) error
- func (t *Trait) SaveBefore(modelValue interface{}, mapData map[string]any, originalData ...interface{}) (interface{}, map[string]any, error)
- func (t *Trait) SaveFormData() (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) SetValueAfter(tx *gorm.DB, modelValue interface{}) error
- func (t *Trait) SetValueBefore(modelValue interface{}, mapData map[string]any, originalData interface{}) (interface{}, map[string]any, error)
- func (t *Trait) SetValueCheckField(field string) error
- func (t *Trait) SetValueFormData() (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) SetValueReturn(value interface{}, field string, id uint) bool
- func (t *Trait) Success(args ...any)
- func (t *Trait) UpdateAfter(tx *gorm.DB, modelValue interface{}, originalData interface{}) error
- func (t *Trait) UpdateBefore(modelValue interface{}, mapData map[string]any, originalData interface{}) (interface{}, map[string]any, error)
- func (t *Trait) UpdateFormData() (modelValue interface{}, mapData map[string]any, err error)
- func (t *Trait) UpdateReturn(item interface{}) bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Trait ¶
type Trait struct {
PkId string `default:"id"` // 数据表主键
Model any // 模型指针
ModelTableAlias string // 模型表别名
DBI orm.Instance // 数据库实例
ListResultStruct interface{} // 列表返回结构体
DetailResultStruct interface{} // 详情返回结构体
Controller interface{} // 控制器
ActionName string // Action名称(如: "create", "update", "delete", "detail", "list", "all", "set-value")
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)
BaseControllerTrait controller.Base
}
func (*Trait) ActionSave ¶
ActionSave 保存数据的主要处理方法(自动判断创建或更新) 参数说明:
- c *gin.Context: Gin框架的上下文对象,包含请求和响应信息
func (*Trait) ActionSetValue ¶
ActionSetValue 设置单个字段值的主要处理方法 参数说明:
- c *gin.Context: Gin框架的上下文对象,包含请求和响应信息
func (*Trait) AllEach ¶
func (t *Trait) AllEach(item interface{}) interface{}
AllEach 对获取的每个数据项进行处理 参数说明:
- item interface{}: 数据列表中的单个数据项
返回值:
- interface{}: 处理后的数据项
func (*Trait) AllOrder ¶
func (t *Trait) AllOrder() interface{}
AllOrder 设置获取所有数据的排序规则 返回值:
- interface{}: 排序规则,可以是字符串或其他GORM支持的排序格式
func (*Trait) AllQuery ¶
AllQuery 设置获取所有数据的WHERE条件和其他查询参数 参数说明:
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了查询条件的查询对象
func (*Trait) AllReturn ¶
AllReturn 获取所有数据成功后的返回处理方法 参数说明:
- results interface{}: 查询到的所有数据
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) AllSelect ¶ added in v0.10.7
AllSelect 设置获取所有数据的SELECT字段 参数说明:
- 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 创建后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 已创建的模型实例
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) CreateBefore ¶
func (t *Trait) CreateBefore(modelValue interface{}, mapData map[string]any) (interface{}, map[string]any, error)
CreateBefore 创建前的钩子方法,用于数据预处理和验证 参数说明:
- modelValue interface{}: 要创建的模型实例
- mapData map[string]any: 表单数据映射
返回值:
- interface{}: 处理后的模型实例
- map[string]any: 处理后的表单数据映射
- error: 处理过程中的错误信息
func (*Trait) CreateFormData ¶
CreateFormData 获取创建操作的表单数据 返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) CreateReturn ¶
CreateReturn 创建成功后的返回处理方法 参数说明:
- item any: 创建成功的数据项
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) DeleteAfter ¶
DeleteAfter 删除后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- delIds []interface{}: 已删除的ID列表
- delArr []map[string]interface{}: 已删除的数据记录列表
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) DeleteBefore ¶
func (t *Trait) DeleteBefore(delArr []map[string]interface{}, delIds []interface{}) ([]interface{}, error)
DeleteBefore 删除前的钩子方法,用于数据预处理和验证 参数说明:
- delArr []map[string]interface{}: 要删除的数据记录列表
- delIds []interface{}: 要删除的ID列表
返回值:
- []interface{}: 处理后的ID列表
- error: 处理过程中的错误信息
func (*Trait) DeleteCondition ¶
DeleteCondition 获取软删除的条件数据 参数说明:
- delArr []map[string]interface{}: 要删除的数据记录列表
返回值:
- map[string]interface{}: 软删除时要更新的字段和值
func (*Trait) DeleteReturn ¶
DeleteReturn 删除成功后的返回处理方法 参数说明:
- delIds []interface{}: 已删除的ID列表
- delArr []map[string]interface{}: 已删除的数据记录列表
func (*Trait) Detail ¶
func (t *Trait) Detail(item interface{}) interface{}
Detail 对详情数据进行处理 参数说明:
- item interface{}: 查询到的详情数据
返回值:
- interface{}: 处理后的详情数据
func (*Trait) DetailFormData ¶ added in v0.8.0
DetailFormData 获取详情查询的参数数据 返回值:
- map[string]any: 请求参数映射
- error: 处理过程中的错误信息
func (*Trait) DetailQuery ¶
DetailQuery 设置详情查询的WHERE条件和其他查询参数 参数说明:
- query *gorm.DB: 数据库查询对象
- mapData map[string]any: 请求参数映射
返回值:
- *gorm.DB: 设置了查询条件的查询对象
func (*Trait) DetailReturn ¶
DetailReturn 详情查询成功后的返回处理方法 参数说明:
- detail interface{}: 详情数据
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) DetailSelect ¶ added in v0.9.1
DetailSelect 设置详情查询的SELECT字段 参数说明:
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了SELECT字段的查询对象
func (*Trait) ExtractPkId ¶
ExtractPkId 从不同类型的请求中提取主键ID 返回值:
- pkValue uint: 提取到的主键ID值
- err error: 提取过程中的错误信息
func (*Trait) Failure ¶
Failure 返回失败的响应 这个方法用于简化失败响应的构建,接收可变参数 并根据参数数量确定响应的data、message、code字段的值。 参数:
- message string: 返回的消息内容
- data any: 返回的数据
- code int: 错误码
仅1个参数时,如果是字符串则作为message输出,否则作为data输出; 更多参数时,第一个参数为message,第二个参数为data,第三个参数为code;
func (*Trait) GetDeleteWhere ¶
GetDeleteWhere 构建删除操作的WHERE条件 参数说明:
- deleteQuery *gorm.DB: 数据库查询对象
- ids []interface{}: 要删除的ID列表
返回值:
- *gorm.DB: 添加了WHERE条件的查询对象
func (*Trait) GetSafeMapGPC ¶
GetSafeMapGPC 安全获取map类型的GPC数据 参数说明:
- key ...string: 可选的键名,用于指定获取特定的GPC数据类型(如"get", "post", "all"等)
返回值:
- mapData map[string]any: 获取到的GPC数据映射
func (*Trait) InitCrud ¶ added in v0.8.0
InitCrud 初始化CRUD,仅当初始化完成才可以使用 参数说明:
- c *gin.Context: Gin框架的上下文对象,包含请求和响应信息
- args ...any: 可选的参数列表
func (*Trait) ListEach ¶
func (t *Trait) ListEach(item interface{}) interface{}
ListEach 对列表中的每个数据项进行处理 参数说明:
- item interface{}: 列表中的单个数据项
返回值:
- interface{}: 处理后的数据项
func (*Trait) ListOrder ¶
func (t *Trait) ListOrder() (order interface{})
ListOrder 设置列表查询的排序规则 返回值:
- order interface{}: 排序规则,可以是字符串或其他GORM支持的排序格式
func (*Trait) ListQuery ¶
ListQuery 设置列表查询的WHERE条件和其他查询参数 参数说明:
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了查询条件的查询对象
- error: 处理过程中的错误信息
func (*Trait) ListReturn ¶
ListReturn 列表查询成功后的返回处理方法 参数说明:
- listData jcbaseGo.ListData: 包含列表数据和分页信息的结构体
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) ListSelect ¶
ListSelect 设置列表查询的SELECT字段 参数说明:
- query *gorm.DB: 数据库查询对象
返回值:
- *gorm.DB: 设置了SELECT字段的查询对象
func (*Trait) Result ¶
Result 整理结果输出 这个方法用于统一返回API响应结果。接收状态码、消息以及可选的额外参数, 并根据传入的数据类型对结果进行格式化和处理,最终返回JSON格式的响应。 参数:
- code int: 状态码,通常为HTTP状态码。
- msg string: 返回的消息内容。
- data any 选填,主要数据内容,可以是结构体、map、string或slice。
- additionalParams map[string]any 选填,附加参数
func (*Trait) SaveAfter ¶ added in v0.8.0
SaveAfter 保存后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 已保存的模型实例
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) SaveBefore ¶
func (t *Trait) SaveBefore(modelValue interface{}, mapData map[string]any, originalData ...interface{}) (interface{}, map[string]any, error)
SaveBefore 保存前 参数说明: - modelValue: 要保存的模型数据 - mapData: 表单数据映射 - originalData: 原始数据(仅在更新操作时提供,创建操作时为nil)
func (*Trait) SaveFormData ¶
SaveFormData 获取保存操作的表单数据 返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) SetValueAfter ¶
SetValueAfter 设置字段值后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 包含设置字段值的模型实例(与其他钩子不同的是,其他钩子的modelValue是处理后的模型实例,而set-value的modelValue是表单数据绑定的模型实例,因为set-value是直接更新指定字段)
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) SetValueBefore ¶
func (t *Trait) SetValueBefore(modelValue interface{}, mapData map[string]any, originalData interface{}) (interface{}, map[string]any, error)
SetValueBefore 设置字段值前的钩子方法,用于数据预处理和验证 参数说明:
- modelValue interface{}: 表单数据绑定的模型实例
- mapData map[string]any: 表单数据映射
- originalData interface{}: 数据库中的数据
返回值:
- interface{}: 处理后的模型实例
- map[string]any: 处理后的表单数据映射
- error: 处理过程中的错误信息
func (*Trait) SetValueCheckField ¶
SetValueCheckField 验证传入的字段名是否有效 参数说明:
- field string: 要验证的字段名
返回值:
- error: 验证失败时的错误信息
func (*Trait) SetValueFormData ¶
SetValueFormData 获取设置字段值操作的表单数据 返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) SetValueReturn ¶
SetValueReturn 设置字段值成功后的返回处理方法 参数说明:
- value interface{}: 设置的值
- field string: 设置的字段名
- id uint: 被设置的记录ID
返回值:
- bool: 处理结果,通常返回true表示成功
func (*Trait) Success ¶
Success 返回成功的响应 这个方法用于简化成功响应的构建,接收可变参数, 并根据参数数量确定响应的data、additionalParams和message字段的值。 参数:
- message string: 返回的消息内容
- data any: 返回的数据
- additionalParams any: 附加数据
仅1个参数时,如果是字符串则作为message输出,否则作为data输出; 更多参数时,第一个参数为data,第二个参数为message,第三个参数为additionalParams;
func (*Trait) UpdateAfter ¶
UpdateAfter 更新后的钩子方法,用于后续处理(在事务内执行) 参数说明:
- tx *gorm.DB: 数据库事务对象
- modelValue interface{}: 已更新的模型实例
- originalData interface{}: 数据库中的原始数据
返回值:
- error: 处理过程中的错误信息,如果返回错误则会回滚事务
func (*Trait) UpdateBefore ¶
func (t *Trait) UpdateBefore(modelValue interface{}, mapData map[string]any, originalData interface{}) (interface{}, map[string]any, error)
UpdateBefore 更新前的钩子方法,用于数据预处理和验证 参数说明:
- modelValue interface{}: 要更新的模型实例(包含新数据)
- mapData map[string]any: 表单数据映射
- originalData interface{}: 数据库中的原始数据
返回值:
- interface{}: 处理后的模型实例
- map[string]any: 处理后的表单数据映射
- error: 处理过程中的错误信息
func (*Trait) UpdateFormData ¶
UpdateFormData 获取更新操作的表单数据 返回值:
- modelValue interface{}: 绑定后的模型实例
- mapData map[string]any: 原始表单数据映射
- err error: 处理过程中的错误信息
func (*Trait) UpdateReturn ¶
UpdateReturn 更新成功后的返回处理方法 参数说明:
- item interface{}: 更新成功的数据项
返回值:
- bool: 处理结果,通常返回true表示成功