详解ABP框架中Session功能的使用方法
如果一个应用程序需要登录,则它必须知道当前用户执行了什么操作。因此ASP.NET在展示层提供了一套自己的SESSION会话对象,而ABP则提供了一个可以在任何地方
获取当前用户和租户的IAbpSession接口。
关于IAbpSession
需要获取会话信息则必须实现IAbpSession接口。虽然你可以用自己的方式去实现它(IAbpSession),但是它在module-zero项目中已经有了完整的实现。
注入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; //... } }
由于授权是应用层的任务,因此我们应该在应用层和应用层的上一层使用IAbpSession(我们不在领域层使用IAbpSession是很正常的)。
ApplicationService, AbpController 和 AbpApiController 这3个基类已经注入了AbpSession属性,因此在Application Service的实例方法中,能直接使用AbpSession属性。
使用Session属性
AbpSession定义的一些关键属性:
- UserId: 当前用户的标识ID,如果没有当前用户则为null.如果需要授权访问则它不可能为空。
- TenantId: 当前租户的标识ID,如果没有当前租户则为null。
- MultiTenancySide: 可能是Host或Tenant。
UserId和TenantId是可以为null的。当然也提供了不为空时获取数据的 GetUserId()和GetTenantId() 方法 。当你确定有当前用户时,你可以使用GetUserId()方法。
如果当前用户为空,使用该方法则会抛出一个异常。GetTenantId()的使用方式和GetUserId()类似。
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; } } }
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()); } } }
相关文章
ABP(现代ASP.NET样板开发框架)系列之二、ABP入门教程详解
ABP是为新的现代Web应用程序使用最佳实践和使用最流行工具的一个起点。可作为一般用途的应用程序的基础框架或项目模板。接下来通过本文给大家详细介绍ABP入门教程,感兴趣的朋友一起看看吧...2021-09-22- ABP框架是基于ASP.NET的Web开发框架(GitHub: https://github.com/aspnetboilerplate),在ASP.NET框架之上又添加了更强大的功能,这里我们就来详解ABP框架的参数有效性验证和权限验证...2021-09-22
ABP框架中导航菜单的使用及JavaScript API获取菜单的方法
ABP框架是基于ASP.NET的Web开发框架,其中包含基本的菜单项可供调用,特别是自动生成的js API使得能够在客户端获取菜单,这里我们就来看一下ABP框架中导航菜单的使用及JavaScript API获取菜单的方法...2021-09-22- Bootstrap table是一个开源的轻量级功能非常丰富的前端表格插件。下面通过本文给大家介绍ABP入门系列应用BootstrapTable表格插件,感兴趣的朋友一起学习吧...2021-09-22
- ABP框架是基于ASP.NET的Web开发框架,不过它遵循一种名为DDD(领域驱动设计)的设计模式原则,接下来我们就来看一下ABP框架的体系结构及模块系统讲解...2021-09-22
- ,JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。本文重点给大家介绍ABP入门系列之Json格式化,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了ABP框架的基础配置及依赖注入讲解,是ABP框架上手使用的基本,要的朋友可以参考下...2021-09-22
- ABP框架是基于ASP.NET的Web开发框架,在ABP中应用服务将领域逻辑暴露给展现层,展现层通过传入数据传输对象参数来调用应用服务,而这里我们就来解析ABP框架中的数据传输对象与应用服务...2021-09-22
- ABP是"ASP.NET Boilerplate Project(ASP.NET样板项目)"的简称,是一个建立在.NET之上的Web开发框架,下面我们来解析ABP框架中的事务处理和工作单元...2021-09-22
- ABP是基于ASP.NET框架之上的Web开发框架(GitHub:https://github.com/aspnetboilerplate),这篇我们来详解ABP框架中领域层的领域事件Domain events,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了ASP.NET样板项目ABP框架的特性总结,ABP框架基于ASP.NET框架,用于开发Web应用程序,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了如何在Asp.Net Core中集成ABP Dapper,帮助大家更好的理解和学习使用Asp.Net Core,感兴趣的朋友可以了解下...2021-09-22
- ABP是基于Windows系统上.NET Framework环境的Web开发框架,这里我们基于.NET的Visual Studio开发环境,来共同进入基于ASP.NET MVC的ABP框架入门学习教程...2021-09-22
- 基于ASP.NET的ABP框架遵循DDD领域驱动设计,其中就有一个领域层的概念,这里我们就来解析ABP框架领域层中的实体类与仓储类:...2021-09-22
- 本节主要讲解了如何使用ABP进行后台分页,并顺带讲解了ABP后台分页逻辑的实现方式。同时也演示了如何使用X.PagedList进行前端分页...2021-09-22
- ABP框架是一个基于ASP.NET的Web开发框架,这里我们来详解ABP框架中的数据过滤器与数据传输对象的使用,需要的朋友可以参考下...2021-09-22
- ABP(ASP.NET Boilerplate)是基于ASP.NET的Web开发框架,其在日志方面的功能非常强大,特别是审计跟踪日志,下面我们就来进行ABP框架中的日志功能完全解析...2021-09-22
- ABP(ASP.NET Boilerplate Project)是基于ASP.NET框架的一个Web开发框架,这里我们来详解ABP框架中Session功能的使用方法,需要的朋友可以参考下...2021-09-22