abp中多種登錄用戶的設計

項目地址：https://gitee.com/bxjg1987/abp

場景

在《學校管理系統》中，學生、家長、教師、教務均可能登錄，作一些屬於他們本身的操做。這些用戶須要的屬性各不相同，好比學生有學號，而教師沒有。

應用程序用戶

在編碼時，常常須要獲取當前登錄用戶的信息，這個當前登錄用戶就是應用程序用戶。asp.net提供了一整套方案來實現應用程序用戶，包括身份驗證、受權、asp.net identity等

應用程序用戶與業務場景中的用戶不一樣，應用程序用戶只須要區別是誰，最簡單狀況只須要知道用戶id，它不關心這個用戶具體是教師仍是學生或其它類型的用戶。基於這個用戶id還能夠實現角色、受權等操做。 淺顯點理解應用程序用戶主要是識別用戶id，方便實現角色和受權

而「學生」、「教師」則是《學校管理系統》這個場景中的具體業務概念。

abp中有個abp zero模塊,它已實現應用程序用戶管理、登錄、角色、受權等功能。

與abp用戶一對一關聯

當業務用戶須要登錄時，一對一關聯到應用程序用戶。*
這樣系統自己提供的登錄、註銷、角色、受權等功能幾乎保持不變，按須要能夠實現多種業務用戶類型。

模塊化

咱們的系統是按業務分模塊開發的，參考：https://www.bilibili.com/video/BV1b5411L7Hf/
有些業務模塊可能存在業務用戶，好比【商城模塊】中的「顧客」，在設計時須要考慮模塊化和可擴展性。

因爲是獨立模塊，因此咱們不知道未來模塊被什麼系統引用，所以也不知道具體的AbpUser類型，由於那是模塊使用方本身定義的，所以在開發業務模塊時不該該出現具體的AbpUser的類型，須要關聯時只能關聯Id，必要時能夠引用抽象的AbpUser及其管理類。

Core層

按ddd和abp的方式這層須要創建：聚合根、實體、值對象、領域服務、領域事件、倉儲接口。
下面以《學校管理系統》場景說明

實體

按ddd方式定義學生實體（它應該是聚合根）。

定義學號、所屬學院、所屬專業等屬性，重點是它有個UserId屬性，關聯到應用程序用戶，注意不要使用導航屬性關聯到AbpUser，一來ddd建議一個聚合中的實體不要使用導航屬性關聯到另外一個聚合中的實體，二來咱們使用的是模塊化開發方式，咱們在開發本身的模塊時並不會知道模塊未來被誰使用，所以就不會知道具體的類型，由於在abp中，用戶是由開發人員自定義的。

不要考慮模塊使用方使用繼承來擴展實體，建議使用abp提供的IExtensionObject接口或動態屬性系統。
領域實體中能夠觸發事件，以便模塊調用方擴展

領域服務、領域事件、倉儲接口。

這個根據須要決定是否認義。
領域服務能夠提供虛方法以便模塊使用方法提供子類重寫，也能夠觸發相應事件讓模塊使用方去訂閱。
因爲未來可能增長更多用戶類型，領域服務能夠考慮抽象封裝在BXJG.Utils（依賴abp的通用功能模塊）中

EFCore層

ef映射和種子數據的處理

Application層

新增業務用戶時考慮同時創建並關聯用戶、刪除時則一併刪除。
能夠提供虛方法，以便模塊調用方繼承並重寫
在模塊中，沒有將新增、刪除應用程序用戶的邏輯預留給模塊使用方，而是在模塊內部直接作了，模塊調用方能夠訂閱UserCreating、UserDeleting事件來插入本身的邏輯
因爲未來可能增長更多用戶類型，應用服務能夠考慮抽象封裝在BXJG.Utils.Application中

session與登錄

如《學生管理系統》有個學生後臺，裏面全都是學生能夠操做的功能，作這些功能時一般須要獲取當前登錄學生的id。abp的seession功能只能獲取當前登錄用戶id，這是abpUser的id，這個id並非咱們須要的，它與學生實體是一對一關聯的。

咱們能夠經過abp的seesion獲取當前abpUser的id，而後去對應用戶表查詢獲得業務用戶的id，但這樣比較浪費性能。
咱們的思路是在用戶登錄時將關聯的業務場景用戶的id存儲到claim中，而後提供一個相似abpsession的session來在須要是提供當前業務用戶的id
咱們能夠爲每種用戶創建登錄頁面，在登錄時存儲業務用戶id到claim中，也能夠在統一的登錄頁面加各判斷，而後獲取對應業務用戶類型表中的業務用戶id
session的設計也能夠抽象出來，由於有多種用戶類型

如何使用

abp官方文檔教程中有[擴展session](https://aspnetboilerplate.com/Pages/Documents/Articles%5CHow-To%5Cadd-custom-session-field-aspnet-core)的說明，咱們也是按這個思路作的。因爲系統可能存在多種業務用戶，所以須要簡單封裝下，下面看看商城模塊中的顧客是如何實現session和登錄的

實體實現IBusinessUserEntity

1 public class CustomerEntity : FullAuditedAggregateRoot<long>, IBusinessUserEntity , IMustHaveTenant, IExtendableObject
2 //略....

定義session接口和實現 

 1 public interface ICustomerSession : IBusinessUserSession<long>{}
 2 
 3 public class CustomerClaimSession : BusinessUserClaimSession<long>, ICustomerSession
 4 {
 5     public CustomerClaimSession(IPrincipalAccessor principalAccessor,
 6     IMultiTenancyConfig multiTenancy,
 7     ITenantResolver tenantResolver,
 8     IAmbientScopeProvider<SessionOverride> sessionOverrideScopeProvider) :         base(principalAccessor, multiTenancy, tenantResolver,     sessionOverrideScopeProvider, CoreConsts.CustomerIdClaim)
 9     {
10     }
11 }    

在模塊中實現ioc注入

1 public override void Initialize()
2 {
3      IocManager.IocContainer.Register(Component.For<ICustomerSession>()
4      .ImplementedBy<CustomerClaimSession>()
5      .LifestyleCustom<MsScopedLifestyleManager>()
6      .Named("sdf234sdf"));//CustomerClaimSession的父類已單例註冊了，須要重命名下
7 
8 }

 

定義登錄器接口和實現

public interface ICustomerLoginManager<TUser> : IBusinessUserLoginManager<TUser> { }

/// <summary>
/// 提供與顧客登錄相關功能
/// </summary>
public class CustomerLoginManager<TTenant,
    TRole,
    TUser,
    TUserManager> : BusinessUserLoginManager<CustomerEntity,
                long,
                TTenant,
                TRole,
                TUser,
                TUserManager>, ICustomerLoginManager<TUser>
where TTenant : AbpTenant<TUser>
where TRole : AbpRole<TUser>, new()
where TUser : AbpUser<TUser>
where TUserManager : AbpUserManager<TRole, TUser>
{
        public CustomerLoginManager(IRepository<CustomerEntity, long> repository,
TUserManager userManager) : base(repository,
userManager,
CoreConsts.CustomerRoleName,
CoreConsts.CustomerIdClaim)
{ }
}                        

主程序的XXX.Core的Module類中添加依賴注入

1 IocManager.Register<ICustomerLoginManager<User>, CustomerLoginManager<Tenant, Role, User, UserManager>>(Abp.Dependency.DependencyLifeStyle.Transient);

使用登錄器

最後在主程序的UserClaimsPrincipalFactory中

 1  public class UserClaimsPrincipalFactory : AbpUserClaimsPrincipalFactory<User, Role>
 2   {
 3     private readonly ICustomerLoginManager<User> customerLoginManager;
 4     public UserClaimsPrincipalFactory(
 5     UserManager userManager,
 6     RoleManager roleManager,
 7     IOptions<IdentityOptions> optionsAccessor, ICustomerLoginManager<User>         customerLoginManager)
 8     : base(
 9     userManager,
10     roleManager,
11     optionsAccessor)
12     {
13     this.customerLoginManager = customerLoginManager;
14     }
15     public override async Task<ClaimsPrincipal> CreateAsync(User user)
16     {
17     var claim = await base.CreateAsync(user);
18     var c = await customerLoginManager.GetBusinessUserClaim(user);
19     if(c!=null)
20 claim.Identities.First().AddClaim(c);
21         return claim;
22     }
23 }

流程說明

登錄時AbpLoginManager會調用UserClaimsPrincipalFactory來向當前登錄用戶的Claims中插入Claim
UserClaimsPrincipalFactory會調用ICustomerLoginManager，先判斷用戶是不是顧客的角色，如果則根據用戶Id找到顧客Id，而後將顧客Id存儲到Claims中

後續咱們在須要獲取當前登錄的顧客的id時在咱們的服務中依賴注入ICustomerSession就能夠了，它會從當前登錄用戶的Claims中去找到顧客id