Core + Vue 后台管理基础框架5——系统审计

Posted 2021-03-04 guokun

1、前言

　　通常而言，系统审计是指记录谁，什么时间，干了什么事儿，具体到本项目中，着重两个方面：一是记录重点业务记录的创建人、创建时间、修改人、修改时间；二是记录重点操作的流水记录，如谁什么时间新增了个什么订单。本篇讲上半部分，既重点业务对象记录的创建人、创建时间，修改人、修改时间，或者准确讲是最后修改人、最后修改时间。

　　见过也维护过不少系统，这类审计字段，直接跟业务字段赋值或业务逻辑融合在一起，遍布系统各个角落，繁琐是其一，更严重的是如果哪个地方忘记了，那才是大事儿。总之就是，很没技术含量，或者不“政治正确”。那接下来我们就看看怎么样“政治正确”的去实现审计。

2、实现

　　首先，调整DBContext，让审计字段的赋值去横切的处理：

public class SystemManageDbContext : DbContext
    {
        private readonly CurrentUser _currentUser;

        public SystemManageDbContext([NotNullAttribute] DbContextOptions options, CurrentUser currentUser) 
            : base(options)
        {
            _currentUser = currentUser;
        }

        public override Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
        {
            this.SetAuditFields();
            return base.SaveChangesAsync(cancellationToken);
        }

        public override int SaveChanges()
        {
            this.SetAuditFields();
            return base.SaveChanges();
        }

        private void SetAuditFields()
        {
            var auditableEntities = ChangeTracker.Entries<IAuditable>()
                    .Where(x => (x.State == EntityState.Added || x.State == EntityState.Modified));
            if (auditableEntities != null && auditableEntities.Any())
            {
                foreach (var entry in auditableEntities)
                {
                    var entity = entry.Entity as IAuditable;
                    if (entry.State == EntityState.Added)
                    {
                        entity.CreateBy = _currentUser.ID;
                        entity.CreateTime = DateTime.Now;
                    }
                    else
                    {
                        entity.ModifyBy = _currentUser.ID;
                        entity.ModifyTime = DateTime.Now;
                    }
                }
            }
        }

　　基本思路很简单，重写EF DBContext的保存方法，判断是否有新增、修改的对象，并给对应字段赋值。构造函数中需要注入当前用户，方便赋值给操作人审计字段赋值。

　　然后，调整DBContext的注入：

//services.AddDbContextPool<SystemManageDbContext>(options =>
            //    {
            //        options.UseLoggerFactory(LoggerFactory.Create(builder => builder.AddConsole().AddDebug()))
            //        .Usemysql(Configuration.GetConnectionString("Default"), mySqlOptions =>
            //            mySqlOptions.ServerVersion(new ServerVersion(new Version(8, 0, 18), ServerType.MySql)));
            //    }
            //);
            services.AddDbContext<SystemManageDbContext>(options =>
                options.UseLoggerFactory(LoggerFactory.Create(builder => builder.AddConsole().AddDebug()))
                .UseMySql(Configuration.GetConnectionString("Default"), mySqlOptions =>
                    mySqlOptions.ServerVersion(new ServerVersion(new Version(8, 0, 18), ServerType.MySql)))
            );

　　主要是连接池形式注入改为普通注入，因为链接池注入时，DBContext提供容器跟我们普通业务对象的容器不是同一个，会直接导致DBContext中CurrentUser注入失败抛出异常。

　　实现上述两步后，便无需在业务方法中各种审计字段赋值满天飞了。