mayfly-go/server/pkg/model/model.go

package model

import (
	"database/sql/driver"
	"encoding/json"
	"time"

	"github.com/may-fly/cast"
)

type IdGenType int

const (
	IdColumn         = "id"
	DeletedColumn    = "is_deleted" // 删除字段
	DeleteTimeColumn = "delete_time"
	ModifierColumn   = "modifier"
	ModifierIdColumn = "modifier_id"
	UpdateTimeColumn = "update_time"

	ModelDeleted   int8 = 1
	ModelUndeleted int8 = 0

	IdGenTypeNone      IdGenType = 0 // 数据库处理
	IdGenTypeTimestamp IdGenType = 1 // 当前时间戳
)

// 实体接口
type ModelI interface {
	// SetId 设置id
	SetId(id uint64)

	// IsCreate 是否为新建该实体模型, 默认 id == 0 为新建
	IsCreate() bool

	// FillBaseInfo 使用当前登录账号信息赋值实体结构体的基础信息
	//
	// 如创建时间，修改时间，创建者，修改者信息等
	FillBaseInfo(idGenType IdGenType, account *LoginAccount)

	// LogicDelete 是否为逻辑删除
	LogicDelete() bool
}

type IdModel struct {
	Id uint64 `json:"id" gorm:"primarykey;AUTO_INCREMENT"`
}

func (m *IdModel) SetId(id uint64) {
	m.Id = id
}

func (m *IdModel) IsCreate() bool {
	return m.Id == 0
}

func (m *IdModel) FillBaseInfo(idGenType IdGenType, account *LoginAccount) {
	// 存在id，则赋值
	if !m.IsCreate() {
		return
	}
	m.SetId(GetIdByGenType(idGenType))
}

func (m *IdModel) LogicDelete() bool {
	return false
}

// 含有删除字段模型
type DeletedModel struct {
	IdModel
	IsDeleted  int8       `json:"-" gorm:"column:is_deleted;not null;default:0;"`
	DeleteTime *time.Time `json:"-"`
}

func (m *DeletedModel) FillBaseInfo(idGenType IdGenType, account *LoginAccount) {
	if m.Id == 0 {
		m.IdModel.FillBaseInfo(idGenType, account)
		m.IsDeleted = ModelUndeleted
	}
}

func (m *DeletedModel) LogicDelete() bool {
	return true
}

// CreateModelNLD 含有创建等信息，但不包含逻辑删除信息
type CreateModelNLD struct {
	IdModel
	CreateTime *time.Time `json:"createTime" gorm:"not null;"`
	CreatorId  uint64     `json:"creatorId" gorm:"not null;"`
	Creator    string     `json:"creator" gorm:"size:32;not null;"`
}

func (m *CreateModelNLD) FillBaseInfo(idGenType IdGenType, account *LoginAccount) {
	if !m.IsCreate() {
		return
	}

	m.IdModel.FillBaseInfo(idGenType, account)
	nowTime := time.Now()
	m.CreateTime = &nowTime
	if account != nil {
		m.CreatorId = account.Id
		m.Creator = account.Username
	}
}

// 含有删除、创建字段模型
type CreateModel struct {
	DeletedModel
	CreateTime *time.Time `json:"createTime" gorm:"not null;"`
	CreatorId  uint64     `json:"creatorId" gorm:"not null;"`
	Creator    string     `json:"creator" gorm:"size:32;not null;"`
}

func (m *CreateModel) FillBaseInfo(idGenType IdGenType, account *LoginAccount) {
	if !m.IsCreate() {
		return
	}

	m.DeletedModel.FillBaseInfo(idGenType, account)
	nowTime := time.Now()
	m.CreateTime = &nowTime
	if account != nil {
		m.CreatorId = account.Id
		m.Creator = account.Username
	}
}

// 基础实体模型，数据表最基础字段，不包含逻辑删除
type ModelNLD struct {
	CreateModelNLD

	UpdateTime *time.Time `json:"updateTime" gorm:"not null;"`
	ModifierId uint64     `json:"modifierId" gorm:"not null;"`
	Modifier   string     `json:"modifier" gorm:"size:32;not null;"`
}

// 设置基础信息. 如创建时间，修改时间，创建者，修改者信息
func (m *ModelNLD) FillBaseInfo(idGenType IdGenType, account *LoginAccount) {
	nowTime := time.Now()
	isCreate := m.IsCreate()
	if isCreate {
		m.CreateTime = &nowTime
		m.IdModel.FillBaseInfo(idGenType, account)
	}
	m.UpdateTime = &nowTime

	if account == nil {
		return
	}
	id := account.Id
	name := account.Username
	if isCreate {
		m.CreatorId = id
		m.Creator = name
	}
	m.Modifier = name
	m.ModifierId = id
}

// 基础实体模型，数据表最基础字段，尽量每张表都包含这些字段
type Model struct {
	CreateModel

	UpdateTime *time.Time `json:"updateTime" gorm:"not null;"`
	ModifierId uint64     `json:"modifierId" gorm:"not null;"`
	Modifier   string     `json:"modifier" gorm:"size:32;not null;"`
}

// 设置基础信息. 如创建时间，修改时间，创建者，修改者信息
func (m *Model) FillBaseInfo(idGenType IdGenType, account *LoginAccount) {
	nowTime := time.Now()
	isCreate := m.IsCreate()
	if isCreate {
		m.IsDeleted = ModelUndeleted
		m.CreateTime = &nowTime
		m.IdModel.FillBaseInfo(idGenType, account)
	}
	m.UpdateTime = &nowTime

	if account == nil {
		return
	}
	id := account.Id
	name := account.Username
	if isCreate {
		m.CreatorId = id
		m.Creator = name
	}
	m.Modifier = name
	m.ModifierId = id
}

// 根据id生成类型，生成id
func GetIdByGenType(genType IdGenType) uint64 {
	if genType == IdGenTypeTimestamp {
		return uint64(time.Now().Unix())
	}
	return 0
}

type Map[K comparable, V any] map[K]V

func (m *Map[K, V]) Scan(value any) error {
	return json.Unmarshal(value.([]byte), m)
}

func (m Map[K, V]) Value() (driver.Value, error) {
	return json.Marshal(m)
}

type Slice[T int | string | Map[string, any]] []T

func (s *Slice[T]) Scan(value any) error {
	return json.Unmarshal(value.([]byte), s)
}

func (s Slice[T]) Value() (driver.Value, error) {
	return json.Marshal(s)
}

// 带有额外其他信息字段的结构体
type ExtraData struct {
	Extra Map[string, any] `json:"extra" gorm:"type:varchar(1000)"`
}

// SetExtraValue 设置额外信息字段值
func (m *ExtraData) SetExtraValue(key string, val any) {
	if m.Extra != nil {
		m.Extra[key] = val
	} else {
		m.Extra = Map[string, any]{key: val}
	}
}

// GetExtraString 获取额外信息中的string类型字段值
func (e ExtraData) GetExtraString(key string) string {
	if e.Extra == nil {
		return ""
	}
	return cast.ToString(e.Extra[key])
}