数据过滤

ABP定义了一些开箱即用的过滤.

将实体标记为已删除,并不是物理删除. 实现接口将你的实体”软删除”.

示例:

ISoftDelete 定义了 IsDeleted 属性. 当你使用删除一条记录时, ABP会自动将 IsDeleted 设置为true,并将删除操作替换为修改操作(如果需要,也可以手动将 IsDeleted 设置为true). 在查询数据库时会自动过滤软删除的实体.

多租户是创建 SaaS 应用程序的有效方法. 多租户应用程序通常需要在租户间隔离数据. 实现 IMultiTenant 接口使你的实体支持 “多租户”.

示例:

using System;
using Volo.Abp;
using Volo.Abp.Domain.Entities;
using Volo.Abp.MultiTenancy;
namespace Acme.BookStore
{
    public class Book : AggregateRoot<Guid>, ISoftDelete, IMultiTenant
    {
        public string Name { get; set; }
        public bool IsDeleted { get; set; } //Defined by ISoftDelete
        public Guid? TenantId { get; set; } //Defined by IMultiTenant
    }
}

你可以使用 IDataFilter 服务控制数据过滤.

示例:

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Volo.Abp;
using Volo.Abp.Data;
using Volo.Abp.DependencyInjection;
using Volo.Abp.Domain.Repositories;
{
    public class MyBookService : ITransientDependency
    {
        private readonly IDataFilter _dataFilter;
        private readonly IRepository<Book, Guid> _bookRepository;
            IDataFilter dataFilter,
            IRepository<Book, Guid> bookRepository)
        {
            _dataFilter = dataFilter;
            _bookRepository = bookRepository;
        }
        public async Task<List<Book>> GetAllBooksIncludingDeletedAsync()
        {
            //Temporary disable the ISoftDelete filter
            using (_dataFilter.Disable<ISoftDelete>())
            {
                return await _bookRepository.GetListAsync();
            }
        }
    }
}

IDataFilter 服务到你的类中.
在 using 语句中使用 Disable 方法创建一个代码块,其中禁用了 ISoftDelete 过滤器(始终与 using 搭配使用,确保代码块执行后将过滤重置为之前的状态).

IDataFilter.Enable 方法可以启用过滤. 可以嵌套使用 Enable 和 Disable 方法定义内部作用域.

AbpDataFilterOptions 用于设置数据过滤系统选项.

下面的示例代码在默认情况下禁用了 ISoftDelete 过滤,除非显示启用,在查询数据库时会包含标记为已删除的实体:

定义和实现新的过滤很大程序上取决与数据库提供者. ABP为所有的数据库提供者实现了预构建的过滤.

示例:

public interface IIsActive
{
    bool IsActive { get; }
}

IIsActive 接口可以过滤活跃/消极数据,任何都可以实现它:

public class Book : AggregateRoot<Guid>, IIsActive
{
    public bool IsActive { get; set; } //Defined by IIsActive
}

ABP使用EF Core的全局过滤系统用于. 所以它很好的集成到EF Core中,即使你直接使用 DbContext 它也可以正常工作.

实现自定义过滤的最佳方法是为重写你的的 ShouldFilterEntity 和 CreateFilterExpression 方法. 示例:

添加 IsActiveFilterEnabled 属性用于检查是否启用了 IIsActive . 内部使用了之前介绍到的 IDataFilter 服务.
重写 ShouldFilterEntity 和 CreateFilterExpression 方法检查给定实体是否实现 IIsActive 接口,在必要时组合表达式.

ABP直接在仓储级别实现数据过滤用于. 所以只有正确的使用仓储,它才会工作. 否则你需要手动过滤数据.

目前为MongoDB集成实现数据过滤的最佳方法是重写派生自 MongoDbRepository 仓储的 AddGlobalFilters 方法:

public class BookRepository : MongoDbRepository<BookStoreMongoDbContext, Book, Guid>
{
    protected override void AddGlobalFilters(List<FilterDefinition<Book>> filters)
    {
        if (DataFilter.IsEnabled<IIsActive>())
        {
            filters.Add(Builders<Book>.Filter.Eq(e => ((IIsActive)e).IsActive, true));
        }
    }
}

示例中仅为 Book 实体实现了过滤. 如果你想要为所有的实体实现过滤 (实现了 IIsActive 接口的实体),可以创建自己的MongoDB仓储基类并重写 AddGlobalFilters 方法. 如下所示:

public abstract class MyMongoRepository<TMongoDbContext, TEntity, TKey> : MongoDbRepository<TMongoDbContext, TEntity, TKey>
    where TMongoDbContext : IAbpMongoDbContext
    where TEntity : class, IEntity<TKey>
{
    protected MyMongoRepository(IMongoDbContextProvider<TMongoDbContext> dbContextProvider)
           : base(dbContextProvider)
    {
    }
    protected override void AddGlobalFilters(List<FilterDefinition<TEntity>> filters)
    {
        if (typeof(IIsActive).IsAssignableFrom(typeof(TEntity)) 
            && DataFilter.IsEnabled<IIsActive>())
        {
            filters.Add(Builders<TEntity>.Filter.Eq(e => ((IIsActive)e).IsActive, true));
        }