refactor: ai+人工重构优化 framework

Yi.Abp.Net8/framework/Yi.Framework.SqlSugarCore/DefaultSqlSugarDbContext.cs

@@ -18,218 +18,233 @@ using Yi.Framework.SqlSugarCore.Abstractions;
 
 namespace Yi.Framework.SqlSugarCore;
 
+/// <summary>
+/// 默认SqlSugar数据库上下文实现
+/// </summary>
 public class DefaultSqlSugarDbContext : SqlSugarDbContext
 {
-    protected DbConnOptions Options => LazyServiceProvider.LazyGetRequiredService<IOptions<DbConnOptions>>().Value;
-    protected ICurrentUser CurrentUser => LazyServiceProvider.GetRequiredService<ICurrentUser>();
-    protected IGuidGenerator GuidGenerator => LazyServiceProvider.LazyGetRequiredService<IGuidGenerator>();
-    protected ILoggerFactory Logger => LazyServiceProvider.LazyGetRequiredService<ILoggerFactory>();
-    protected ICurrentTenant CurrentTenant => LazyServiceProvider.LazyGetRequiredService<ICurrentTenant>();
-    protected IDataFilter DataFilter => LazyServiceProvider.LazyGetRequiredService<IDataFilter>();
-    public IUnitOfWorkManager UnitOfWorkManager => LazyServiceProvider.LazyGetRequiredService<IUnitOfWorkManager>();
-    protected virtual bool IsMultiTenantFilterEnabled => DataFilter?.IsEnabled<IMultiTenant>() ?? false;
-    protected virtual bool IsSoftDeleteFilterEnabled => DataFilter?.IsEnabled<ISoftDelete>() ?? false;
+    #region Protected Properties
 
-    protected IEntityChangeEventHelper EntityChangeEventHelper =>
+    /// <summary>
+    /// 数据库连接配置选项
+    /// </summary>
+    protected DbConnOptions DbOptions => LazyServiceProvider.LazyGetRequiredService<IOptions<DbConnOptions>>().Value;
+
+    /// <summary>
+    /// 当前用户服务
+    /// </summary>
+    protected ICurrentUser CurrentUserService => LazyServiceProvider.GetRequiredService<ICurrentUser>();
+
+    /// <summary>
+    /// GUID生成器
+    /// </summary>
+    protected IGuidGenerator GuidGeneratorService => LazyServiceProvider.LazyGetRequiredService<IGuidGenerator>();
+
+    /// <summary>
+    /// 日志工厂
+    /// </summary>
+    protected ILoggerFactory LoggerFactory => LazyServiceProvider.LazyGetRequiredService<ILoggerFactory>();
+
+    /// <summary>
+    /// 当前租户服务
+    /// </summary>
+    protected ICurrentTenant CurrentTenantService => LazyServiceProvider.LazyGetRequiredService<ICurrentTenant>();
+
+    /// <summary>
+    /// 数据过滤服务
+    /// </summary>
+    protected IDataFilter DataFilterService => LazyServiceProvider.LazyGetRequiredService<IDataFilter>();
+
+    /// <summary>
+    /// 工作单元管理器
+    /// </summary>
+    protected IUnitOfWorkManager UnitOfWorkManagerService => LazyServiceProvider.LazyGetRequiredService<IUnitOfWorkManager>();
+
+    /// <summary>
+    /// 实体变更事件帮助类
+    /// </summary>
+    protected IEntityChangeEventHelper EntityChangeEventHelperService =>
         LazyServiceProvider.LazyGetService<IEntityChangeEventHelper>(NullEntityChangeEventHelper.Instance);
 
-    public DefaultSqlSugarDbContext(IAbpLazyServiceProvider lazyServiceProvider) : base(lazyServiceProvider)
+    /// <summary>
+    /// 是否启用多租户过滤
+    /// </summary>
+    protected virtual bool IsMultiTenantFilterEnabled => DataFilterService?.IsEnabled<IMultiTenant>() ?? false;
+
+    /// <summary>
+    /// 是否启用软删除过滤
+    /// </summary>
+    protected virtual bool IsSoftDeleteFilterEnabled => DataFilterService?.IsEnabled<ISoftDelete>() ?? false;
+
+    #endregion
+
+    /// <summary>
+    /// 构造函数
+    /// </summary>
+    public DefaultSqlSugarDbContext(IAbpLazyServiceProvider lazyServiceProvider) 
+        : base(lazyServiceProvider)
     {
     }
 
+    /// <summary>
+    /// 自定义数据过滤器
+    /// </summary>
     protected override void CustomDataFilter(ISqlSugarClient sqlSugarClient)
     {
+        // 配置软删除过滤器
         if (IsSoftDeleteFilterEnabled)
         {
-            sqlSugarClient.QueryFilter.AddTableFilter<ISoftDelete>(u => u.IsDeleted == false);
+            sqlSugarClient.QueryFilter.AddTableFilter<ISoftDelete>(entity => !entity.IsDeleted);
         }
 
+        // 配置多租户过滤器
         if (IsMultiTenantFilterEnabled)
         {
-            //表达式里只能有具体值，不能运算
-            var expressionCurrentTenant = CurrentTenant.Id ?? null;
-            sqlSugarClient.QueryFilter.AddTableFilter<IMultiTenant>(u => u.TenantId == expressionCurrentTenant);
+            var currentTenantId = CurrentTenantService.Id;
+            sqlSugarClient.QueryFilter.AddTableFilter<IMultiTenant>(entity => entity.TenantId == currentTenantId);
         }
     }
 
+    /// <summary>
+    /// 数据执行前的处理
+    /// </summary>
     public override void DataExecuting(object oldValue, DataFilterModel entityInfo)
     {
-        //审计日志
+        HandleAuditFields(oldValue, entityInfo);
+        HandleEntityEvents(entityInfo);
+        HandleDomainEvents(entityInfo);
+    }
+
+    #region Private Methods
+
+    /// <summary>
+    /// 处理审计字段
+    /// </summary>
+    private void HandleAuditFields(object oldValue, DataFilterModel entityInfo)
+    {
         switch (entityInfo.OperationType)
         {
             case DataFilterType.UpdateByObject:
-
-                if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.LastModificationTime)))
-                {
-                    //最后更新时间，已经是最小值，忽略
-                    if (DateTime.MinValue.Equals(oldValue))
-                    {
-                        entityInfo.SetValue(null);
-                    }
-                    else
-                    {
-                        entityInfo.SetValue(DateTime.Now);
-                    }
-                }
-                else if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.LastModifierId)))
-                {
-                    if (typeof(Guid?) == entityInfo.EntityColumnInfo.PropertyInfo.PropertyType)
-                    {
-                        //最后更新者，已经是空guid，忽略
-                        if (Guid.Empty.Equals(oldValue))
-                        {
-                            entityInfo.SetValue(null);
-                        }
-                        else if (CurrentUser.Id != null)
-                        {
-                            entityInfo.SetValue(CurrentUser.Id);
-                        }
-                    }
-                }
-
+                HandleUpdateAuditFields(oldValue, entityInfo);
                 break;
             case DataFilterType.InsertByObject:
-
-                if (entityInfo.PropertyName.Equals(nameof(IEntity<Guid>.Id)))
-                {
-                    //类型为guid
-                    if (typeof(Guid) == entityInfo.EntityColumnInfo.PropertyInfo.PropertyType)
-                    {
-                        //主键为空或者为默认最小值
-                        if (Guid.Empty.Equals(oldValue))
-                        {
-                            entityInfo.SetValue(GuidGenerator.Create());
-                        }
-                    }
-                }
-
-                else if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.CreationTime)))
-                {
-                    //为空或者为默认最小值
-                    if (DateTime.MinValue.Equals(oldValue))
-                    {
-                        entityInfo.SetValue(DateTime.Now);
-                    }
-                }
-                else if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.CreatorId)))
-                {
-                    //类型为guid
-                    if (typeof(Guid?) == entityInfo.EntityColumnInfo.PropertyInfo.PropertyType)
-                    {
-                        if (CurrentUser.Id is not null)
-                        {
-                            entityInfo.SetValue(CurrentUser.Id);
-                        }
-                    }
-                }
-
-                else if (entityInfo.PropertyName.Equals(nameof(IMultiTenant.TenantId)))
-                {
-                    if (CurrentTenant.Id is not null)
-                    {
-                        entityInfo.SetValue(CurrentTenant.Id);
-                    }
-                }
-
+                HandleInsertAuditFields(oldValue, entityInfo);
                 break;
         }
+    }
 
+    /// <summary>
+    /// 处理更新时的审计字段
+    /// </summary>
+    private void HandleUpdateAuditFields(object oldValue, DataFilterModel entityInfo)
+    {
+        if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.LastModificationTime)))
+        {
+            entityInfo.SetValue(DateTime.MinValue.Equals(oldValue) ? null : DateTime.Now);
+        }
+        else if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.LastModifierId)) 
+                 && entityInfo.EntityColumnInfo.PropertyInfo.PropertyType == typeof(Guid?))
+        {
+            entityInfo.SetValue(Guid.Empty.Equals(oldValue) ? null : CurrentUserService.Id);
+        }
+    }
 
-        //实体变更领域事件
+    /// <summary>
+    /// 处理插入时的审计字段
+    /// </summary>
+    private void HandleInsertAuditFields(object oldValue, DataFilterModel entityInfo)
+    {
+        if (entityInfo.PropertyName.Equals(nameof(IEntity<Guid>.Id)))
+        {
+            if (typeof(Guid) == entityInfo.EntityColumnInfo.PropertyInfo.PropertyType)
+            {
+                if (Guid.Empty.Equals(oldValue))
+                {
+                    entityInfo.SetValue(GuidGeneratorService.Create());
+                }
+            }
+        }
+        else if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.CreationTime)))
+        {
+            if (DateTime.MinValue.Equals(oldValue))
+            {
+                entityInfo.SetValue(DateTime.Now);
+            }
+        }
+        else if (entityInfo.PropertyName.Equals(nameof(IAuditedObject.CreatorId)))
+        {
+            if (typeof(Guid?) == entityInfo.EntityColumnInfo.PropertyInfo.PropertyType)
+            {
+                if (CurrentUserService.Id is not null)
+                {
+                    entityInfo.SetValue(CurrentUserService.Id);
+                }
+            }
+        }
+        else if (entityInfo.PropertyName.Equals(nameof(IMultiTenant.TenantId)))
+        {
+            if (CurrentTenantService.Id is not null)
+            {
+                entityInfo.SetValue(CurrentTenantService.Id);
+            }
+        }
+    }
+
+    /// <summary>
+    /// 处理实体变更事件
+    /// </summary>
+    private void HandleEntityEvents(DataFilterModel entityInfo)
+    {
+        // 实体变更领域事件
         switch (entityInfo.OperationType)
         {
             case DataFilterType.InsertByObject:
                 if (entityInfo.PropertyName == nameof(IEntity<object>.Id))
                 {
-                    EntityChangeEventHelper.PublishEntityCreatedEvent(entityInfo.EntityValue);
+                    EntityChangeEventHelperService.PublishEntityCreatedEvent(entityInfo.EntityValue);
                 }
-
                 break;
             case DataFilterType.UpdateByObject:
                 if (entityInfo.PropertyName == nameof(IEntity<object>.Id))
                 {
-                    //软删除，发布的是删除事件
                     if (entityInfo.EntityValue is ISoftDelete softDelete)
                     {
                         if (softDelete.IsDeleted == true)
                         {
-                            EntityChangeEventHelper.PublishEntityDeletedEvent(entityInfo.EntityValue);
+                            EntityChangeEventHelperService.PublishEntityDeletedEvent(entityInfo.EntityValue);
                         }
                     }
                     else
                     {
-                        EntityChangeEventHelper.PublishEntityUpdatedEvent(entityInfo.EntityValue);
+                        EntityChangeEventHelperService.PublishEntityUpdatedEvent(entityInfo.EntityValue);
                     }
                 }
-
                 break;
             case DataFilterType.DeleteByObject:
-                // if (entityInfo.PropertyName == nameof(IEntity<object>.Id))
-                // {
-                    //这里sqlsugar有个特殊，删除会返回批量的结果
-                    //这里sqlsugar有第二个特殊，删除事件是行级事件
-                    if (entityInfo.EntityValue is IEnumerable entityValues)
+                if (entityInfo.EntityValue is IEnumerable entityValues)
+                {
+                    foreach (var entityValue in entityValues)
                     {
-                        foreach (var entityValue in entityValues)
-                        {
-                            EntityChangeEventHelper.PublishEntityDeletedEvent(entityValue);
-                        }
+                        EntityChangeEventHelperService.PublishEntityDeletedEvent(entityValue);
                     }
-                // }
-
+                }
                 break;
         }
-        
-      
-        //实体领域事件-所有操作类型
+    }
+
+    /// <summary>
+    /// 处理领域事件
+    /// </summary>
+    private void HandleDomainEvents(DataFilterModel entityInfo)
+    {
+        // 实体领域事件-所有操作类型
         if (entityInfo.PropertyName == nameof(IEntity<object>.Id))
         {
-            var eventReport =  CreateEventReport(entityInfo.EntityValue);
+            var eventReport = CreateEventReport(entityInfo.EntityValue);
             PublishEntityEvents(eventReport);
         }
     }
 
-    public override void OnLogExecuting(string sql, SugarParameter[] pars)
-    {
-        if (Options.EnabledSqlLog)
-        {
-            StringBuilder sb = new StringBuilder();
-            sb.AppendLine();
-            sb.AppendLine("==========Yi-SQL执行:==========");
-            sb.AppendLine(UtilMethods.GetSqlString(DbType.SqlServer, sql, pars));
-            sb.AppendLine("===============================");
-            Logger.CreateLogger<DefaultSqlSugarDbContext>().LogDebug(sb.ToString());
-        }
-    }
-
-    public override void OnLogExecuted(string sql, SugarParameter[] pars)
-    {
-        if (Options.EnabledSqlLog)
-        {
-            var sqllog = $"=========Yi-SQL耗时{SqlSugarClient.Ado.SqlExecutionTime.TotalMilliseconds}毫秒=====";
-            Logger.CreateLogger<SqlSugarDbContext>().LogDebug(sqllog.ToString());
-        }
-    }
-
-    public override void EntityService(PropertyInfo propertyInfo, EntityColumnInfo entityColumnInfo)
-    {
-        if (propertyInfo.Name == nameof(IHasConcurrencyStamp.ConcurrencyStamp)) //带版本号并发更新
-        {
-            entityColumnInfo.IsEnableUpdateVersionValidation = true;
-        }
-
-        if (propertyInfo.PropertyType == typeof(ExtraPropertyDictionary))
-        {
-            entityColumnInfo.IsIgnore = true;
-        }
-
-        if (propertyInfo.Name == nameof(Entity<object>.Id))
-        {
-            entityColumnInfo.IsPrimarykey = true;
-        }
-    }
-
-
     /// <summary>
     /// 创建领域事件报告
     /// </summary>
@@ -286,16 +301,58 @@ public class DefaultSqlSugarDbContext : SqlSugarDbContext
     {
         foreach (var localEvent in changeReport.DomainEvents)
         {
-            UnitOfWorkManager.Current?.AddOrReplaceLocalEvent(
+            UnitOfWorkManagerService.Current?.AddOrReplaceLocalEvent(
                 new UnitOfWorkEventRecord(localEvent.EventData.GetType(), localEvent.EventData, localEvent.EventOrder)
             );
         }
 
         foreach (var distributedEvent in changeReport.DistributedEvents)
         {
-            UnitOfWorkManager.Current?.AddOrReplaceDistributedEvent(
+            UnitOfWorkManagerService.Current?.AddOrReplaceDistributedEvent(
                 new UnitOfWorkEventRecord(distributedEvent.EventData.GetType(), distributedEvent.EventData, distributedEvent.EventOrder)
             );
         }
     }
+
+    #endregion
+
+    public override void OnLogExecuting(string sql, SugarParameter[] pars)
+    {
+        if (DbOptions.EnabledSqlLog)
+        {
+            StringBuilder sb = new StringBuilder();
+            sb.AppendLine();
+            sb.AppendLine("==========Yi-SQL执行:==========");
+            sb.AppendLine(UtilMethods.GetSqlString(DbType.SqlServer, sql, pars));
+            sb.AppendLine("===============================");
+            LoggerFactory.CreateLogger<DefaultSqlSugarDbContext>().LogDebug(sb.ToString());
+        }
+    }
+
+    public override void OnLogExecuted(string sql, SugarParameter[] pars)
+    {
+        if (DbOptions.EnabledSqlLog)
+        {
+            var sqllog = $"=========Yi-SQL耗时{SqlSugarClient.Ado.SqlExecutionTime.TotalMilliseconds}毫秒=====";
+            LoggerFactory.CreateLogger<SqlSugarDbContext>().LogDebug(sqllog.ToString());
+        }
+    }
+
+    public override void EntityService(PropertyInfo propertyInfo, EntityColumnInfo entityColumnInfo)
+    {
+        if (propertyInfo.Name == nameof(IHasConcurrencyStamp.ConcurrencyStamp)) //带版本号并发更新
+        {
+            entityColumnInfo.IsEnableUpdateVersionValidation = true;
+        }
+
+        if (propertyInfo.PropertyType == typeof(ExtraPropertyDictionary))
+        {
+            entityColumnInfo.IsIgnore = true;
+        }
+
+        if (propertyInfo.Name == nameof(Entity<object>.Id))
+        {
+            entityColumnInfo.IsPrimarykey = true;
+        }
+    }
 }