在FreeSQL中实现「触发器」和软删除功能

freesql,实现,触发器,删除,功能 · 浏览次数 : 569

小编点评

## FreeSQL AOP 中的触发器功能实现这篇文章介绍了在 FreeSQL 中实现实体修改时间记录的步骤以及一些配置选项。 **基本概念:** * FreeSQL 提供 AOP 功能，可以统一处理插入/更新时统一处理一些值，比如创建时间、修改时间、业务值等。 * 触发器是实现 AOP 功能的关键，它允许在实体修改时记录更新时间。 * 在实体修改时，可以使用 FreeSQL 的 `Aop.AuditValue` 属性来实现记录更新时间的功能。 **实现步骤:** 1. **配置 FreeSQL 实体类型:** 在创建 FreeSQL 实例时，配置 `FreeSql.GlobalFilter.Apply` 方法以筛选 `ISoftDelete` 接口的实体。 2. **实现 `Aop.AuditValue` 属性:** 在实体属性中设置 `CreatedTime` 和 `ModifiedTime` 字段，并将 `ModifiedTime` 设置为当前修改时间。 3. **记录修改时间:** 在实体修改事件监听器中，使用 `FreeSql.Aop.AuditValue` 属性记录修改时间。 4. **软删除设计:** 在软删除情况下，使用 `FreeSql.GlobalFilter.Apply` 筛选实体，并将 `IsDeleted` 字段设置为 `true`。这确保删除时不会执行真正删除操作，而只记录更新操作。 **示例代码:** ```csharp // 接口 public interface ISoftDelete { bool IsDeleted { get; set; } } // 模型基类 public abstract class ModelBase : ISoftDelete { public DateTime CreatedTime { get; set; } = DateTime.Now; public DateTime ModifiedTime { get; set; } = DateTime.Now; public bool IsDeleted { get; set; } = false; } // FreeSQL 实例配置 var freeSql = new FreeSql(); freeSql.GlobalFilter.Apply(entityType => entityType as ModelBase); ``` **参考资料:** * FreeSQL 文档 - AOP - https://freesql.net/guide/aop.html * FreeSQL 文档 - 过滤器 - https://freesql.net/guide/filters.html

正文

前言

最近做新项目，技术栈 AspNetCore + FreeSQL

这个ORM真的好用，文档也很完善，这里记录一下两个有关「触发器」的功能实现

修改实体时记录更新时间

模型代码

我的模型都是基于这个 ModelBase 派生的，自带三个属性字段

public abstract class ModelBase : ISoftDelete {
    public DateTime CreatedTime { get; set; } = DateTime.Now;
    public DateTime ModifiedTime { get; set; } = DateTime.Now;
    public bool IsDeleted { get; set; } = false;
}

现在要实现修改每个实体的时候自动更新 ModifiedTime 字段

可以使用 FreeSQL 提供的 AOP 里的「审计属性值」功能

按照官方的介绍：该功能可以实现插入/更新时统一处理某些值，比如某属性的雪花算法值、创建时间值、甚至是业务值。

创建FreeSQL实例的时候配置一下

检查实体类型，如果是 ModelBase 类型的话，那么把 ModifiedTime 字段设置为当前修改的时间

// 实体变化事件监听
freeSql.Aop.AuditValue += (sender, args) => {
    if (args.Object is ModelBase modelBase) {
        modelBase.ModifiedTime = DateTime.Now;
    }
};

除此之外，还有一个功能是监控实体修改的，我一开始用的这个，但是发现它是在实体已经修改保存完才执行，无法实现记录更新时间的功能。不过这个用来审计是比较有用的，记录一下~

fsql.Aop.CurdAfter += (s, e) => {
    Console.WriteLine($"ManagedThreadId:{Thread.CurrentThread.ManagedThreadId};"+
    $" FullName:{e.EntityType.FullName} ElapsedMilliseconds:{e.ElapsedMilliseconds}ms, {e.Sql}");
};

实现软删除

现在的设计为了提高容错性都是做软删除，这样误删之后还能恢复数据。

我之前封装的 DjangoStarter 框架是自己实现了软删除（通过重写 DjangoORM 的 objects 管理器实现）

来到 FreeSQL 这里，根据官方文档，可以直接使用过滤器功能实现软删除。

先定义一个接口

public interface ISoftDelete {
    bool IsDeleted { get; set; }
}

其实用我上面的 ModelBase 也行

不过我看官方文档这么用了，也就跟着写~ （接口的泛用性更高，可能有些实体是不需要创建时间和修改时间字段的）

然后在创建FreeSQL实例的时候配置一下

freeSql.GlobalFilter.Apply<ISoftDelete>("IsDeleted", a => a.IsDeleted == false);

这样读取数据的时候，IsDeleted 字段为 true 的项目就自动过滤掉了

删除的时候不要直接执行 repo.Delete ，而是把 IsDeleted 字段设置为 true

当然也可以像上面的 AOP 一样，把所有删除操作拦截下来。

参考资料

FreeSQL文档 - AOP - https://freesql.net/guide/aop.html
FreeSQL文档 - 过滤器 - https://freesql.net/guide/filters.html