ASP.NET Boilerplate 中实现自定义会话字段的技术方案

背景介绍

在ASP.NET Boilerplate框架中，开发者经常需要扩展用户会话信息，添加自定义字段以满足业务需求。本文介绍如何在用户登录过程中，通过查询字符串或表单数据获取额外信息，并将其添加到用户会话中。

核心问题分析

在标准的ASP.NET Core身份验证流程中，用户会话信息是通过ClaimsPrincipal来表示的。ASP.NET Boilerplate框架提供了扩展点，允许开发者在用户登录时添加自定义声明(Claim)。但实际业务中，我们经常需要从登录请求中获取额外参数（如公司ID），并将其作为会话信息的一部分。

解决方案设计

1. 创建公司ID解析器接口

首先在Core项目中定义一个解析器接口，用于抽象获取公司ID的逻辑：

public interface IUserCompanyResolver
{
    string GetCompanyIdFromLogin();
}

2. 实现查询字符串解析器

在Web项目中实现具体的解析逻辑，从HTTP请求中获取公司ID：

public class QueryStringUserCompanyResolver : IUserCompanyResolver
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public QueryStringUserCompanyResolver(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public string GetCompanyIdFromLogin()
    {
        string companyId = "";

        // 检查表单数据
        bool hasFormData = _httpContextAccessor.HttpContext.Request.HasFormContentType;
        if (hasFormData)
        {
            companyId = _httpContextAccessor.HttpContext.Request.Form["CompanyId"].ToString();
        }

        // 如果表单中没有，检查查询字符串
        if (string.IsNullOrEmpty(companyId))
        {
            IQueryCollection queryData = _httpContextAccessor.HttpContext.Request.Query;
            if (queryData.Count > 0)
            {
                companyId = _httpContextAccessor.HttpContext.Request.Query["CompanyId"].ToString();
            }
        }

        // 返回默认值或实际值
        return string.IsNullOrEmpty(companyId) ? "1" : companyId;
    }
}

3. 扩展用户声明工厂

在自定义的UserClaimsPrincipalFactory中使用解析器：

public override async Task<ClaimsPrincipal> CreateAsync(User user)
{
    // 获取公司ID
    int companyId = int.Parse(_userCompanyResolver.GetCompanyIdFromLogin());
    
    // 查询公司信息
    CompanyMaster company = _companyMaster.FirstOrDefault(x => 
        x.IsCurrentDBCompany && x.CompanyId == companyId);

    // 创建基础声明
    ClaimsPrincipal claim = await base.CreateAsync(user);

    // 添加自定义声明
    if (company != null)
    {
        claim.Identities.First().AddClaim(new Claim("CompanyId", companyId.ToString()));
        claim.Identities.First().AddClaim(new Claim("CompanyName", company.Name));
    }
    else
    {
        claim.Identities.First().AddClaim(new Claim("CompanyName", 
            "!!!...[CAN'T FIND A VALID COMPANY DATA! PLEASE CONTACT IT DEPT.]...!!!"));
        claim.Identities.First().AddClaim(new Claim("CompanyId", user.CompanyId.ToString()));
    }

    // 添加其他用户信息声明
    claim.Identities.First().AddClaim(new Claim("UserType", user.UserTypeId.ToString()));
    claim.Identities.First().AddClaim(new Claim("FullName", user.FullName));
    claim.Identities.First().AddClaim(new Claim("Designation", 
        user.Designation ?? "ABM User"));

    return claim;
}

实现要点

1. 依赖注入配置：需要在模块中注册IUserCompanyResolver和QueryStringUserCompanyResolver。

2. 请求数据来源：解决方案同时支持从查询字符串和表单数据中获取公司ID，提高了灵活性。

3. 默认值处理：当无法获取公司ID时，提供了默认值"1"，确保系统不会因为缺少参数而崩溃。

4. 声明类型安全：所有添加的声明都进行了类型转换和空值检查。

应用场景扩展

这种模式不仅适用于公司ID，还可以应用于：

• 多租户系统中的租户标识
• 用户选择的语言偏好
• 登录时的设备信息
• 业务特定的上下文信息

性能考虑

1. 尽量减少在声明工厂中的数据库查询，可以考虑使用缓存。
2. 对于频繁访问的声明信息，可以考虑存储在Session中而非每次从声明中解析。
3. 声明数量不宜过多，避免影响认证票据的大小。

总结

通过实现自定义的IUserCompanyResolver和扩展UserClaimsPrincipalFactory，我们可以在ASP.NET Boilerplate中灵活地添加会话自定义字段。这种设计遵循了开闭原则，核心认证逻辑与业务特定逻辑解耦，便于维护和扩展。开发者可以根据实际业务需求，调整解析逻辑和添加的声明内容。