crud

package
v0.18.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2026 License: MIT Imports: 17 Imported by: 0

README

CRUD系统使用指南

本文档提供了CRUD系统的完整使用指南,包括快速入门、API参考和钩子方法详解。

目录

  1. 快速入门
  2. 使用示例
  3. 钩子方法详解
  4. API参考
  5. 最佳实践

快速入门

CRUD系统提供了完整的增删改查功能,支持自定义钩子方法进行业务逻辑扩展。

主要特性
  • 🚀 开箱即用: 提供完整的CRUD操作
  • 🔧 高度可扩展: 丰富的钩子方法支持自定义逻辑
  • 🛡️ 事务安全: 自动事务管理,支持回滚
  • 📊 分页支持: 内置分页功能
  • 🗑️ 软删除: 支持软删除和硬删除,可自定义软删除字段名
  • 🔍 灵活查询: 支持复杂查询条件

软删除配置

CRUD系统支持灵活的软删除配置,您可以自定义软删除字段名和删除条件。

配置方式

通过在模型字段的 gorm 标签中添加 soft_delete 标签来配置软删除:

import "github.com/jcbowen/jcbaseGo/component/orm/base"

type User struct {
    base.MysqlBaseModel  // 或者 base.SqliteBaseModel
    ID        uint   `gorm:"column:id;primaryKey" json:"id"`
    Name      string `gorm:"column:name;size:100" json:"name"`

    // 方式1: 使用系统默认的 deleted_at 字段(字符串类型)
    DeletedAt string `gorm:"column:deleted_at;type:DATETIME;default:NULL" json:"deleted_at"`

    // 方式1-1: 使用系统默认的 deleted_at 字段(时间类型,推荐)
    // DeletedAt time.Time `gorm:"column:deleted_at;type:DATETIME;default:NULL" json:"deleted_at"`

    // 方式2: 自定义软删除字段,条件为 IS NULL(字符串类型)
    // IsDeleted string `gorm:"column:is_deleted;type:DATETIME;soft_delete:IS NULL" json:"is_deleted"`

    // 方式2-1: 自定义软删除字段,条件为 IS NULL(时间类型,推荐)
    // IsDeleted time.Time `gorm:"column:is_deleted;type:DATETIME;soft_delete:IS NULL" json:"is_deleted"`

    // 方式3: 使用状态字段作为软删除,条件为 = 1(表示正常状态)
    // Status int `gorm:"column:status;type:INT;soft_delete:= 1" json:"status"`

    // 方式4: 使用特殊默认值的 deleted_at 字段(字符串类型)
    // DeletedAt string `gorm:"column:deleted_at;type:DATETIME;default:0000-00-00 00:00:00" json:"deleted_at"`

    // 方式4-1: 使用特殊默认值的 deleted_at 字段(时间类型,推荐)
    // DeletedAt time.Time `gorm:"column:deleted_at;type:DATETIME;default:NULL" json:"deleted_at"`
}
配置说明
  1. 默认配置:如果模型中存在 deleted_at 字段且没有 soft_delete 标签,系统会自动将其作为软删除字段,条件为 IS NULL

  2. 自定义字段名:通过 soft_delete 标签可以指定任意字段作为软删除字段

  3. 自定义条件:soft_delete 标签的值就是软删除的判断条件,如:

    • IS NULL:字段为空表示未删除
    • = 1:字段值为1表示未删除
    • = 'active':字段值为'active'表示未删除
  4. 特殊默认值:如果 deleted_at 字段的默认值为 0000-00-00 00:00:00,系统会自动使用 = '0000-00-00 00:00:00' 作为软删除条件

  5. 时间字段类型:系统支持两种时间字段类型:

    • 字符串类型:string - 向后兼容,现有代码无需修改
    • 时间类型:time.Time - 推荐使用,提供更好的类型安全性和性能
    • 混合使用:同一个模型中可以同时使用字符串和时间类型字段
使用效果
  • 查询时:系统会自动添加软删除条件,只查询未删除的数据
  • 删除时:执行软删除操作,更新软删除字段的值
  • 显示已删除数据:通过 show_deleted=1 参数可以查看已删除的数据

时间字段类型支持

概述

jcbaseGo 现在支持两种时间字段类型,提供完全的向后兼容性:

  • 字符串类型:string - 向后兼容,现有代码无需修改
  • 时间类型:time.Time - 推荐使用,提供更好的类型安全性和性能
字符串类型示例
type User struct {
    base.MysqlBaseModel
    ID        uint   `gorm:"column:id;primaryKey" json:"id"`
    Name      string `gorm:"column:name;size:100" json:"name"`
    CreatedAt string `gorm:"column:created_at;type:DATETIME" json:"created_at"`
    UpdatedAt string `gorm:"column:updated_at;type:DATETIME" json:"updated_at"`
    DeletedAt string `gorm:"column:deleted_at;type:DATETIME;default:NULL" json:"deleted_at"`
}
时间类型示例(推荐)
import "time"

type User struct {
    base.MysqlBaseModel
    ID        uint      `gorm:"column:id;primaryKey" json:"id"`
    Name      string    `gorm:"column:name;size:100" json:"name"`
    CreatedAt time.Time `gorm:"column:created_at;type:DATETIME" json:"created_at"`
    UpdatedAt time.Time `gorm:"column:updated_at;type:DATETIME" json:"updated_at"`
    DeletedAt time.Time `gorm:"column:deleted_at;type:DATETIME;default:NULL" json:"deleted_at"`
}
混合类型示例
type User struct {
    base.MysqlBaseModel
    ID        uint      `gorm:"column:id;primaryKey" json:"id"`
    Name      string    `gorm:"column:name;size:100" json:"name"`
    CreatedAt time.Time `gorm:"column:created_at;type:DATETIME" json:"created_at"` // 时间类型
    UpdatedAt string    `gorm:"column:updated_at;type:DATETIME" json:"updated_at"` // 字符串类型
    DeletedAt time.Time `gorm:"column:deleted_at;type:DATETIME;default:NULL" json:"deleted_at"` // 时间类型
}
时间字段类型优势
使用 time.Time 类型的优势:
  1. 类型安全:编译时检查,避免时间格式错误
  2. 更好的性能:无需字符串解析和格式化
  3. 丰富的API:支持时间计算、比较等操作
  4. 标准化:符合 Go 语言最佳实践
向后兼容性:
  • 现有使用字符串类型的代码继续正常工作
  • 可以逐步迁移,无需一次性修改所有代码
  • 新旧类型可以在同一个项目中并存
迁移指南

详细的迁移指南和示例代码请参考:

  • example/time_field_migration/README.md - 完整迁移指南
  • example/time_field_migration/string_type/ - 字符串类型示例
  • example/time_field_migration/time_type/ - 时间类型示例
  • example/time_field_migration/mixed_type/ - 混合类型示例
  • example/time_field_migration/migration/ - 完整迁移示例

使用示例

控制器
package user

import (
	"github.com/jcbowen/jcbaseGo/component/trait/crud"
	"github.com/jcbowen/jcbaseGo/component/orm/mysql"  // MySQL
	"github.com/jcbowen/jcbaseGo/component/orm/sqlite" // SQLite
	"officeAutomation/controllers/base"
	"officeAutomation/library"
	userModel "officeAutomation/model/common/user"
	"github.com/jcbowen/jcbaseGo/component/orm"
)

type Index struct {
	base.Controller
	*crud.Trait
}

// New 初始化并传递数据模型、数据库连接、当前控制器给crud
func New() *Index {
	// MySQL 示例
	index := &Index{
		Trait: &crud.Trait{
			Model: &userModel.Account{},
			DBI:    library.Mysql,
		},
	}
	
	// SQLite 示例
	/*
	sqliteDb, err := sqlite.New(jcbaseGo.SqlLiteStruct{
		DbFile: "path/to/your/database.db",
	})
	if err != nil {
		panic(err)
	}
	index := &Index{
		Trait: &crud.Trait{
			Model: &userModel.Account{},
			DBI:    sqliteDb,
		},
	}
	*/
	
	index.Trait.Controller = index
	return index
}

// ListEach 自定义一个ListEach方法替换crud中的ListEach
func (i Index) ListEach(item interface{}) interface{} {
	log.Println(item, "666", item.(*userModel.Account).Id)
	return item
}
路由配置
systemGroup := r.Group("/system")
systemGroup.Use(middleware.LoginRequired())
{
    systemUserGroup := systemGroup.Group("/user")
    {
		// 直接调用crud中的方法即可
        systemUser := systemUserController.New()
        systemUserGroup.GET("/list", systemUser.ActionList)      // 获取列表
        systemUserGroup.GET("/detail", systemUser.ActionDetail) // 获取详情
        systemUserGroup.POST("/create", systemUser.ActionCreate) // 创建
        systemUserGroup.POST("/update", systemUser.ActionUpdate) // 更新
        systemUserGroup.POST("/save", systemUser.ActionSave)     // 保存(自动判断创建/更新)
        systemUserGroup.POST("/delete", systemUser.ActionDelete) // 删除
        systemUserGroup.GET("/all", systemUser.ActionAll)        // 获取所有数据
        systemUserGroup.POST("/set-value", systemUser.ActionSetValue) // 设置字段值
    }
}
自定义钩子方法示例
// 创建前的数据验证
func (i *Index) CreateBefore(ctx *crud.Context, modelValue interface{}, mapData map[string]any) (interface{}, map[string]any, error) {
    user := modelValue.(*userModel.Account)

    // 验证用户名是否已存在
    var count int64
    i.DBI.GetDb().Model(&userModel.Account{}).Where("username = ?", user.Username).Count(&count)
    if count > 0 {
        return nil, nil, errors.New("用户名已存在")
    }

    // 密码加密
    user.Password = helper.Md5(user.Password)

    return user, mapData, nil
}

// 更新前的数据验证(可以访问原始数据)
func (i *Index) UpdateBefore(ctx *crud.Context, modelValue interface{}, mapData map[string]any, originalData interface{}) (interface{}, map[string]any, error) {
    user := modelValue.(*userModel.Account)
    original := originalData.(*userModel.Account)

    // 如果密码有变化,进行加密
    if user.Password != "" && user.Password != original.Password {
        user.Password = helper.Md5(user.Password)
    }

    return user, mapData, nil
}

// 列表数据处理
func (i *Index) ListEach(ctx *crud.Context, item interface{}) interface{} {
    user := item.(*userModel.Account)
    // 隐藏敏感信息
    user.Password = ""
    return user
}

// 自定义查询条件
func (i *Index) ListQuery(ctx *crud.Context, query *gorm.DB) (*gorm.DB, error) {
    // 只显示启用的用户
    return query.Where("status = ?", 1), nil
}

钩子方法详解

CRUD系统提供了丰富的钩子方法,允许在不同阶段插入自定义逻辑。

执行时机图
创建流程:
FormData → CreateBefore → [事务开始] → 插入数据 → CreateAfter → [事务提交] → CreateReturn

更新流程:
FormData → 查询原始数据 → UpdateBefore → [事务开始] → 更新数据 → UpdateAfter → [事务提交] → UpdateReturn

删除流程:
获取参数 → 查询要删除的数据 → DeleteBefore → [事务开始] → 删除数据 → DeleteAfter → [事务提交] → DeleteReturn
重要改进说明
UpdateBefore方法优化 ⭐
  • 调整时机: 从"获取表单数据后"移动到"查询原始数据后、开始事务前"
  • 新增参数: 增加了originalData参数,可以访问数据库中的原始数据
  • 优势:
    • 可以基于原始数据进行更精确的验证和处理
    • 与DeleteBefore的设计模式保持一致
    • 避免无效处理(只有在数据确实存在时才会执行前置处理)
SaveBefore方法兼容性优化 ⭐
  • 参数调整: 使用可变参数originalData ...interface{}
  • 兼容性: 同时支持创建场景(不传originalData)和更新场景(传入originalData)
  • 使用方式: 通过len(originalData) > 0 && originalData[0] != nil判断是否为更新操作
func (i *Index) SaveBefore(ctx *crud.Context, modelValue interface{}, mapData map[string]any, originalData ...interface{}) (interface{}, map[string]any, error) {
    if len(originalData) > 0 && originalData[0] != nil {
        // 更新操作 - 可以访问原始数据
        original := originalData[0].(*userModel.Account)
        // 基于原始数据进行处理...
    } else {
        // 创建操作 - 没有原始数据
        // 进行创建前的处理...
    }

    return modelValue, mapData, nil
}

API参考

主要操作方法
ActionCreate
  • 功能: 创建数据的主要处理方法
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: POST
  • 请求参数: 模型对应的字段数据
ActionUpdate
  • 功能: 更新数据的主要处理方法
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: POST
  • 请求参数: 包含主键ID和要更新的字段数据
ActionDelete
  • 功能: 删除数据的主要处理方法
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: POST
  • 请求参数: {主键名}s - ID数组,如 ids: [1,2,3]
ActionList
  • 功能: 获取数据列表的主要处理方法(分页)
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: GET
  • 查询参数:
    • page: 页码(默认1)
    • page_size: 每页数量(默认10)
ActionDetail
  • 功能: 获取数据详情的主要处理方法
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: GET
  • 查询参数: 主键ID
ActionAll
  • 功能: 获取所有数据的主要处理方法(不分页)
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: GET
  • 查询参数:
    • show_deleted: 是否显示已删除数据(0/1,默认0)
ActionSave
  • 功能: 保存数据的主要处理方法(自动判断创建或更新)
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: POST
  • 请求参数: 模型对应的字段数据,如果包含主键ID则为更新,否则为创建
ActionSetValue
  • 功能: 设置单个字段值的主要处理方法
  • 参数: c *gin.Context - Gin框架的上下文对象
  • HTTP方法: POST
  • 请求参数:
    • 主键ID
    • field: 字段名
    • value: 字段值
钩子方法详细说明
创建操作钩子
CreateFormData
  • 功能: 获取创建操作的表单数据
  • 参数:
    • ctx *Context - crud上下文对象
  • 返回值:
    • modelValue interface{} - 绑定后的模型实例
    • mapData map[string]any - 原始表单数据映射
    • err error - 处理过程中的错误信息
CreateBefore (钩子方法)
  • 功能: 创建前的钩子方法,用于数据预处理和验证
  • 参数:
    • ctx *Context - crud上下文对象
    • modelValue interface{} - 要创建的模型实例
    • mapData map[string]any - 表单数据映射
  • 返回值:
    • interface{} - 处理后的模型实例
    • map[string]any - 处理后的表单数据映射
    • error - 处理过程中的错误信息
CreateAfter (钩子方法)
  • 功能: 创建后的钩子方法,用于后续处理(在事务内执行)
  • 参数:
    • ctx *Context - crud上下文对象
    • tx *gorm.DB - 数据库事务对象
    • modelValue interface{} - 已创建的模型实例
  • 返回值: error - 处理过程中的错误信息,如果返回错误则会回滚事务
CreateReturn
  • 功能: 创建成功后的返回处理方法
  • 参数:
    • ctx *Context - crud上下文对象
    • item any - 创建成功的数据项
  • 返回值: bool - 处理结果,通常返回true表示成功
更新操作钩子
UpdateFormData
  • 功能: 获取更新操作的表单数据
  • 参数:
    • ctx *Context - crud上下文对象
  • 返回值:
    • modelValue interface{} - 绑定后的模型实例
    • mapData map[string]any - 原始表单数据映射
    • err error - 处理过程中的错误信息
UpdateBefore (钩子方法)
  • 功能: 更新前的钩子方法,用于数据预处理和验证
  • 参数:
    • ctx *Context - crud上下文对象
    • modelValue interface{} - 要更新的模型实例(包含新数据)
    • mapData map[string]any - 表单数据映射
    • originalData interface{} - 数据库中的原始数据
  • 返回值:
    • interface{} - 处理后的模型实例
    • map[string]any - 处理后的表单数据映射
    • error - 处理过程中的错误信息
UpdateAfter (钩子方法)
  • 功能: 更新后的钩子方法,用于后续处理(在事务内执行)
  • 参数:
    • ctx *Context - crud上下文对象
    • tx *gorm.DB - 数据库事务对象
    • modelValue interface{} - 已更新的模型实例
    • originalData interface{} - 数据库中的原始数据
  • 返回值: error - 处理过程中的错误信息,如果返回错误则会回滚事务
UpdateReturn
  • 功能: 更新成功后的返回处理方法
  • 参数:
    • ctx *Context - crud上下文对象
    • item interface{} - 更新成功的数据项
  • 返回值: bool - 处理结果,通常返回true表示成功
删除操作钩子
DeleteFields
  • 功能: 获取删除操作时需要查询的字段列表
  • 参数:
    • ctx *Context - crud请求上下文对象
  • 返回值: []string - 字段名称列表,默认只包含主键字段
GetDeleteWhere
  • 功能: 构建删除操作的WHERE条件
  • 参数:
    • ctx *Context - crud请求上下文对象
    • deleteQuery *gorm.DB - 数据库查询对象
    • ids []interface{} - 要删除的ID列表
  • 返回值: *gorm.DB - 添加了WHERE条件的查询对象
DeleteBefore (钩子方法)
  • 功能: 删除前的钩子方法,用于数据预处理和验证
  • 参数:
    • ctx *Context - crud请求上下文对象
    • delArr []map[string]interface{} - 要删除的数据记录列表
    • delIds []interface{} - 要删除的ID列表
  • 返回值:
    • []interface{} - 处理后的ID列表
    • error - 处理过程中的错误信息
DeleteCondition
  • 功能: 获取软删除的条件数据
  • 参数:
    • ctx *Context - crud请求上下文对象
    • delArr []map[string]interface{} - 要删除的数据记录列表
  • 返回值: map[string]interface{} - 软删除时要更新的字段和值
DeleteAfter
  • 功能: 删除操作后的处理方法(在事务内执行)
  • 参数:
    • ctx *Context - crud请求上下文对象
    • delIds []interface{} - 已删除的ID列表
    • delArr []map[string]interface{} - 已删除的数据记录列表
  • 返回值: error - 处理过程中的错误信息,如果返回错误则会回滚事务
DeleteReturn
  • 功能: 删除成功后的返回处理方法
  • 参数:
    • ctx *Context - crud请求上下文对象
    • delIds []interface{} - 已删除的ID列表
    • delArr []map[string]interface{} - 已删除的数据记录列表
  • 返回值: bool - 处理结果,通常返回true表示成功
查询操作钩子
ListSelect
  • 功能: 设置列表查询的SELECT字段
  • 参数:
    • ctx *Context - crud请求上下文对象
    • query *gorm.DB - 数据库查询对象
  • 返回值: *gorm.DB - 设置了SELECT字段的查询对象
ListQuery
  • 功能: 设置列表查询的WHERE条件和其他查询参数
  • 参数:
    • ctx *Context - crud请求上下文对象
    • query *gorm.DB - 数据库查询对象
  • 返回值: *gorm.DB - 设置了查询条件的查询对象
    • error - 处理过程中的错误信息
ListOrder
  • 功能: 设置列表查询的排序规则
  • 参数:
    • ctx *Context - crud请求上下文对象
  • 返回值: interface{} - 排序规则,可以是字符串或其他GORM支持的排序格式
ListEach
  • 功能: 对列表中的每个数据项进行处理(如添加计算字段或隐藏敏感信息)
  • 参数:
    • ctx *Context - crud请求上下文对象
    • item interface{} - 列表中的单个数据项
  • 返回值: interface{} - 处理后的数据项
ListReturn
  • 功能: 列表查询成功后的返回处理方法
  • 参数:
    • ctx *Context - crud请求上下文对象
    • listData jcbaseGo.ListData - 包含列表数据和分页信息的结构体
  • 返回值: bool - 处理结果,通常返回true表示成功
All 操作钩子
AllQuery
  • 功能: 设置获取所有数据的WHERE条件和其他查询参数
  • 参数:
    • ctx *Context - crud请求上下文对象
    • query *gorm.DB - 数据库查询对象
  • 返回值: *gorm.DB - 设置了查询条件的查询对象
AllSelect
  • 功能: 设置获取所有数据的SELECT字段
  • 参数:
    • ctx *Context - crud请求上下文对象
    • query *gorm.DB - 数据库查询对象
  • 返回值: *gorm.DB - 设置了SELECT字段的查询对象
AllOrder
  • 功能: 设置获取所有数据的排序规则
  • 参数:
    • ctx *Context - crud请求上下文对象
  • 返回值: interface{} - 排序规则,可以是字符串或其他GORM支持的排序格式
AllEach
  • 功能: 对获取的每个数据项进行处理
  • 参数:
    • ctx *Context - crud请求上下文对象
    • item interface{} - 数据列表中的单个数据项
  • 返回值: interface{} - 处理后的数据项
AllReturn
  • 功能: 获取所有数据成功后的返回处理方法
  • 参数:
    • ctx *Context - crud请求上下文对象
    • results interface{} - 查询到的所有数据
  • 返回值: bool - 处理结果,通常返回true表示成功
DetailSelect
  • 功能: 设置详情查询的SELECT字段
  • 参数:
    • ctx *Context - crud请求上下文对象
    • query *gorm.DB - 数据库查询对象
  • 返回值: *gorm.DB - 设置了SELECT字段的查询对象
DetailQuery
  • 功能: 设置详情查询的WHERE条件和其他查询参数
  • 参数:
    • ctx *Context - crud请求上下文对象
    • query *gorm.DB - 数据库查询对象
    • mapData map[string]any - 请求参数映射
  • 返回值: *gorm.DB - 设置了查询条件的查询对象
Detail
  • 功能: 详情查询成功后的数据处理方法
  • 参数:
    • ctx *Context - crud请求上下文对象
    • item interface{} - 查询到的详情数据
  • 返回值: interface{} - 处理后的详情数据
DetailReturn
  • 功能: 详情查询成功后的返回处理方法
  • 参数:
    • ctx *Context - crud请求上下文对象
    • detail interface{} - 处理后的详情数据
  • 返回值: bool - 处理结果,通常返回true表示成功
保存操作钩子
SaveBefore (钩子方法) ⭐ 已优化
  • 功能: 保存前的钩子方法,用于数据预处理和验证
  • 参数:
    • ctx *Context - crud上下文对象
    • modelValue interface{} - 要保存的模型数据
    • mapData map[string]any - 表单数据映射
    • originalData ...interface{} - 原始数据(仅在更新操作时提供,创建操作时为nil)
  • 返回值:
    • interface{} - 处理后的模型实例
    • map[string]any - 处理后的表单数据映射
    • error - 处理过程中的错误信息
SaveAfter
  • 功能: 保存操作后的处理方法(在事务内执行)
  • 参数:
    • ctx *Context - crud上下文对象
    • tx *gorm.DB - 数据库事务对象
    • modelValue interface{} - 保存后的模型实例
  • 返回值: error - 处理过程中的错误信息,如果返回错误则会回滚事务
设置字段值钩子
SetValueFormData
  • 功能: 获取设置字段值操作的表单数据
  • 参数:
    • ctx *Context - crud上下文对象
  • 返回值:
    • modelValue interface{} - 绑定后的模型实例
    • mapData map[string]any - 原始表单数据映射
    • error - 处理过程中的错误信息
SetValueCheckField
  • 功能: 验证传入的字段名是否有效
  • 参数:
    • ctx *Context - crud上下文对象
    • field string - 要验证的字段名
  • 返回值: error - 验证失败时的错误信息
SetValueBefore
  • 功能: 设置字段值前的钩子方法,用于数据预处理和验证
  • 参数:
    • ctx *Context - crud上下文对象
    • modelValue interface{} - 表单数据绑定的模型实例
    • mapData map[string]any - 表单数据映射
    • originalData interface{} - 数据库中的数据
  • 返回值:
    • interface{} - 处理后的模型实例
    • map[string]any - 处理后的表单数据映射
    • error - 处理过程中的错误信息
SetValueAfter
  • 功能: 设置字段值后的钩子方法,用于后续处理(在事务内执行)
  • 参数:
    • ctx *Context - crud上下文对象
    • tx *gorm.DB - 数据库事务对象
    • modelValue interface{} - 包含设置字段值的模型实例
  • 返回值: error - 处理过程中的错误信息,如果返回错误则会回滚事务
SetValueReturn
  • 功能: 设置字段值成功后的返回处理方法
  • 参数:
    • ctx *Context - crud上下文对象
    • value interface{} - 设置的值
    • field string - 设置的字段名
    • id uint - 被设置的记录ID
  • 返回值: bool - 处理结果,通常返回true表示成功

最佳实践

1. 钩子方法使用建议
  • Before方法: 用于数据验证、权限检查、数据预处理等
  • After方法: 用于日志记录、缓存更新、消息推送等后续处理
  • Return方法: 用于自定义返回格式和内容
  • 错误处理: Before和After方法返回错误时会中断操作并回滚事务(如果在事务内)
2. 性能优化建议
  • 在Before方法中进行轻量级验证,避免复杂的数据库查询
  • 使用After方法进行异步处理,如发送邮件、更新缓存等
  • 合理使用Select方法,只查询需要的字段
  • 在Query方法中添加适当的索引条件
3. 安全建议
  • 在Before方法中进行权限验证
  • 对敏感字段进行加密处理
  • 在Each方法中过滤敏感信息
  • 使用参数绑定防止SQL注入
4. 事务管理和锁定优化 ⭐
事务最佳实践
  • 使用GORM的Transaction方法: 自动处理提交和回滚,避免手动管理事务
  • 避免长时间事务: 在After方法中避免执行耗时的外部API调用或文件处理
  • 事务超时控制: 设置合理的事务超时时间,防止长时间锁定
// 推荐的事务处理方式
err := db.Transaction(func(tx *gorm.DB) error {
    // 数据库操作
    if err := tx.Create(&user).Error; err != nil {
        return err
    }
    
    // 轻量级的后续处理
    if err := tx.Create(&profile).Error; err != nil {
        return err
    }
    
    return nil
})
避免锁定的建议
  • 避免嵌套事务: 不要在钩子方法中开启新的事务
  • 及时释放锁: 确保事务尽快提交或回滚
  • 使用乐观锁: 对于并发更新场景,考虑使用版本号或时间戳
  • 连接池配置: 合理配置连接池参数,防止连接泄漏
// 乐观锁示例
type User struct {
    ID      uint   `gorm:"primaryKey"`
    Name    string
    Version int    `gorm:"default:1"` // 版本号字段
}

// 更新时检查版本号
func (u *User) UpdateWithOptimisticLock(tx *gorm.DB, newName string) error {
    result := tx.Model(u).
        Where("id = ? AND version = ?", u.ID, u.Version).
        Updates(map[string]interface{}{
            "name":    newName,
            "version": u.Version + 1,
        })
    
    if result.RowsAffected == 0 {
        return errors.New("数据已被其他用户修改,请重试")
    }
    
    return nil
}
连接池配置建议
// MySQL连接池配置
sqlDB, err := db.DB()
if err == nil {
    sqlDB.SetMaxOpenConns(100)        // 最大连接数
    sqlDB.SetMaxIdleConns(10)         // 最大空闲连接数
    sqlDB.SetConnMaxLifetime(5 * time.Minute)  // 连接最大生命周期
    sqlDB.SetConnMaxIdleTime(3 * time.Minute)  // 空闲连接超时时间
}
5. 错误处理
func (i *Index) CreateBefore(ctx *crud.Context, modelValue interface{}, mapData map[string]any) (interface{}, map[string]any, error) {
    // 数据验证
    if err := i.validateData(modelValue); err != nil {
        return nil, nil, err // 返回错误会中断操作
    }

    return modelValue, mapData, nil
}
6. 日志记录
func (i *Index) CreateAfter(ctx *crud.Context, tx *gorm.DB, modelValue interface{}) error {
    user := modelValue.(*userModel.Account)

    // 记录操作日志
    log.Printf("用户创建成功: ID=%d, Username=%s", user.Id, user.Username)

    return nil
}

所有钩子方法都支持在继承的控制器中重写,以实现自定义的业务逻辑。

ControllerInterface(控制器接口)
  • 必选方法:CheckInit(ctx any) *crud.Context
  • 参数:
    • ctx any: 控制器上下文对象,支持 *crud.Context 或 *gin.Context
  • 返回:
    • *crud.Context: 确认后的 CRUD 上下文对象
  • 作用:
    • 在 CRUD 初始化时调用,用于控制器级别的初始化确认与上下文准备
    • 可在此方法中设置调试模式、注入公共参数、执行权限校验等
CheckInit 初始化确认方法(示例)
import (
    "github.com/gin-gonic/gin"
    "github.com/jcbowen/jcbaseGo/component/trait/crud"
    "officeAutomation/library"
)

// CheckInit 控制器初始化确认方法
// 参数:
//   - ctx any: crud上下文对象(*crud.Context或者*gin.Context,不同的传入,处理不同的逻辑)
//
// 返回:
//   - *crud.Context: 确认后的crud上下文对象
//
// 功能:在CRUD初始化时调用,用于控制器级别的初始化确认
func (i *Index) CheckInit(ctx any) *crud.Context {
    var (
        crudCtx *crud.Context
        ok      bool
    )
    // 确认crud上下文对象是否为*crud.Context类型
    if crudCtx, ok = ctx.(*crud.Context); ok {
        // 根据运行模式设置调试标识(使用项目库中的模式)
        crudCtx.Debug = library.Mode == "debug"
    } else if ginCtx, ok := ctx.(*gin.Context); ok {
        // 传入的是 *gin.Context 时,构建一个新的 CRUD 上下文
        crudCtx = crud.NewContext(&crud.NewContextOpt{
            ActionName: "custom",
            GinContext: ginCtx,
            Debug:      library.Mode == "debug",
        })
    }

    return crudCtx
}

说明:

  • 入参可兼容 *crud.Context 与 *gin.Context 两种类型,便于在不同场景下复用。
  • 可在此方法中设置全局或控制器级别的调试信息、权限校验、公共上下文数据等。
  • 当入参为 *gin.Context 时,会创建一个新的 *crud.Context 以便后续流程统一使用。

Documentation

Index

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

func (ctx *Context) Failure(args ...any)

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

func (ctx *Context) GetSafeGPCVal(fieldPath string) (value any)

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

func (ctx *Context) GetSafeGPCValBool(fieldPath string) (value bool)

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

func (ctx *Context) GetSafeGPCValInt(fieldPath string) (value int)

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

func (ctx *Context) GetSafeGPCValStr(fieldPath string) (value string)

GetSafeGPCValStr 安全获取GPC字符串值 这个方法用于从Gin上下文的GPC(全局请求上下文)中安全获取指定路径的字段值。 它首先调用ensureSafeMapGPC方法确保GPC数据已初始化,然后使用helper.NewMap方法将其转换为可操作的Map类型, 最后使用ExtractString方法根据指定的字段路径提取对应的值。 参数:

  • fieldPath string: 要获取的字段路径,支持嵌套路径(如"user.name")。

返回值:

  • value any: 安全获取到的字段值,如果路径不存在或类型断言失败,返回空字符串。

func (*Context) GetSafeGPCValTime added in v0.13.5

func (ctx *Context) GetSafeGPCValTime(fieldPath string) (value time.Time)

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

func (ctx *Context) GetSafeMapGPC(key ...string) (mapData map[string]any)

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

func (ctx *Context) Result(code int, msg string, args ...any)

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

func (ctx *Context) Success(args ...any)

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) ActionAll

func (t *Trait) ActionAll(c *gin.Context)

ActionAll 获取所有数据的主要处理方法(不分页) 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息

func (*Trait) ActionCreate

func (t *Trait) ActionCreate(c *gin.Context)

ActionCreate 创建数据的主要处理方法 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息

func (*Trait) ActionDelete

func (t *Trait) ActionDelete(c *gin.Context)

ActionDelete 删除数据的主要处理方法 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息

func (*Trait) ActionDetail

func (t *Trait) ActionDetail(c *gin.Context)

ActionDetail 获取数据详情的主要处理方法 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息

func (*Trait) ActionList

func (t *Trait) ActionList(c *gin.Context)

ActionList 获取数据列表的主要处理方法 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息

func (*Trait) ActionSave

func (t *Trait) ActionSave(c *gin.Context)

ActionSave 保存数据的主要处理方法(自动判断创建或更新) 参数说明:

  • c *gin.Context: Gin框架的上下文对象

func (*Trait) ActionSetValue

func (t *Trait) ActionSetValue(c *gin.Context)

ActionSetValue 设置单个字段值的主要处理方法 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息

func (*Trait) ActionUpdate

func (t *Trait) ActionUpdate(c *gin.Context)

ActionUpdate 更新数据的主要处理方法 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息

func (*Trait) AllEach

func (t *Trait) AllEach(ctx *Context, item interface{}) interface{}

AllEach 对获取的每个数据项进行处理 参数说明:

  • ctx *Context: 上下文对象
  • item interface{}: 数据列表中的单个数据项

返回值:

  • interface{}: 处理后的数据项

func (*Trait) AllOrder

func (t *Trait) AllOrder(ctx *Context) interface{}

AllOrder 设置获取所有数据的排序规则 参数说明:

  • ctx *Context: 上下文对象

返回值:

  • interface{}: 排序规则,可以是字符串或其他GORM支持的排序格式

func (*Trait) AllQuery

func (t *Trait) AllQuery(ctx *Context, query *gorm.DB) *gorm.DB

AllQuery 设置获取所有数据的WHERE条件和其他查询参数 参数说明:

  • ctx *Context: 上下文对象
  • query *gorm.DB: 数据库查询对象

返回值:

  • *gorm.DB: 设置了查询条件的查询对象

func (*Trait) AllReturn

func (t *Trait) AllReturn(ctx *Context, results interface{}) bool

AllReturn 获取所有数据成功后的返回处理方法 参数说明:

  • ctx *Context: 上下文对象
  • results interface{}: 查询到的所有数据

返回值:

  • bool: 处理结果,通常返回true表示成功

func (*Trait) AllSelect added in v0.10.7

func (t *Trait) AllSelect(ctx *Context, query *gorm.DB) *gorm.DB

AllSelect 设置获取所有数据的SELECT字段 参数说明:

  • ctx *Context: 上下文对象
  • query *gorm.DB: 数据库查询对象

返回值:

  • *gorm.DB: 设置了SELECT字段的查询对象

func (*Trait) BindMapToStruct

func (t *Trait) BindMapToStruct(mapData map[string]any, modelValue interface{}) error

BindMapToStruct 将map数据绑定到struct,并处理类型转换 参数说明:

  • mapData map[string]any: 要绑定的map数据
  • modelValue interface{}: 目标struct的指针,必须是非nil的指针类型

返回值:

  • error: 绑定过程中的错误信息

func (*Trait) CreateAfter

func (t *Trait) CreateAfter(ctx *Context, tx *gorm.DB, modelValue interface{}) error

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

func (t *Trait) CreateReturn(ctx *Context, item any) bool

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

func (t *Trait) DeleteFields(ctx *Context) []string

DeleteFields 获取删除操作时需要查询的字段列表 参数说明:

  • ctx *Context: crud请求上下文对象

返回值:

  • []string: 字段名称列表,默认只包含主键字段

func (*Trait) DeleteReturn

func (t *Trait) DeleteReturn(ctx *Context, delIds []interface{}, delArr []map[string]interface{})

DeleteReturn 删除成功后的返回处理方法 参数说明:

  • ctx *Context: crud请求上下文对象
  • delIds []interface{}: 已删除的ID列表
  • delArr []map[string]interface{}: 已删除的数据记录列表

func (*Trait) Detail

func (t *Trait) Detail(ctx *Context, item interface{}) interface{}

Detail 对详情数据进行处理 参数说明:

  • ctx *Context: crud上下文对象
  • item interface{}: 查询到的详情数据

返回值:

  • interface{}: 处理后的详情数据

func (*Trait) DetailFormData added in v0.8.0

func (t *Trait) DetailFormData(ctx *Context) (map[string]any, error)

DetailFormData 获取详情查询的参数数据 参数说明:

  • ctx *Context: crud上下文对象

返回值:

  • map[string]any: 请求参数映射
  • error: 处理过程中的错误信息

func (*Trait) DetailQuery

func (t *Trait) DetailQuery(ctx *Context, query *gorm.DB, mapData map[string]any) *gorm.DB

DetailQuery 设置详情查询的WHERE条件和其他查询参数 参数说明:

  • ctx *Context: crud上下文对象
  • query *gorm.DB: 数据库查询对象
  • mapData map[string]any: 请求参数映射

返回值:

  • *gorm.DB: 设置了查询条件的查询对象

func (*Trait) DetailReturn

func (t *Trait) DetailReturn(ctx *Context, detail interface{}) bool

DetailReturn 详情查询成功后的返回处理方法 参数说明:

  • ctx *Context: crud上下文对象
  • detail interface{}: 详情数据

返回值:

  • bool: 处理结果,通常返回true表示成功

func (*Trait) DetailSelect added in v0.9.1

func (t *Trait) DetailSelect(ctx *Context, query *gorm.DB) *gorm.DB

DetailSelect 设置详情查询的SELECT字段 参数说明:

  • ctx *Context: crud上下文对象
  • query *gorm.DB: 数据库查询对象

返回值:

  • *gorm.DB: 设置了SELECT字段的查询对象

func (*Trait) ExtractPkId

func (t *Trait) ExtractPkId(ctx *Context) (pkValue uint, err error)

ExtractPkId 从不同类型的请求中提取主键ID 参数:

  • c *gin.Context: Gin框架的上下文对象

返回值:

  • pkValue uint: 提取到的主键ID值
  • err error: 提取过程中的错误信息

func (*Trait) GetDeleteWhere

func (t *Trait) GetDeleteWhere(ctx *Context, deleteQuery *gorm.DB, ids []interface{}) *gorm.DB

GetDeleteWhere 构建删除操作的WHERE条件 参数说明:

  • ctx *Context: crud请求上下文对象
  • deleteQuery *gorm.DB: 数据库查询对象
  • ids []interface{}: 要删除的ID列表

返回值:

  • *gorm.DB: 添加了WHERE条件的查询对象

func (*Trait) InitCrud added in v0.8.0

func (t *Trait) InitCrud(ginContext *gin.Context, args ...any) (ctx *Context)

InitCrud 初始化CRUD,仅当初始化完成才可以使用 参数说明:

  • c *gin.Context: Gin框架的上下文对象,包含请求和响应信息
  • args ...any: 可选的参数列表 -- actionName string: 操作名称(如: "create", "update", "delete", "detail", "list", "all", "set-value")

返回值:

  • *Context: 新创建的上下文对象

func (*Trait) ListEach

func (t *Trait) ListEach(ctx *Context, item interface{}) interface{}

ListEach 对列表中的每个数据项进行处理 参数说明:

  • ctx *Context: 上下文对象
  • item interface{}: 列表中的单个数据项

返回值:

  • interface{}: 处理后的数据项

func (*Trait) ListOrder

func (t *Trait) ListOrder(ctx *Context) (order interface{})

ListOrder 设置列表查询的排序规则 参数说明:

  • ctx *Context: 上下文对象

返回值:

  • order interface{}: 排序规则,可以是字符串或其他GORM支持的排序格式

func (*Trait) ListQuery

func (t *Trait) ListQuery(ctx *Context, query *gorm.DB) (*gorm.DB, error)

ListQuery 设置列表查询的WHERE条件和其他查询参数 参数说明:

  • ctx *Context: 上下文对象
  • query *gorm.DB: 数据库查询对象

返回值:

  • *gorm.DB: 设置了查询条件的查询对象
  • error: 处理过程中的错误信息

func (*Trait) ListReturn

func (t *Trait) ListReturn(ctx *Context, listData jcbaseGo.ListData) bool

ListReturn 列表查询成功后的返回处理方法 参数说明:

  • ctx *Context: 上下文对象
  • listData jcbaseGo.ListData: 包含列表数据和分页信息的结构体

返回值:

  • bool: 处理结果,通常返回true表示成功

func (*Trait) ListSelect

func (t *Trait) ListSelect(ctx *Context, query *gorm.DB) *gorm.DB

ListSelect 设置列表查询的SELECT字段 参数说明:

  • ctx *Context: 上下文对象
  • query *gorm.DB: 数据库查询对象

返回值:

  • *gorm.DB: 设置了SELECT字段的查询对象

func (*Trait) SaveAfter added in v0.8.0

func (t *Trait) SaveAfter(ctx *Context, tx *gorm.DB, modelValue interface{}) error

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

func (t *Trait) SetValueAfter(ctx *Context, tx *gorm.DB, modelValue interface{}) error

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

func (t *Trait) SetValueCheckField(ctx *Context, field string) error

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

func (t *Trait) SetValueReturn(ctx *Context, value interface{}, field string, id uint) bool

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

func (t *Trait) UpdateReturn(ctx *Context, item interface{}) bool

UpdateReturn 更新成功后的返回处理方法 参数说明:

  • ctx *Context: crud上下文对象
  • item interface{}: 更新成功的数据项

返回值:

  • bool: 处理结果,通常返回true表示成功

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL