entity

Documentation

Index

• Constants
• func CheckFieldCreateUserID(entity Entity) error
• func CheckFieldCreateUserIDResult(checkResult check.Result) error
• func CheckFieldID(entity Entity) error
• func CheckFieldIDResult(checkResult check.Result) error
• func CheckFieldLastUpdateUserID(entity Entity) error
• func CheckFieldLastUpdateUserIDResult(checkResult check.Result) error
• func CheckFieldTenantID(entity Entity) error
• func CheckFieldTenantIDResult(checkResult check.Result) error
• func CheckIDTypeValue(domainCNName string, fieldCNName string, id string) error
• type Base
  • func (e *Base) DBSchema() string
  • func (e *Base) GenerateID() error
  • func (e *Base) GetID() string
• type Entity
• type TenantIDField
• type TimeFields
• type UserIDFields

Constants

const (
	// FieldID ID字段名
	FieldID = "ID"

	// FieldTenantID 租户ID字段名
	FieldTenantID = "TenantID"

	// FieldCreateUserID 创建用户ID字段名
	FieldCreateUserID = "CreateUserID"

	// FieldLastUpdateUserID 最近更新用户ID字段名
	FieldLastUpdateUserID = "LastUpdateUserID"

	// FieldCreatedTime 创建时间字段名
	FieldCreatedTime = "CreatedTime"

	// FieldLastUpdatedTime 最近更新时间字段名
	FieldLastUpdatedTime = "LastUpdatedTime"
)

const (
	// ColumnID ID列名
	ColumnID = "id"

	// ColumnTenantID 租户ID列名
	ColumnTenantID = "tenant_id"

	// ColumnCreateUserID 创建用户ID列名
	ColumnCreateUserID = "create_user_id"

	// ColumnLastUpdateUserID 最新更新用户ID列名
	ColumnLastUpdateUserID = "last_update_user_id"

	// ColumnCreatedTime 创建时间列名
	ColumnCreatedTime = "created_time"

	// ColumnLastUpdatedTime 最近更新时间列名
	ColumnLastUpdatedTime = "last_updated_time"
)

Functions

func CheckFieldCreateUserID

func CheckFieldCreateUserID(entity Entity) error

CheckFieldCreateUserID 校验领域实体的创建用户ID字段是否合规 参数: - entity: 领域实体 返回值: - 错误

func CheckFieldCreateUserIDResult

func CheckFieldCreateUserIDResult(checkResult check.Result) error

CheckFieldCreateUserIDResult 利用check.Struct函数返回的结果校验领域实体的创建用户ID字段是否合规 参数: - checkResult: check.Struct函数返回的结果 返回值: - 错误

func CheckFieldID

func CheckFieldID(entity Entity) error

CheckFieldID 校验领域实体的ID字段是否合规 参数: - entity: 领域实体 返回值: - 错误

func CheckFieldIDResult

func CheckFieldIDResult(checkResult check.Result) error

CheckFieldIDResult 利用check.Struct函数返回的结果校验领域实体的ID字段是否合规 参数: - checkResult: check.Struct函数返回的结果 返回值: - 错误

func CheckFieldLastUpdateUserID

func CheckFieldLastUpdateUserID(entity Entity) error

CheckFieldLastUpdateUserID 校验领域实体的最近更新用户ID字段是否合规 参数: - entity: 领域实体 返回值: - 错误

func CheckFieldLastUpdateUserIDResult

func CheckFieldLastUpdateUserIDResult(checkResult check.Result) error

CheckFieldLastUpdateUserIDResult 利用check.Struct函数返回的结果校验领域实体的最近更新用户ID字段是否合规 参数: - checkResult: check.Struct函数返回的结果 返回值: - 错误

func CheckFieldTenantID

func CheckFieldTenantID(entity Entity) error

CheckFieldTenantID 校验领域实体的租户ID字段是否合规 参数: - entity: 领域实体 返回值: - 错误

func CheckFieldTenantIDResult

func CheckFieldTenantIDResult(checkResult check.Result) error

CheckFieldTenantIDResult 利用check.Struct函数返回的结果校验领域实体的租户ID字段是否合规 参数: - checkResult: check.Struct函数返回的结果 返回值: - 错误

func CheckIDTypeValue

func CheckIDTypeValue(domainCNName string, fieldCNName string, id string) error

CheckIDTypeValue 校验ID类型的字段，如ID，租户ID，用户ID等，特点是字符串类型，不能为空且长度严格为32字节 参数: - domainCNName: 领域中文名，可以使用DomainCNName()方法获得 - fieldCNName: 字段的中文名称(用于构造报错信息) - id: id字段的值 返回值: - 错误

Types

type Base

type Base struct {
	ID string `sqlmapping:"column:id;key;" sqlresult:"column:id;" check:"required,len=32"`
}

func (*Base) DBSchema

func (e *Base) DBSchema() string

func (*Base) GenerateID

func (e *Base) GenerateID() error

func (*Base) GetID

func (e *Base) GetID() string

type Entity

type Entity interface {
	domain.Object

	// GenerateID 生成ID
	GenerateID() error

	// GetID 获取ID
	GetID() string

	// ForCreate 创建准备方法(规则校验)
	ForCreate() error

	// ForDelete 删除准备方法(规则校验)
	ForDelete() error

	// ForUpdate 更新准备方法(规则校验)
	ForUpdate() error
}

Entity 领域实体接口

type TenantIDField

type TenantIDField struct {
	TenantID string `sqlmapping:"column:tenant_id;" sqlresult:"column:tenant_id;" check:"required,len=32"`
}

TenantIDField 租户ID字段

type TimeFields

type TimeFields struct {
	CreatedTime     time.Time `sqlmapping:"column:created_time;" sqlresult:"column:created_time;"`
	LastUpdatedTime time.Time `sqlmapping:"column:last_updated_time;" sqlresult:"column:last_updated_time;"`
}

TimeFields 时间相关字段

type UserIDFields

type UserIDFields struct {
	CreateUserID     string `sqlmapping:"column:create_user_id;" sqlresult:"column:create_user_id;" check:"required,len=32"`
	LastUpdateUserID string `sqlmapping:"column:last_update_user_id;" sqlresult:"column:last_update_user_id;" check:"required,len=32"`
}

UserIDFields 用户ID相关字段