如何为ODataConventionModelBuilder动态添加EntitySets？

我之前在开发动态OData服务时正好碰到过类似的场景，给你几个可行的思路来解决这个问题：

方案一：用ODataConventionModelBuilder动态注册 #

ODataConventionModelBuilder本身就支持动态添加实体类型，你拿到外部程序集的类型后，直接遍历注册就行，还能顺便处理主键配置：

• 先收集好你需要注册的外部实体类型集合，比如IEnumerable<Type> externalEntityTypes
• 遍历这些类型，调用EntitySet方法注册，同时可以手动指定主键（如果外部类型没标记[Key]特性的话）

var modelBuilder = new ODataConventionModelBuilder();

foreach (var entityType in externalEntityTypes)
{
    // 先配置实体的主键（如果类型本身没加[Key]特性）
    var entityConfig = modelBuilder.Entity(entityType);
    // 这里假设主键属性叫Id，你可以根据实际情况调整，或者用反射自动识别
    var keyProp = entityType.GetProperty("Id");
    if (keyProp != null)
    {
        entityConfig.HasKey(keyProp);
    }

    // 注册EntitySet，名称用类型的复数形式（也可以自定义）
    var entitySetName = $"{entityType.Name}s";
    modelBuilder.EntitySet(entityType, entitySetName);
}

// 生成最终的Edm模型
var edmModel = modelBuilder.GetEdmModel();

方案二：用通用控制器处理动态EntitySet的请求 #

注册完模型后，你还需要对应的控制器来处理请求。不用每个实体都写一个控制器，写个泛型控制器就能搞定所有动态实体：

首先创建通用控制器：

public class GenericODataController<T> : ODataController
{
    // 注入你的数据访问服务，比如泛型仓储
    private readonly IGenericRepository<T> _repo;

    public GenericODataController(IGenericRepository<T> repo)
    {
        _repo = repo;
    }

    [EnableQuery]
    public IQueryable<T> Get()
    {
        return _repo.GetAll();
    }

    // 可以按需添加GetById、Post、Put等OData标准动作
    public ActionResult<T> Get([FromODataUri] int key)
    {
        var entity = _repo.GetById(key);
        if (entity == null) return NotFound();
        return entity;
    }
}

然后在路由配置里动态给每个EntitySet映射这个泛型控制器：

public static IEndpointRouteBuilder MapDynamicODataRoutes(this IEndpointRouteBuilder endpoints, IEdmModel edmModel)
{
    foreach (var entitySet in edmModel.EntityContainer.EntitySets())
    {
        var entityType = entitySet.EntityType();
        // 生成泛型控制器的具体类型
        var controllerType = typeof(GenericODataController<>).MakeGenericType(entityType);
        
        // 注册OData路由
        endpoints.MapODataRoute(
            routeName: $"OData_{entitySet.Name}",
            routePrefix: $"odata/{entitySet.Name}",
            model: edmModel,
            configureAction: builder =>
            {
                // 指定控制器名称（去掉末尾的Controller后缀）
                builder.Controller(controllerType.Name.Replace("Controller", ""));
            });
    }
    return endpoints;
}

别忘了在DI容器里注册泛型仓储：

services.AddScoped(typeof(IGenericRepository<>), typeof(GenericRepository<>));

方案三：手动构建Edm模型（更灵活） #

如果自动约定不符合你的需求，比如要自定义命名空间、处理复杂类型或导航属性，那可以手动构建Edm模型：

var edmModel = new EdmModel();
// 创建实体容器
var entityContainer = new EdmEntityContainer("YourApp.Namespace", "ODataContainer");
edmModel.AddElement(entityContainer);

foreach (var entityType in externalEntityTypes)
{
    // 创建Edm实体类型
    var edmEntityType = new EdmEntityType("YourApp.ExternalEntities", entityType.Name);
    
    // 添加实体属性（这里只处理基础类型属性，复杂类型可以额外处理）
    foreach (var prop in entityType.GetProperties(BindingFlags.Public | BindingFlags.Instance))
    {
        var edmPrimitiveType = EdmPrimitiveTypeKindExtensions.GetEdmPrimitiveTypeKind(prop.PropertyType);
        if (edmPrimitiveType != EdmPrimitiveTypeKind.None)
        {
            edmEntityType.AddStructuralProperty(prop.Name, edmPrimitiveType);
        }
    }
    
    // 设置主键
    var keyProp = entityType.GetProperty("Id");
    if (keyProp != null)
    {
        var edmKeyProp = edmEntityType.FindProperty(keyProp.Name);
        if (edmKeyProp != null)
        {
            edmEntityType.AddKeys(edmKeyProp);
        }
    }
    
    edmModel.AddElement(edmEntityType);
    
    // 添加EntitySet到容器
    entityContainer.AddEntitySet($"{entityType.Name}s", edmEntityType);
}

几个注意点 #

• 确保外部程序集的类型是public的，属性也是公共可访问的
• 如果有导航属性，需要在模型构建时手动配置关联关系（比如用modelBuilder.Entity(entityType).HasMany(...)）
• 泛型控制器的DI注册要正确，否则会出现找不到服务的错误

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