crud

package
v0.9.1 Latest Latest
Warning

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

Go to latest
Published: May 19, 2025 License: MIT Imports: 12 Imported by: 0

README

使用示例

控制器

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
}

router

systemGroup := r.Group("/system")
systemGroup.Use(middleware.LoginRequired())
{
    systemUserGroup := systemGroup.Group("/user")
    {
		// 直接调用crud中的方法即可
        systemUser := systemUserController.New()
        systemUserGroup.GET("/list", systemUser.ActionList)
    }
}

Documentation

Index

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{}  // 控制器

	// ----- 初始化时生成 ----- /
	ModelTableName string   // 模型表名
	ModelFields    []string // 模型所有字段
	OperateTime    string   // 操作时间
	TableAlias     string   // 表别名(仅用于拼接查询语句,配置别名请用ModelTableAlias)

	// ----- 非基础配置 ----- /
	BaseControllerTrait controller.Base
}

func (*Trait) ActionAll

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

func (*Trait) ActionCreate

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

func (*Trait) ActionDelete

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

func (*Trait) ActionDetail

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

func (*Trait) ActionList

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

func (*Trait) ActionSave

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

func (*Trait) ActionSetValue

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

func (*Trait) ActionUpdate

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

func (*Trait) AllEach

func (t *Trait) AllEach(item interface{}) interface{}

func (*Trait) AllOrder

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

func (*Trait) AllQuery

func (t *Trait) AllQuery(query *gorm.DB) *gorm.DB

func (*Trait) AllReturn

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

func (*Trait) BindMapToStruct

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

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

func (*Trait) CreateAfter

func (t *Trait) 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)

func (*Trait) CreateFormData

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

func (*Trait) CreateReturn

func (t *Trait) CreateReturn(item any) bool

func (*Trait) DeleteAfter

func (t *Trait) DeleteAfter(delIds []interface{}, delArr []map[string]interface{}) error

func (*Trait) DeleteBefore

func (t *Trait) DeleteBefore(delArr []map[string]interface{}, delIds []interface{}) ([]interface{}, error)

func (*Trait) DeleteCondition

func (t *Trait) DeleteCondition(delArr []map[string]interface{}) map[string]interface{}

func (*Trait) DeleteFields

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

func (*Trait) DeleteReturn

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

func (*Trait) Detail

func (t *Trait) Detail(item interface{}) interface{}

func (*Trait) DetailFormData added in v0.8.0

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

func (*Trait) DetailQuery

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

func (*Trait) DetailReturn

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

func (*Trait) DetailSelect added in v0.9.1

func (t *Trait) DetailSelect(query *gorm.DB) *gorm.DB

func (*Trait) ExtractPkId

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

ExtractPkId 方法从不同类型的请求中提取 PkId

func (*Trait) Failure

func (t *Trait) Failure(args ...any)

Failure 返回失败的响应 这个方法用于简化失败响应的构建,接收可变参数 并根据参数数量确定响应的data、message、code字段的值。 参数:

  • message string: 返回的消息内容
  • data any: 返回的数据
  • code int: 错误码

仅1个参数时,如果是字符串则作为message输出,否则作为data输出; 更多参数时,第一个参数为message,第二个参数为data,第三个参数为code;

func (*Trait) GetDeleteWhere

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

func (*Trait) GetSafeMapGPC

func (t *Trait) GetSafeMapGPC(key ...string) (mapData map[string]any)

GetSafeMapGPC 安全获取map类型GPC

func (*Trait) InitCrud added in v0.8.0

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

InitCrud 初始化crud,仅当初始化完成才可以使用

func (*Trait) ListEach

func (t *Trait) ListEach(item interface{}) interface{}

func (*Trait) ListOrder

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

func (*Trait) ListQuery

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

func (*Trait) ListReturn

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

func (*Trait) ListSelect

func (t *Trait) ListSelect(query *gorm.DB) *gorm.DB

func (*Trait) Result

func (t *Trait) Result(code int, msg string, args ...any)

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

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

SaveAfter 保存后

func (*Trait) SaveBefore

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

SaveBefore 保存前

func (*Trait) SaveFormData

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

SaveFormData 获取表单数据

func (*Trait) SetValueAfter

func (t *Trait) SetValueAfter(tx *gorm.DB, id uint, field string, value any) error

func (*Trait) SetValueBefore

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

func (*Trait) SetValueCheckField

func (t *Trait) SetValueCheckField(field string) error

SetValueCheckField 验证传入的字段名是否有效

func (*Trait) SetValueFormData

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

func (*Trait) SetValueReturn

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

func (*Trait) Success

func (t *Trait) Success(args ...any)

Success 返回成功的响应 这个方法用于简化成功响应的构建,接收可变参数, 并根据参数数量确定响应的data、additionalParams和message字段的值。 参数:

  • message string: 返回的消息内容
  • data any: 返回的数据
  • additionalParams any: 附加数据

仅1个参数时,如果是字符串则作为message输出,否则作为data输出; 更多参数时,第一个参数为data,第二个参数为message,第三个参数为additionalParams;

func (*Trait) UpdateAfter

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

func (*Trait) UpdateBefore

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

func (*Trait) UpdateFormData

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

func (*Trait) UpdateReturn

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

Jump to

Keyboard shortcuts

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