基于OpenIddict 2.0的授权服务器添加自定义Claim并保存至AspNetUserClaims表

嘿，看起来你已经在自定义OpenIddict的Claims路上走了一大步！既然已经实现了CustomUserClaimsPrincipalFactory，那把自定义Claim保存到AspNetUserClaims表其实很简单，我给你拆解成几个关键步骤：

1. 核心：用UserManager将Claim写入数据库 #

AspNetUserClaims是Identity框架专门存储用户Claims的表，要往里面写数据，直接用Identity提供的UserManager.AddClaimAsync方法就可以了——这个方法会自动帮你处理数据库操作，不用手动写SQL。

举个实际的代码例子，比如在用户注册、更新信息或者后台管理时添加Claim：

// 注入UserManager<ApplicationUser>到你的服务/控制器中
private readonly UserManager<ApplicationUser> _userManager;

public YourService(UserManager<ApplicationUser> userManager)
{
    _userManager = userManager;
}

public async Task AddCustomClaimToUser(string userId, string claimType, string claimValue)
{
    var user = await _userManager.FindByIdAsync(userId);
    if (user == null)
    {
        // 处理用户不存在的情况
        return;
    }

    // 添加自定义Claim到AspNetUserClaims表
    var result = await _userManager.AddClaimAsync(user, new Claim(claimType, claimValue));
    
    if (result.Succeeded)
    {
        // 添加成功，Claim已经持久化到数据库了
    }
    else
    {
        // 处理添加失败的情况，比如重复添加同一个Claim
        foreach (var error in result.Errors)
        {
            // 记录错误日志或者返回错误信息
        }
    }
}

2. 确保CustomUserClaimsPrincipalFactory能读取这些持久化的Claim #

其实你不用额外写代码来读取AspNetUserClaims里的Claim——因为你继承的UserClaimsPrincipalFactory基类已经自动帮你做了这件事！它会在创建ClaimsPrincipal的时候，把数据库里的所有用户Claim都加载进去。

当然，如果你还想从用户的其他属性（比如ApplicationUser里的自定义字段NickName）动态生成Claim，那可以在你的Factory里重写CreateAsync方法：

public class CustomUserClaimsPrincipalFactory : UserClaimsPrincipalFactory<ApplicationUser, IdentityRole>
{
    public CustomUserClaimsPrincipalFactory(
        UserManager<ApplicationUser> userManager,
        RoleManager<IdentityRole> roleManager,
        IOptions<IdentityOptions> optionsAccessor)
        : base(userManager, roleManager, optionsAccessor)
    {
    }

    public override async Task<ClaimsPrincipal> CreateAsync(ApplicationUser user)
    {
        // 先调用基类方法，加载默认Claims（包括AspNetUserClaims里的所有Claim）
        var principal = await base.CreateAsync(user);
        
        // 这里可以添加动态生成的Claim（比如从用户实体的字段直接生成）
        if (!string.IsNullOrEmpty(user.NickName))
        {
            ((ClaimsIdentity)principal.Identity).AddClaim(new Claim("NickName", user.NickName));
        }

        // 如果想把这个动态生成的Claim也持久化到AspNetUserClaims表，
        // 只需要在合适的时机（比如用户更新NickName时）调用上面的AddCustomClaimToUser方法即可

        return principal;
    }
}

3. 注册你的CustomUserClaimsPrincipalFactory到DI容器 #

最后别忘了把你的自定义Factory注册到依赖注入容器里，让Identity框架使用它来生成ClaimsPrincipal：

// 在Program.cs或者Startup.cs的服务配置中
services.AddScoped<IUserClaimsPrincipalFactory<ApplicationUser>, CustomUserClaimsPrincipalFactory>();

补充：自动添加Claim的场景 #

如果想在用户创建时自动添加某些固定的自定义Claim，比如用户注册完成后就给他加上FullName，可以在注册逻辑里直接调用AddClaimAsync：

// 用户注册示例
var newUser = new ApplicationUser 
{ 
    UserName = "jane@example.com", 
    Email = "jane@example.com",
    FullName = "Jane Smith"
};

var createResult = await _userManager.CreateAsync(newUser, "StrongPassword123!");
if (createResult.Succeeded)
{
    // 自动添加自定义Claim到数据库
    await _userManager.AddClaimAsync(newUser, new Claim("FullName", newUser.FullName));
}

这样一来，你的自定义Claim既会被持久化到AspNetUserClaims表，又会在生成ClaimsPrincipal的时候被加载到用户身份信息里，完美适配OpenIddict的授权流程～

内容的提问来源于stack exchange，提问作者Set