OData控制器未返回关联表数据的问题解决请求

核心原因 #

OData默认不会自动序列化并返回导航属性（关联数据），即使EF通过Include/ThenInclude加载了数据，也需要在EDM模型中配置导航关系，并且通过请求参数或控制器配置来触发展开。

具体解决步骤 #

1. 正确配置OData EDM模型 #

确保在构建EDM模型时，显式注册所有实体及它们的导航关系，OData才能识别并处理这些关联属性。

示例代码（通常在Program.cs或专门的模型配置类中）：

public static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    
    // 注册实体集
    builder.EntitySet<Account>("Accounts");
    builder.EntitySet<Relation>("Relations");
    builder.EntitySet<Role>("Roles");

    // 配置Account与Relation的一对多关系
    var accountEntity = builder.EntityType<Account>();
    accountEntity.HasMany(a => a.Relations)
                 .WithRequired() // 根据实际数据库关系调整（比如是否可选）
                 .HasForeignKey(r => r.AccountID);

    // 配置Relation与Role的多对一关系
    var relationEntity = builder.EntityType<Relation>();
    relationEntity.HasOne(r => r.Role)
                  .WithMany() // 如果Role没有反向导航属性则用WithMany()
                  .HasForeignKey(r => r.RoleID);

    return builder.GetEdmModel();
}

2. 客户端请求时使用$expand参数 #

OData需要通过$expand参数明确指定要展开的导航属性，才能返回关联数据。示例请求URL：

GET https://localhost:44393/DS/Accounts?$expand=Relations($expand=Role)

• $expand=Relations：展开Account的Relations集合
• ($expand=Role)：嵌套展开Relation的Role属性

3. 配置控制器允许展开查询（可选） #

如果需要确保客户端可以使用$expand，需要在[EnableQuery]特性中允许该查询选项：

[EnableQuery(PageSize = 15, AllowedQueryOptions = AllowedQueryOptions.Expand | AllowedQueryOptions.Count | AllowedQueryOptions.Top | AllowedQueryOptions.Skip)]
public IQueryable<Account> Get()
{
    return _context.accounts
            .Include(e => e.Relations)
                .ThenInclude(e => e.Role);
}

如果希望默认自动返回关联数据（无需客户端加$expand），可以在返回时手动构造包含导航属性的对象，或者使用OData的Expand方法：

public IQueryable<Account> Get()
{
    return _context.accounts
        .Include(e => e.Relations)
            .ThenInclude(e => e.Role)
        .AsQueryable()
        .Expand("Relations/Role");
}

4. 检查Json序列化配置 #

确保序列化器不会忽略导航属性或因循环引用导致数据被过滤。以Program.cs为例：

使用System.Text.Json：

builder.Services.AddControllers()
    .AddOData(options => 
        options.Select().Filter().OrderBy().Expand().Count().SetMaxTop(100)
               .AddRouteComponents("DS", GetEdmModel()))
    .AddJsonOptions(options =>
    {
        // 处理可能的循环引用（如果存在）
        options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
        // 确保公共属性被序列化
        options.JsonSerializerOptions.PropertyNameCaseInsensitive = true;
    });

使用Newtonsoft.Json：

builder.Services.AddControllers()
    .AddOData(options => 
        options.Select().Filter().OrderBy().Expand().Count().SetMaxTop(100)
               .AddRouteComponents("DS", GetEdmModel()))
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;
        options.SerializerSettings.PreserveReferencesHandling = PreserveReferencesHandling.None;
    });

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