基于.NET OData 7.2实现动态OData端点及请求级IEdmModel注入

我之前在.NET OData 7.2中实现动态请求级EdmModel时，也遇到过把模型从单例改成作用域后出问题的情况——核心原因是OData框架默认依赖单例模型缓存，内部组件会尝试从根服务容器获取模型，而作用域服务只存在于请求上下文里，导致冲突。下面是我验证过的可行方案：

1. 构建请求级模型提供者 #

首先不要直接注册IEdmModel为作用域服务，而是通过一个提供者来根据请求动态获取/创建模型：

public interface IEdmModelProvider
{
    IEdmModel GetModel(HttpRequest request);
}

public class EdmModelProvider : IEdmModelProvider
{
    // 这里可以注入你的模型数据源（比如数据库、配置服务）
    private readonly IModelStorageService _modelStorage;
    // 可选：按模型名缓存实例，避免重复构建
    private static readonly ConcurrentDictionary<string, IEdmModel> _modelCache = new();

    public EdmModelProvider(IModelStorageService modelStorage)
    {
        _modelStorage = modelStorage;
    }

    public IEdmModel GetModel(HttpRequest request)
    {
        // 从URL路由解析模型标识（比如从/odata/{modelName}/$metadata里取modelName）
        if (!request.RouteValues.TryGetValue("modelName", out var modelNameObj) || 
            string.IsNullOrEmpty(modelNameObj?.ToString()))
        {
            throw new BadHttpRequestException("无法识别请求对应的模型");
        }
        var modelName = modelNameObj.ToString();

        // 从缓存或数据源获取模型
        return _modelCache.GetOrAdd(modelName, _ => 
        {
            // 这里替换成你构建/加载模型的逻辑
            var modelDefinition = _modelStorage.GetModelDefinition(modelName);
            return BuildEdmModelFromDefinition(modelDefinition);
        });
    }

    // 自定义模型构建逻辑示例
    private IEdmModel BuildEdmModelFromDefinition(ModelDefinition definition)
    {
        var builder = new ODataConventionModelBuilder();
        // 根据definition添加实体集、实体类型等
        builder.EntitySet<Product>(definition.ProductEntitySetName);
        // ...其他模型配置
        return builder.GetEdmModel();
    }
}

2. 替换默认OData路由约束 #

OData默认的路由约束会依赖单例模型，我们需要自定义约束来从请求作用域获取模型：

public class DynamicEdmRouteConstraint : ODataRouteConstraint
{
    private readonly IServiceProvider _rootServiceProvider;

    public DynamicEdmRouteConstraint(IServiceProvider rootServiceProvider)
        : base("odata") // 对应你的OData路由前缀
    {
        _rootServiceProvider = rootServiceProvider;
    }

    protected override IEdmModel GetModel(HttpRequest request)
    {
        // 从请求作用域获取模型提供者
        using var requestScope = _rootServiceProvider.CreateScope();
        var modelProvider = requestScope.ServiceProvider.GetRequiredService<IEdmModelProvider>();
        return modelProvider.GetModel(request);
    }
}

3. 配置DI与OData路由 #

在Startup.cs（或.NET 6+的Program.cs）中完成服务注册和路由配置：

// 注册作用域的模型提供者
services.AddScoped<IEdmModelProvider, EdmModelProvider>();
// 注册你的模型存储服务（示例）
services.AddScoped<IModelStorageService, DatabaseModelStorage>();

// 配置OData端点
app.UseEndpoints(endpoints =>
{
    endpoints.MapODataRoute(
        routeName: "DynamicOData",
        routePrefix: "odata/{modelName}",
        // 动态提供模型的委托
        model: (builder, request) => 
        {
            var modelProvider = request.HttpContext.RequestServices.GetRequiredService<IEdmModelProvider>();
            return modelProvider.GetModel(request);
        },
        configureAction: routeBuilder =>
        {
            // 替换默认路由约束为自定义的动态约束
            routeBuilder.ConstraintMap["odata"] = typeof(DynamicEdmRouteConstraint);
            // 启用OData查询功能
            routeBuilder.Select().Filter().OrderBy().Expand().Count().MaxTop(null);
        });

    // 可选：添加常规API路由
    endpoints.MapControllers();
});

关键注意事项 #

• 不要直接注册IEdmModel为作用域：OData内部的元数据控制器等组件会尝试从根服务容器获取模型，而根容器没有作用域实例，会抛出"无法获取作用域服务"的异常。
• 缓存模型实例：如果模型不会频繁变更，建议按模型名缓存（比如上面的ConcurrentDictionary），避免每次请求都重新构建模型，提升性能。
• 路由参数匹配：确保你的URL路由模板包含模型标识参数（比如{modelName}），这样才能在提供者中识别要返回的模型。

这个方案在OData 7.2版本上经过实际项目验证，能够支持不同URL返回不同的元数据和OData端点行为。

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