.NET Core 2.0自定义认证：如何将已登录用户ID传递至控制器

你现在的代码问题在于创建AuthenticationTicket时，传入的ClaimsPrincipal是空的，没有包含任何用户身份信息，所以控制器里自然拿不到用户ID。咱们只需要把验证得到的用户ID包装成Claim，添加到身份标识中，就能让控制器通过User对象访问到它了。

步骤1：修改HandleAuthenticateAsync方法，添加用户ID的Claim #

首先，当你通过AuthService拿到userId后，要创建一个包含该用户ID的ClaimsIdentity，再用它构建ClaimsPrincipal。这里推荐使用标准的ClaimTypes.NameIdentifier作为Claim类型，当然你也可以自定义类型（比如"UserId"），只要前后保持一致就行。

修改后的完整代码如下：

protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
{
    // 先检查Authorization头是否存在
    if (!Request.Headers.TryGetValue("Authorization", out var tokenHeaderValues))
    {
        return AuthenticateResult.Fail("Authorization header is missing");
    }

    string token = tokenHeaderValues.FirstOrDefault();
    if (string.IsNullOrEmpty(token))
    {
        return AuthenticateResult.Fail("Token is empty");
    }

    try
    {
        // 调用认证服务获取用户ID
        int userId = AuthService(token);

        // 创建包含用户ID的Claim集合
        var claims = new List<Claim>
        {
            new Claim(ClaimTypes.NameIdentifier, userId.ToString())
            // 如果需要，还可以添加其他用户信息，比如用户名、角色等
            // new Claim(ClaimTypes.Name, "username"),
            // new Claim(ClaimTypes.Role, "Admin")
        };

        // 创建ClaimsIdentity，指定认证方案名称
        var identity = new ClaimsIdentity(claims, Scheme.Name);

        // 构建ClaimsPrincipal
        var principal = new ClaimsPrincipal(identity);

        // 返回成功的认证票据
        return AuthenticateResult.Success(new AuthenticationTicket(principal, Scheme.Name));
    }
    catch (Exception ex)
    {
        // 捕获认证过程中的异常，返回失败信息
        return AuthenticateResult.Fail($"Token validation failed: {ex.Message}");
    }
}

步骤2：在控制器中获取用户ID #

修改完认证逻辑后，在标记了[Authorize]的控制器Action里，你可以通过User对象直接读取Claim：

[Authorize]
[ApiController]
[Route("api/[controller]")]
public class UserController : ControllerBase
{
    [HttpGet("profile")]
    public IActionResult GetUserProfile()
    {
        // 获取用户ID的Claim
        var userIdClaim = User.Claims.FirstOrDefault(c => c.Type == ClaimTypes.NameIdentifier);
        
        if (userIdClaim == null)
        {
            return BadRequest("User ID not found in claims");
        }

        // 转换为int类型
        if (!int.TryParse(userIdClaim.Value, out int userId))
        {
            return BadRequest("Invalid user ID format");
        }

        // 这里就可以用userId做后续业务逻辑了
        return Ok(new { UserId = userId });
    }
}

优化：添加扩展方法简化获取 #

为了避免重复代码，你可以写一个扩展方法，让获取用户ID更便捷：

public static class ClaimsPrincipalExtensions
{
    public static int GetUserId(this ClaimsPrincipal principal)
    {
        var userIdClaim = principal.Claims.FirstOrDefault(c => c.Type == ClaimTypes.NameIdentifier);
        if (userIdClaim == null || !int.TryParse(userIdClaim.Value, out int userId))
        {
            throw new InvalidOperationException("User ID is missing or invalid in claims");
        }
        return userId;
    }
}

之后在控制器里就能一行代码搞定：

var userId = User.GetUserId();

注意事项 #

• 确保AuthService方法在令牌无效时抛出异常或者返回合理的错误，这样认证逻辑能正确返回失败结果。
• Scheme.Name要和你在Startup.cs中注册自定义认证方案时的名称一致，否则认证上下文可能无法正确识别。
• 如果需要传递更多用户信息（比如用户名、角色），只需要在Claim集合中添加对应的Claim即可。

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