将泛型 func 作为 Linq 表达式 C#

Question

我有一个在多个地方重复的 Linq 表达式。我想集中定义 Linq 表达式并在所有这些地方使用它。这是代码：

 public interface ISoftDelete
 {
    DateTime? DeletedOn { get; set; }
 }

 public class BaseModel : ISoftDelete
 {
    public int Id { get; set; }
    public DateTime? DeletedOn { get; set; }
 }

 public class Epic: BaseModel {
 }

 public class Feature: BaseModel {
 }

 public class UserStory: BaseModel {
 }

 public class ProductFocusDbContext : DbContext
 {
        public ProductFocusDbContext(DbContextOptions<ProductFocusDbContext> options) : base(options) { }

        public DbSet<Epic> Epics { get; set; }
        public DbSet<Feature> Features { get; set; }
        public DbSet<UserStory> UserStories { get; set; }

      protected override void OnModelCreating(ModelBuilder modelBuilder)
      {

            // Epic
            modelBuilder.Entity<Epic>().HasQueryFilter(ExcludeSoftDeleted);

            // Feature
            modelBuilder.Entity<Feature>().HasQueryFilter(x => x.DeletedOn == null);

            // User Story
            modelBuilder.Entity<UserStory>().HasQueryFilter(x => x.DeletedOn == null);

      }

       System.Linq.Expressions.Expression<Func<ISoftDelete, bool>> ExcludeSoftDeleted = (x => x.DeletedOn == null) ;
}

我想用 ExcludeSoftDeleted 替换所有出现的 x => x.DeletedOn == null，但是当我尝试使用上述代码执行此操作时出现以下异常：

InvalidOperationException: 过滤器表达式 'x => (x.DeletedOn == 为实体类型“Epic”指定的 null)' 无效。表达方式 必须接受一个类型的参数 'ProductFocus.Domain.Model.Epic'，返回布尔值，可能不包含 对导航属性的引用。

我怎样才能实现它？

Answer 1

HasQueryFilter 是一个泛型方法，其中泛型参数T 与之前对Entity<EntityType> 的调用相匹配。在使用适当的类型时，您可以手动 传递表达式。但是，您尝试传递的表达式属性是 Expression<Func<ISoftDelete, bool>> 类型，并且没有来自 Expression<Func<EntityType, bool>> 的隐式转换，即使 EntityType 实现 ISoftDelete（Expression<> 不是协变的），这就是它不起作用的原因.

您可以通过提供一些帮助类来解决此问题，这些帮助类可以为您的实体返回适当的表达式。

public static class SoftDeleteHelper<T> 
    where T: ISoftDelete // constrain generic type to interface 
{
    public static Expression<Func<T, bool>> ExcludeSoftDeleted 
        => (x => x.DeletedOn == null):
}

然后您可以在查询过滤器中引用此内容：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Epic>().HasQueryFilter(SoftDeleteHelper<Epic>.ExcludeSoftDeleted);
    modelBuilder.Entity<Feature>().HasQueryFilter(SoftDeleteHelper<Feature>.ExcludeSoftDeleted);
    modelBuilder.Entity<UserStory>().HasQueryFilter(SoftDeleteHelper<UserStory>.ExcludeSoftDeleted);
} 

这里的关键是我们将泛型参数限制为ISoftDelete，这保证了实体类型上存在DeletedOn 属性。

或者，您可以将其定义为返回实体表达式的方法。如果您有其他需要约束到不同接口的查询过滤器，这可能更合适：

public static class ExpressionHelper
{
    public static Expression<Func<T, bool>> ExcludeSoftDeleted<T>() 
        where T: ISoftDelete // constrained to interface
        => (x => x.DeletedOn == null);
}

然后可以像下面这样使用（注意这与上面不同，需要()，因为您正在调用一个返回表达式而不是引用属性的函数）

modelBuilder.Entity<Epic>().HasQueryFilter(ExpressionHelper.ExcludeSoftDeleted<Epic>())

您可以更进一步，在 ModelBuilder 或 EntityTypeBuilder<T> 上编写限制为泛型类型的扩展方法，并完全省略辅助类

public static class EntityBuilderExtensions
{
    // extension method on the main builder 
    public static EntityTypeBuilder<T> EntityWithSoftDelete<T>(
        this ModelBuilder builder) 
        where T: class, ISoftDelete // extra class constraint required by Entity<>
    {
        return builder.Entity<T>().WithSoftDelete();
    }
    // extension method on the result of Entity<T>
    public static EntityTypeBuilder<T> WithSoftDelete<T>(
        this EntityTypeBuilder<T> builder) 
        where T: class, ISoftDelete // extra class constraint required by Entity<>
    {
        return builder.HasQueryFilter(
            e => e.DeletedOn == null 
        );
    } 
} 

由于ISoftDelete 上的通用约束，这再次有效。然后你可以这样称呼他们：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Epic>().WithSoftDelete();
    // or
    modelBuilder.EntityWithSoftDelete<Feature>();
} 

这些方法返回一个EntityTypeBuilder<T>，然后您可以使用它来链接更多的实体配置。