基於DDD的.NET開發框架 - ABP Session實現

時間 2019-12-04

標籤基於 ddd 開發框架 abp session 實現欄目設計模式简体版

原文原文鏈接

返回ABP系列html

ABP是「ASP.NET Boilerplate Project (ASP.NET樣板項目)」的簡稱。git

ASP.NET Boilerplate是一個用最佳實踐和流行技術開發現代WEB應用程序的新起點，它旨在成爲一個通用的WEB應用程序框架和項目模板。github

ABP的官方網站：http://www.aspnetboilerplate.comsession

ABP官方文檔：http://www.aspnetboilerplate.com/Pages/Documents框架

Github上的開源項目：https://github.com/aspnetboilerplateide

1、基本概念

AbpSession，並無使用到System.Web.HttpSessionStateBase，而是本身定義了一個Abp.Runtime.Session.IAbpSession接口，並在Zero模塊中經過AspNet.Identity組件實現了AbpSession對象的存值、取值。因此即便Web服務重啓，也不會丟失Session狀態。網站

須要獲取會話信息則必須實現IAbpSession接口。this

Session對象只有UserId、TenantId、MultiTenancySide、ImpersonatorUserId、ImpersonatorTenantId這幾個屬性是不夠用的能夠本身擴充。spa

注入Session：日誌

IAbpSession一般是以屬性注入的方式存在於須要它的類中，不須要獲取會話信息的類中則不須要它。若是咱們使用屬性注入方式，咱們能夠用
NullAbpSession.Instance做爲默認值來初始化它（IAbpSession），以下所示：

public class MyClass : ITransientDependency
{
    public IAbpSession AbpSession { get; set; }

    public MyClass()
    {
        AbpSession = NullAbpSession.Instance;
    }

    public void MyMethod()
    {
        var currentUserId = AbpSession.UserId;
        //...
    }
}

ApplicationService, AbpController 和 AbpApiController 這3個基類已經注入了AbpSession屬性，所以在Application Service的實例方法中，能直接使用AbpSession屬性。

Session屬性：

UserId: 當前用戶的標識ID，若是沒有當前用戶則爲null.若是須要受權訪問則它不可能爲空。

TenantId: 當前租戶的標識ID，若是沒有當前租戶則爲null。

MultiTenancySide: 多是Host或Tenant。

ImpersonatorUserid：身份證冒領用戶若是當前會話是由模擬另外一個用戶。若是這不是一個模擬登陸則爲null。

ImpersonatorTenantid：身份證冒領用戶的租戶，若是當前會話是由模擬另外一個用戶。若是這不是一個模擬登陸則爲null。

UserId和TenantId是能夠爲null的。固然也提供了不爲空時獲取數據的 GetUserId()和GetTenantId() 方法。當你肯定有當前用戶時，你可使用GetUserId()方法。
若是當前用戶爲空，使用該方法則會拋出一個異常。GetTenantId()的使用方式和GetUserId()相似。

Impersonator屬性通常用於日誌審計的。

用戶標識：

可使用TouUseriIdentifier()擴展方法來建立一個對象從IabpSession UserIdentifier。由於UserIdentifier大多使用的API，這將簡化建立一個當前用戶UserIdentifier。

2、ABP如何實現Session的

目錄代碼：

類圖：

IAbpSession:IAbpSession接口

using Abp.MultiTenancy;

namespace Abp.Runtime.Session
{
    public interface IAbpSession
    {
        long? UserId { get; }
        int? TenantId { get; }
        MultiTenancySides MultiTenancySide { get; }
        long? ImpersonatorUserId { get; }
        int? ImpersonatorTenantId { get; }
    }
}

NullAbpSession：實現了空對象模式

using Abp.MultiTenancy;

namespace Abp.Runtime.Session
{
    /// <summary>
    /// Implements null object pattern for <see cref="IAbpSession"/>.
    /// </summary>
    public class NullAbpSession : IAbpSession
    {
        /// <summary>
        /// Singleton instance.
        /// </summary>
        public static NullAbpSession Instance { get { return SingletonInstance; } }
        private static readonly NullAbpSession SingletonInstance = new NullAbpSession();

        /// <inheritdoc/>
        public long? UserId { get { return null; } }

        /// <inheritdoc/>
        public int? TenantId { get { return null; } }

        public MultiTenancySides MultiTenancySide { get { return MultiTenancySides.Tenant; } }
        
        public long? ImpersonatorUserId { get { return null; } }
        
        public int? ImpersonatorTenantId { get { return null; } }

        private NullAbpSession()
        {

        }
    }
}

ClaimsAbpSession：獲取會話狀態

using System;
using System.Linq;
using System.Security.Claims;
using System.Threading;
using Abp.Configuration.Startup;
using Abp.MultiTenancy;
using Abp.Runtime.Security;

namespace Abp.Runtime.Session
{
    /// <summary>
    /// Implements <see cref="IAbpSession"/> to get session properties from claims of <see cref="Thread.CurrentPrincipal"/>.
    /// </summary>
    public class ClaimsAbpSession : IAbpSession
    {
        private const int DefaultTenantId = 1;

        public virtual long? UserId
        {
            get
            {
                var claimsPrincipal = Thread.CurrentPrincipal as ClaimsPrincipal;
                if (claimsPrincipal == null)
                {
                    return null;
                }

                var claimsIdentity = claimsPrincipal.Identity as ClaimsIdentity;
                if (claimsIdentity == null)
                {
                    return null;
                }

                var userIdClaim = claimsIdentity.Claims.FirstOrDefault(c => c.Type == ClaimTypes.NameIdentifier);
                if (userIdClaim == null || string.IsNullOrEmpty(userIdClaim.Value))
                {
                    return null;
                }

                long userId;
                if (!long.TryParse(userIdClaim.Value, out userId))
                {
                    return null;
                }

                return userId;
            }
        }

        public virtual int? TenantId
        {
            get
            {
                if (!_multiTenancy.IsEnabled)
                {
                    return DefaultTenantId;
                }

                var claimsPrincipal = Thread.CurrentPrincipal as ClaimsPrincipal;
                if (claimsPrincipal == null)
                {
                    return null;
                }

                var tenantIdClaim = claimsPrincipal.Claims.FirstOrDefault(c => c.Type == AbpClaimTypes.TenantId);
                if (tenantIdClaim == null || string.IsNullOrEmpty(tenantIdClaim.Value))
                {
                    return null;
                }

                return Convert.ToInt32(tenantIdClaim.Value);
            }
        }

        public virtual MultiTenancySides MultiTenancySide
        {
            get
            {
                return _multiTenancy.IsEnabled && !TenantId.HasValue
                    ? MultiTenancySides.Host
                    : MultiTenancySides.Tenant;
            }
        }

        public virtual long? ImpersonatorUserId
        {
            get
            {
                var claimsPrincipal = Thread.CurrentPrincipal as ClaimsPrincipal;
                if (claimsPrincipal == null)
                {
                    return null;
                }

                var impersonatorUserIdClaim = claimsPrincipal.Claims.FirstOrDefault(c => c.Type == AbpClaimTypes.ImpersonatorUserId);
                if (impersonatorUserIdClaim == null || string.IsNullOrEmpty(impersonatorUserIdClaim.Value))
                {
                    return null;
                }

                return Convert.ToInt64(impersonatorUserIdClaim.Value);
            }
        }

        public virtual int? ImpersonatorTenantId
        {
            get
            {
                if (!_multiTenancy.IsEnabled)
                {
                    return DefaultTenantId;
                }

                var claimsPrincipal = Thread.CurrentPrincipal as ClaimsPrincipal;
                if (claimsPrincipal == null)
                {
                    return null;
                }

                var impersonatorTenantIdClaim = claimsPrincipal.Claims.FirstOrDefault(c => c.Type == AbpClaimTypes.ImpersonatorTenantId);
                if (impersonatorTenantIdClaim == null || string.IsNullOrEmpty(impersonatorTenantIdClaim.Value))
                {
                    return null;
                }

                return Convert.ToInt32(impersonatorTenantIdClaim.Value);
            }
        }

        private readonly IMultiTenancyConfig _multiTenancy;

        /// <summary>
        /// Constructor.
        /// </summary>
        public ClaimsAbpSession(IMultiTenancyConfig multiTenancy)
        {
            _multiTenancy = multiTenancy;
        }
    }
}

View Code

AbpSessionExtensions：IAbpSession擴展方法

using System;

namespace Abp.Runtime.Session
{
    /// <summary>
    /// Extension methods for <see cref="IAbpSession"/>.
    /// </summary>
    public static class AbpSessionExtensions
    {
        /// <summary>
        /// Gets current User's Id.
        /// Throws <see cref="AbpException"/> if <see cref="IAbpSession.UserId"/> is null.
        /// </summary>
        /// <param name="session">Session object.</param>
        /// <returns>Current User's Id.</returns>
        public static long GetUserId(this IAbpSession session)
        {
            if (!session.UserId.HasValue)
            {
                throw new AbpException("Session.UserId is null! Probably, user is not logged in.");
            }

            return session.UserId.Value;
        }

        /// <summary>
        /// Gets current Tenant's Id.
        /// Throws <see cref="AbpException"/> if <see cref="IAbpSession.TenantId"/> is null.
        /// </summary>
        /// <param name="session">Session object.</param>
        /// <returns>Current Tenant's Id.</returns>
        /// <exception cref="AbpException"></exception>
        public static int GetTenantId(this IAbpSession session)
        {
            if (!session.TenantId.HasValue)
            {
                throw new AbpException("Session.TenantId is null! Possible problems: No user logged in or current logged in user in a host user (TenantId is always null for host users).");
            }

            return session.TenantId.Value;
        }

        /// <summary>
        /// Creates <see cref="UserIdentifier"/> from given session.
        /// Returns null if <see cref="IAbpSession.UserId"/> is null.
        /// </summary>
        /// <param name="session">The session.</param>
        public static UserIdentifier ToUserIdentifier(this IAbpSession session)
        {
            return session.UserId == null
                ? null
                : new UserIdentifier(session.TenantId, session.GetUserId());
        }
    }
}