Merge pull request '🍒 新增Session扩展属性，方便业务层扩展；部分功能优化' (#427) from jasondom/Admin.NET.Pro:v2-1 into v2

Reviewed-on: https://code.adminnet.top/Admin.NET/Admin.NET.Pro/pulls/427

Admin.NET/Admin.NET.Application/Service/App/Auth/AppUserManager.cs

@@ -16,15 +16,35 @@ namespace Admin.NET.Application;
 public class AppUserManager(
     SysCacheService sysCacheService,
     IHttpContextAccessor httpContextAccessor)
-    : UserManager(sysCacheService, httpContextAccessor)
+    : UserManager(sysCacheService, httpContextAccessor), IUserSessionExtProps
 {
-    // 扩展属性
+    /// <summary>
-}
+    /// 工号
+    /// </summary>
+    public string JobNum => base.GetExtProp<string>(nameof(JobNum));
 
     /// <summary>
-/// 用户会话信息
+    /// 最新登录Ip
     /// </summary>
-public partial class UserSessionDao
+    public string LastLoginIp => base.GetExtProp<string>(nameof(LastLoginIp));
+
+    /// <summary>
+    /// 最新登录Ip
+    /// </summary>
+    public string LastLoginDevice => base.GetExtProp<string>(nameof(LastLoginDevice));
+
+    /// <summary>
+    /// 初始化扩展属性
+    /// </summary>
+    /// <param name="user"></param>
+    /// <returns></returns>
+    public Dictionary<string, object> GetInitExtProps(SysUser user)
     {
-    // 扩展属性
+        return new()
+        {
+            { nameof(JobNum), user.JobNum },
+            { nameof(LastLoginIp), user.LastLoginIp },
+            { nameof(LastLoginDevice), user.LastLoginDevice },
+        };
+    }
 }

Admin.NET/Admin.NET.Core/Entity/IEntityFilter.cs

@@ -38,3 +38,14 @@ public interface IOrgIdFilter
     /// </summary>
     long? CreateOrgId { get; set; }
 }
+
+/// <summary>
+/// 应用Id接口过滤器
+/// </summary>
+public interface IAppIdFilter
+{
+    /// <summary>
+    /// 系统层应用Id
+    /// </summary>
+    long? AppId { get; set; }
+}

Admin.NET/Admin.NET.Core/Service/Auth/SysAuthService.cs

@@ -229,6 +229,7 @@ public class SysAuthService : IDynamicApiController, ITransient
         await App.GetRequiredService<SysOnlineUserService>().SingleLogin(user.Id, loginMode);
 
         // 生成Token令牌
+        user.TokenVersion += 1;
         var tokenExpire = await _sysConfigService.GetTokenExpire();
         var accessToken = JWTEncryption.Encrypt(new Dictionary<string, object>
         {
@@ -245,10 +246,12 @@ public class SysAuthService : IDynamicApiController, ITransient
             RealName = user.RealName,
             AccountType = user.AccountType,
             OrgId = user.OrgId,
+            OrgCode = user.SysOrg?.Code,
             OrgName = user.SysOrg?.Name,
             OrgType = user.SysOrg?.Type,
             OrgLevel = user.SysOrg?.Level,
             TokenVersion = user.TokenVersion,
+            ExtProps = App.GetServices<IUserSessionExtProps>().SelectMany(u => u.GetInitExtProps(user)).ToDictionary(u => u.Key, u => u.Value)
         }, TimeSpan.FromMinutes(tokenExpire));
 
         // 生成刷新Token令牌
@@ -262,7 +265,6 @@ public class SysAuthService : IDynamicApiController, ITransient
         // ke.global.setAllHeader('Authorization', 'Bearer ' + ke.response.headers['access-token']);
 
         // 更新用户登录信息
-        user.TokenVersion += 1;
         user.LastLoginIp = _httpContextAccessor.HttpContext.GetRemoteIpAddressToIPv4(true);
         (user.LastLoginAddress, double? longitude, double? latitude) = CommonHelper.GetIpAddress(user.LastLoginIp);
         user.LastLoginTime = DateTime.Now;
@@ -364,7 +366,7 @@ public class SysAuthService : IDynamicApiController, ITransient
 
         // 写入Token黑名单
         var tokenExpire = await _sysConfigService.GetTokenExpire();
-        _sysCacheService.Set($"{CacheConst.KeyTokenBlacklist}:{userId}:{version}", _userManager.Account, TimeSpan.FromMinutes(tokenExpire));
+        _sysCacheService.Set($"{CacheConst.KeyTokenBlacklist}{userId}:{version}", _userManager.Account, TimeSpan.FromMinutes(tokenExpire));
 
         // 发布系统退出事件
         await _eventPublisher.PublishAsync(UserEventTypeEnum.Logout, _userManager);

Admin.NET/Admin.NET.Core/Service/User/IUserSessionExtProps.cs

@@ -0,0 +1,15 @@
+// Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
+//
+// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
+//
+// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
+
+namespace Admin.NET.Core;
+
+/// <summary>
+/// 用户Session属性扩展接口
+/// </summary>
+public interface IUserSessionExtProps
+{
+    Dictionary<string, object> GetInitExtProps(SysUser user);
+}

Admin.NET/Admin.NET.Core/Service/User/UserManager.cs

@@ -4,6 +4,8 @@
 //
 // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！
 
+using System.Text.Json;
+
 namespace Admin.NET.Core;
 
 /// <summary>
@@ -18,14 +20,14 @@ public class UserManager(
     /// </summary>
     [System.Text.Json.Serialization.JsonIgnore]
     [Newtonsoft.Json.JsonIgnore]
-    private UserSessionDao Session { get; set; }
+    protected virtual UserSessionDao _session { get; set; }
 
     /// <summary>
     /// 代理对象
     /// </summary>
     [System.Text.Json.Serialization.JsonIgnore]
     [Newtonsoft.Json.JsonIgnore]
-    protected UserSessionDao session => Session ??= sysCacheService.Get<UserSessionDao>(CacheConst.KeyUserSession + UserId);
+    protected virtual UserSessionDao Session => _session ??= sysCacheService.Get<UserSessionDao>(CacheConst.KeyUserSession + UserId);
 
     /// <summary>
     /// 用户Id
@@ -37,62 +39,67 @@ public class UserManager(
     /// <summary>
     /// 应用Id
     /// </summary>
-    public override long? AppId => session?.AppId;
+    public override long? AppId => Session?.AppId;
 
     /// <summary>
     /// 租户Id
     /// </summary>
-    public override long? TenantId => session?.TenantId;
+    public override long? TenantId => Session?.TenantId;
 
     /// <summary>
     /// 用户账号
     /// </summary>
-    public override string Account => session?.Account;
+    public override string Account => Session?.Account;
 
     /// <summary>
     /// 真实姓名
     /// </summary>
-    public override string RealName => session?.RealName;
+    public override string RealName => Session?.RealName;
 
     /// <summary>
     /// 昵称
     /// </summary>
-    public override string NickName => session?.NickName;
+    public override string NickName => Session?.NickName;
 
     /// <summary>
     /// 账号类型
     /// </summary>
-    public override AccountTypeEnum? AccountType => session?.AccountType;
+    public override AccountTypeEnum? AccountType => Session?.AccountType;
 
     /// <summary>
     /// 组织机构Id
     /// </summary>
-    public override long OrgId => session?.OrgId ?? 0;
+    public override long OrgId => Session?.OrgId ?? 0;
 
     /// <summary>
     /// 组织机构名称
     /// </summary>
-    public override string OrgName => session?.OrgName;
+    public override string OrgName => Session?.OrgName;
 
     /// <summary>
     /// 组织机构Id
     /// </summary>
-    public override string OrgType => session?.OrgType;
+    public override string OrgType => Session?.OrgType;
 
     /// <summary>
     /// 组织机构级别
     /// </summary>
-    public override int? OrgLevel => session?.OrgLevel;
+    public override int? OrgLevel => Session?.OrgLevel;
 
     /// <summary>
     /// 登录模式
     /// </summary>
-    public override LoginModeEnum? LoginMode => session?.LoginMode;
+    public override LoginModeEnum? LoginMode => Session?.LoginMode;
 
     /// <summary>
     /// 微信OpenId
     /// </summary>
-    public override string OpenId => session?.OpenId;
+    public override string OpenId => Session?.OpenId;
+
+    /// <summary>
+    /// 扩展属性
+    /// </summary>
+    public override Dictionary<string, dynamic> ExtProps => Session?.ExtProps;
 
     /// <summary>
     /// 用户Session是否存在
@@ -125,4 +132,21 @@ public class UserManager(
     {
         return sysCacheService.Get<UserSessionDao>(CacheConst.KeyUserSession + userId);
     }
+
+    /// <summary>
+    /// 获取扩展属性
+    /// </summary>
+    public T GetExtProp<T>(string key, T defaultValue = default)
+    {
+        if (ExtProps == null || !ExtProps.TryGetValue(key, out var value) || value is null) return defaultValue;
+        if (value is JsonElement element) return element.Deserialize<T>();
+        try
+        {
+            return (T)Convert.ChangeType(value, typeof(T));
+        }
+        catch
+        {
+            return defaultValue;
+        }
+    }
 }

Admin.NET/Admin.NET.Core/Service/User/UserSessionDao.cs

@@ -65,6 +65,11 @@ public partial class UserSessionDao
     /// </summary>
     public virtual long OrgId { get; set; }
 
+    /// <summary>
+    /// 组织机构编码
+    /// </summary>
+    public virtual string OrgCode { get; set; }
+
     /// <summary>
     /// 组织机构名称
     /// </summary>
@@ -94,4 +99,9 @@ public partial class UserSessionDao
     /// token版本
     /// </summary>
     public virtual long TokenVersion { get; set; }
+
+    /// <summary>
+    /// 扩展属性
+    /// </summary>
+    public virtual Dictionary<string, object> ExtProps { get; set; }
 }

Admin.NET/Admin.NET.Web.Core/Handlers/JwtHandler.cs

@@ -62,7 +62,7 @@ namespace Admin.NET.Web.Core
             // 验证Token黑名单
             var userId = httpContext.User.FindFirst(ClaimConst.UserId)?.Value;
             var version = httpContext.User.FindFirst(ClaimConst.TokenVersion)?.Value;
-            if (sysCacheService.ExistKey($"{CacheConst.KeyTokenBlacklist}:{userId}:{version}") || !sysCacheService.ExistKey($"{CacheConst.KeyUserSession}{userId}"))
+            if (sysCacheService.ExistKey($"{CacheConst.KeyTokenBlacklist}{userId}:{version}") || !sysCacheService.ExistKey($"{CacheConst.KeyUserSession}{userId}"))
             {
                 context.Fail(new AuthorizationFailureReason(this, "令牌已失效，请重新登录。"));
                 context.StatusCode(StatusCodes.Status401Unauthorized);