ABP框架实现组织单元切换功能的技术解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00450/article/details/148392052

ABP框架实现组织单元切换功能的技术解析

abp Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation. 项目地址: https://gitcode.com/gh_mirrors/abp1/abp

引言

在企业级应用开发中，多组织架构管理是一个常见需求。ABP框架提供了一套完整的解决方案，帮助开发者轻松实现组织单元切换功能。本文将详细介绍如何在ABP框架中实现这一功能，包括数据过滤、组织单元管理、用户界面集成等核心环节。

核心概念

组织单元(Organization Unit)

组织单元是企业架构中的基本单位，代表公司内部的部门、分支机构等。在ABP框架中，组织单元通过OrganizationUnit实体进行管理，用户可以属于多个组织单元。

数据过滤机制

ABP框架提供了强大的数据过滤功能，允许开发者基于特定条件自动过滤数据。在本场景中，我们将基于当前选择的组织单元ID来过滤数据。

实现步骤

1. 定义数据过滤接口

首先创建一个IHasOrganization接口，用于标记需要按组织单元过滤的实体：

public interface IHasOrganization
{
    public Guid? OrganizationId { get; set; }
}

2. 实体类实现

让需要按组织单元过滤的实体实现该接口：

public class Book : AggregateRoot<Guid>, IHasOrganization
{
    public string Name { get; set; }
    public string Isbn { get; set; }
    public Guid? OrganizationId { get; set; }
}

3. 配置DbContext

在DbContext中配置数据过滤器：

public class BookStoreDbContext : AbpDbContext<BookStoreDbContext>
{
    // 其他配置...
    
    protected override bool ShouldFilterEntity<TEntity>(IMutableEntityType entityType)
    {
        if (typeof(IHasOrganization).IsAssignableFrom(typeof(TEntity)))
        {
            return true;
        }
        return base.ShouldFilterEntity<TEntity>(entityType);
    }

    protected override Expression<Func<TEntity, bool>> CreateFilterExpression<TEntity>(ModelBuilder modelBuilder)
    {
        var expression = base.CreateFilterExpression<TEntity>(modelBuilder);

        if (typeof(IHasOrganization).IsAssignableFrom(typeof(TEntity)))
        {
            Expression<Func<TEntity, bool>> hasOrganizationIdFilter = 
                e => EF.Property<Guid>(e, "OrganizationId") == CurrentOrganizationIdProvider.CurrentOrganizationId;
            expression = expression == null ? hasOrganizationIdFilter : 
                QueryFilterExpressionHelper.CombineExpressions(expression, hasOrganizationIdFilter);
        }

        return expression;
    }
}

4. 实现当前组织单元提供者

创建一个单例服务来管理当前组织单元ID：

public class CurrentOrganizationIdProvider : ISingletonDependency
{
    private readonly AsyncLocal<Guid?> _currentOrganizationId = new AsyncLocal<Guid?>();

    public Guid? CurrentOrganizationId => _currentOrganizationId.Value;

    public virtual IDisposable Change(Guid? organizationId)
    {
        var parent = CurrentOrganizationId;
        _currentOrganizationId.Value = organizationId;
        return new DisposeAction(() => _currentOrganizationId.Value = parent);
    }
}

5. 浏览器信息管理

为了支持多标签页不同组织单元选择，需要添加浏览器信息识别：

public class BrowserInfoClaimsPrincipalContributor : IAbpClaimsPrincipalContributor
{
    public Task ContributeAsync(AbpClaimsPrincipalContributorContext context)
    {
        var identity = context.ClaimsPrincipal.Identities.FirstOrDefault();
        identity?.AddClaim(new Claim("BrowserInfo", Guid.NewGuid().ToString()));
        return Task.CompletedTask;
    }
}

6. 应用服务实现

创建组织单元管理应用服务：

[Authorize]
public class CurrentOrganizationAppService : BookStoreAppService
{
    public virtual async Task<List<OrganizationDto>> GetOrganizationListAsync()
    {
        // 获取用户所属组织单元列表
    }

    public virtual async Task<Guid?> GetCurrentOrganizationIdAsync()
    {
        // 获取当前选择的组织单元ID
    }

    public virtual async Task ChangeAsync(Guid? organizationId)
    {
        // 更改当前组织单元ID
    }
}

7. 数据种子

添加示例数据：

public class BooksDataSeedContributor : IDataSeedContributor
{
    public virtual async Task SeedAsync(DataSeedContext context)
    {
        // 创建组织单元
        await _organizationUnitManager.CreateAsync(new OrganizationUnit(UsaBranchId, "USA Branch"));
        await _organizationUnitManager.CreateAsync(new OrganizationUnit(TurkeyBranchId, "Turkey Branch"));
        
        // 添加用户到组织单元
        await _identityUserManager.AddToOrganizationUnitAsync(admin.Id, UsaBranchId);
        await _identityUserManager.AddToOrganizationUnitAsync(admin.Id, TurkeyBranchId);
        
        // 添加示例书籍
        await _bookRepository.InsertAsync(new Book
        {
            Name = "1984",
            Isbn = "978-0451524935",
            OrganizationId = UsaBranchId
        });
        // 更多书籍...
    }
}

8. 用户界面集成

创建组织单元切换组件：

<div class="dropstart">
    <a href="#" class="btn mt-2" data-bs-toggle="dropdown">
        <i class="fa fa-city m-auto"></i>
    </a>
    <ul class="dropdown-menu p-0" style="width: 200px">
        <div class="list-group">
            @foreach (var ou in Model.OrganizationDtos)
            {
                <button type="button" onclick="setOrganizationUnitId('@ou.Id')" 
                    class="list-group-item list-group-item-action @(ou.Id == Model.CurrentOrganizationId ? "active" : "")">
                    @ou.DisplayName
                </button>
            }
        </div>
    </ul>
</div>

9. 中间件配置

添加中间件在请求管道中设置当前组织单元：

app.UseAuthorization();
app.Use(async (httpContext, next) =>
{
    // 从缓存获取当前组织单元ID并设置
    var currentUser = httpContext.RequestServices.GetRequiredService<ICurrentUser>();
    var cacheKey = currentUser.Id + ":" + currentUser.GetBrowserInfo();
    var cacheItem = await cache.GetAsync(cacheKey);
    
    if (cacheItem != null)
    {
        var provider = httpContext.RequestServices.GetRequiredService<CurrentOrganizationIdProvider>();
        provider.Change(cacheItem.OrganizationId);
    }
    
    await next(httpContext);
});