ASP.NET Core OData 8.x如何实现/me别名映射到/users/<用户ID>

不需要单独创建MeController或注册me单例，直接通过路由重写中间件将/me开头的请求转发到/users/{当前用户ID}，完全复用现有UsersController的所有逻辑，同时从JWT中自动获取用户ID。

实现步骤 #

1. 编写路由重写中间件 #

创建中间件拦截/me开头的请求，替换为对应/users/{userId}的路径：

public class MeRouteRewriterMiddleware
{
    private readonly RequestDelegate _next;

    public MeRouteRewriterMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        var requestPath = context.Request.Path.Value;
        if (requestPath.StartsWith("/me", StringComparison.OrdinalIgnoreCase))
        {
            // 从JWT Claims读取用户ID，根据你的JWT配置调整Claim类型
            var userId = context.User.FindFirstValue(ClaimTypes.NameIdentifier) 
                         ?? context.User.FindFirstValue("sub");
            
            if (string.IsNullOrEmpty(userId))
            {
                context.Response.StatusCode = StatusCodes.Status401Unauthorized;
                return;
            }

            // 替换/me为/users/{userId}
            var rewrittenPath = requestPath.Replace("/me", $"/users/{userId}", StringComparison.OrdinalIgnoreCase);
            context.Request.Path = rewrittenPath;
        }

        await _next(context);
    }
}

// 扩展方法方便注册
public static class MeRouteRewriterExtensions
{
    public static IApplicationBuilder UseMeRouteRewriter(this IApplicationBuilder app)
    {
        return app.UseMiddleware<MeRouteRewriterMiddleware>();
    }
}

2. 注册中间件 #

在Program.cs中，将该中间件注册在OData路由之前（必须在UseRouting之后、UseEndpoints之前，且在认证中间件之后）：

var app = builder.Build();

// 先启用认证、授权
app.UseAuthentication();
app.UseAuthorization();

// 注册/me路由重写中间件
app.UseMeRouteRewriter();

// 配置OData路由
app.UseRouting();

app.UseEndpoints(endpoints =>
{
    endpoints.MapODataRoute("odata", "odata", GetEdmModel());
    // 其他端点配置...
});

3. 复用现有UsersController #

确保你的UsersController已经实现了所需的OData方法，比如获取用户、获取用户的日历组等：

[Authorize]
[EnableQuery]
public class UsersController : ODataController
{
    private readonly AppDbContext _dbContext;

    public UsersController(AppDbContext dbContext)
    {
        _dbContext = dbContext;
    }

    // 获取当前用户详情（对应/me）
    public async Task<IActionResult> Get([FromODataUri] string key)
    {
        var user = await _dbContext.Users
            .Include(u => u.CalendarGroups)
            .FirstOrDefaultAsync(u => u.Id == key);
        
        return user == null ? NotFound() : Ok(user);
    }

    // 获取当前用户的日历组（对应/me/calendarGroups）
    [EnableQuery]
    public async Task<IActionResult> GetCalendarGroups([FromODataUri] string key)
    {
        var user = await _dbContext.Users
            .Include(u => u.CalendarGroups)
            .FirstOrDefaultAsync(u => u.Id == key);
        
        return user == null ? NotFound() : Ok(user.CalendarGroups);
    }

    // 其他Users相关的OData方法（如更新、关联资源等）直接复用即可
}

4. 清理旧代码 #

删除之前创建的MeController和Edm模型中的edmBuilder.Singleton<Me>("me");注册，因为不再需要单独的me实体和控制器。

关键注意事项 #

• JWT Claim配置：确保你的JWT Token中包含用户ID的Claim（比如sub或nameidentifier），如果使用自定义Claim类型，需要修改中间件中的Claim名称。
• 路由顺序：中间件必须在UseEndpoints之前注册，且在UseAuthentication之后，这样才能正确获取已认证用户的Claims。
• 权限控制：在UsersController上添加[Authorize]属性，确保只有认证用户能访问/me相关路径，同时可以添加角色/策略授权进一步限制访问。

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