前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >聊聊gorm的DeletedAt

聊聊gorm的DeletedAt

作者头像
code4it
发布2021-01-25 10:45:24
7110
发布2021-01-25 10:45:24
举报
文章被收录于专栏:码匠的流水账码匠的流水账

本文主要研究一下gorm的DeletedAt

DeletedAt

gorm.io/gorm@v1.20.10/soft_delete.go

代码语言:javascript
复制
type DeletedAt sql.NullTime

// Scan implements the Scanner interface.
func (n *DeletedAt) Scan(value interface{}) error {
    return (*sql.NullTime)(n).Scan(value)
}

// Value implements the driver Valuer interface.
func (n DeletedAt) Value() (driver.Value, error) {
    if !n.Valid {
        return nil, nil
    }
    return n.Time, nil
}

func (n DeletedAt) MarshalJSON() ([]byte, error) {
    if n.Valid {
        return json.Marshal(n.Time)
    }
    return json.Marshal(nil)
}

func (n *DeletedAt) UnmarshalJSON(b []byte) error {
    if string(b) == "null" {
        n.Valid = false
        return nil
    }
    err := json.Unmarshal(b, &n.Time)
    if err == nil {
        n.Valid = true
    }
    return err
}

func (DeletedAt) QueryClauses(f *schema.Field) []clause.Interface {
    return []clause.Interface{SoftDeleteQueryClause{Field: f}}
}

func (DeletedAt) DeleteClauses(f *schema.Field) []clause.Interface {
    return []clause.Interface{SoftDeleteDeleteClause{Field: f}}
}

DeletedAt为sql.NullTime类型,它实现了Scanner接口的Scan方法,实现了Valuer接口的Value方法;同时定义了MarshalJSON、UnmarshalJSON方法,还定义了QueryClauses方法,使用的是SoftDeleteQueryClause;DeleteClauses方法使用的是SoftDeleteDeleteClause

SoftDeleteQueryClause

gorm.io/gorm@v1.20.10/soft_delete.go

代码语言:javascript
复制
type SoftDeleteQueryClause struct {
    Field *schema.Field
}

func (sd SoftDeleteQueryClause) Name() string {
    return ""
}

func (sd SoftDeleteQueryClause) Build(clause.Builder) {
}

func (sd SoftDeleteQueryClause) MergeClause(*clause.Clause) {
}

func (sd SoftDeleteQueryClause) ModifyStatement(stmt *Statement) {
    if _, ok := stmt.Clauses["soft_delete_enabled"]; !ok {
        if c, ok := stmt.Clauses["WHERE"]; ok {
            if where, ok := c.Expression.(clause.Where); ok && len(where.Exprs) > 1 {
                for _, expr := range where.Exprs {
                    if orCond, ok := expr.(clause.OrConditions); ok && len(orCond.Exprs) == 1 {
                        where.Exprs = []clause.Expression{clause.And(where.Exprs...)}
                        c.Expression = where
                        stmt.Clauses["WHERE"] = c
                        break
                    }
                }
            }
        }

        stmt.AddClause(clause.Where{Exprs: []clause.Expression{
            clause.Eq{Column: clause.Column{Table: clause.CurrentTable, Name: sd.Field.DBName}, Value: nil},
        }})
        stmt.Clauses["soft_delete_enabled"] = clause.Clause{}
    }
}

SoftDeleteQueryClause的ModifyStatement方法会追加DeletedAt为nil的查询条件

SoftDeleteDeleteClause

gorm.io/gorm@v1.20.10/soft_delete.go

代码语言:javascript
复制
type SoftDeleteDeleteClause struct {
    Field *schema.Field
}

func (sd SoftDeleteDeleteClause) Name() string {
    return ""
}

func (sd SoftDeleteDeleteClause) Build(clause.Builder) {
}

func (sd SoftDeleteDeleteClause) MergeClause(*clause.Clause) {
}

func (sd SoftDeleteDeleteClause) ModifyStatement(stmt *Statement) {
    if stmt.SQL.String() == "" {
        curTime := stmt.DB.NowFunc()
        stmt.AddClause(clause.Set{{Column: clause.Column{Name: sd.Field.DBName}, Value: curTime}})
        stmt.SetColumn(sd.Field.DBName, curTime, true)

        if stmt.Schema != nil {
            _, queryValues := schema.GetIdentityFieldValuesMap(stmt.ReflectValue, stmt.Schema.PrimaryFields)
            column, values := schema.ToQueryValues(stmt.Table, stmt.Schema.PrimaryFieldDBNames, queryValues)

            if len(values) > 0 {
                stmt.AddClause(clause.Where{Exprs: []clause.Expression{clause.IN{Column: column, Values: values}}})
            }

            if stmt.ReflectValue.CanAddr() && stmt.Dest != stmt.Model && stmt.Model != nil {
                _, queryValues = schema.GetIdentityFieldValuesMap(reflect.ValueOf(stmt.Model), stmt.Schema.PrimaryFields)
                column, values = schema.ToQueryValues(stmt.Table, stmt.Schema.PrimaryFieldDBNames, queryValues)

                if len(values) > 0 {
                    stmt.AddClause(clause.Where{Exprs: []clause.Expression{clause.IN{Column: column, Values: values}}})
                }
            }
        }

        if _, ok := stmt.Clauses["WHERE"]; !stmt.DB.AllowGlobalUpdate && !ok {
            stmt.DB.AddError(ErrMissingWhereClause)
        } else {
            SoftDeleteQueryClause{Field: sd.Field}.ModifyStatement(stmt)
        }

        stmt.AddClauseIfNotExists(clause.Update{})
        stmt.Build("UPDATE", "SET", "WHERE")
    }
}

SoftDeleteDeleteClause的ModifyStatement方法会设置DeletedAt为当前时间

interfaces

gorm.io/gorm@v1.20.10/schema/interfaces.go

代码语言:javascript
复制
type GormDataTypeInterface interface {
    GormDataType() string
}

type CreateClausesInterface interface {
    CreateClauses(*Field) []clause.Interface
}

type QueryClausesInterface interface {
    QueryClauses(*Field) []clause.Interface
}

type UpdateClausesInterface interface {
    UpdateClauses(*Field) []clause.Interface
}

type DeleteClausesInterface interface {
    DeleteClauses(*Field) []clause.Interface
}
代码语言:javascript
复制
    

interfaces包定义了QueryClausesInterface、DeleteClausesInterface接口;schema的Parse方法会回调这些interface的对应方法

小结

gorm的DeletedAt为sql.NullTime类型,它定义了QueryClauses方法,使用的是SoftDeleteQueryClause,它的ModifyStatement方法会追加DeletedAt为nil的查询条件;DeleteClauses方法使用的是SoftDeleteDeleteClause,它的ModifyStatement方法会设置DeletedAt为当前时间。

doc

  • gorm
本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2021-01-09,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 码匠的流水账 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • DeletedAt
  • SoftDeleteQueryClause
  • SoftDeleteDeleteClause
  • interfaces
  • 小结
  • doc
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档