ASP.NET Core Web API多表关联场景下OData的应用可行性问询

问题背景 #

我此前在单表场景下使用OData一切正常，示例代码如下：

public class Person
{
    [Key]
    public String ID { get; set; }
    [Required]
    public String Name { get; set; }
    public String Description { get; set; }
    public List<Trip> Trips { get; set; }
}

[EnableQuery]
public class PeopleController : ODataController
{
    public IHttpActionResult Get()
    {
        return Ok(DemoDataSources.Instance.People.AsQueryable());
    }
}

对应的OData查询示例：
http://domain/People?$select=Name
http://domain/People?$filter=Name eq 'Sam'

现在我需要在多表关联场景下使用OData，对应的固定SQL关联查询语句如下：

SELECT 
    p.id AS productId,
    pd.name AS productName,
    pd.job_number AS serialNumber
FROM 
    tbl_product p 
JOIN
    tbl_productDetails pd ON p.id = pd.id

我已参考过相关资源但未找到解决方案，想知道在此场景下是否可以应用OData，并且期望能实现和单表场景一致的filter、top、skip、select、orderBy等查询功能。

解决方案 #

当然可以在多表关联场景下使用OData，以下是具体实现步骤：

1. 定义关联结果实体类 #

创建一个对应关联查询输出的实体类，映射SQL返回的字段：

public class ProductWithDetails
{
    [Key]
    public int ProductId { get; set; }
    public string ProductName { get; set; }
    public string SerialNumber { get; set; }
}

2. 配置OData模型 #

在OData模型构建器中注册这个新实体：

public static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<ProductWithDetails>("ProductWithDetails");
    return builder.GetEdmModel();
}

3. 实现OData控制器 #

创建控制器并编写关联查询逻辑，确保返回IQueryable类型以支持OData查询解析：

[EnableQuery]
public class ProductWithDetailsController : ODataController
{
    private readonly YourDbContext _dbContext;

    public ProductWithDetailsController(YourDbContext dbContext)
    {
        _dbContext = dbContext;
    }

    public IHttpActionResult Get()
    {
        var query = from p in _dbContext.TblProduct
                    join pd in _dbContext.TblProductDetails on p.Id equals pd.Id
                    select new ProductWithDetails
                    {
                        ProductId = p.Id,
                        ProductName = pd.Name,
                        SerialNumber = pd.JobNumber
                    };

        return Ok(query.AsQueryable());
    }
}

4. 测试OData查询 #

完成配置后，即可像单表场景一样使用各类OData查询参数：

• 筛选：http://domain/ProductWithDetails?$filter=ProductName eq 'Laptop'
• 字段选择：http://domain/ProductWithDetails?$select=ProductId,SerialNumber
• 分页：http://domain/ProductWithDetails?$skip=10&$top=5
• 排序：http://domain/ProductWithDetails?$orderBy=ProductName desc

关键注意事项 #

• 必须返回IQueryable类型，这样[EnableQuery]特性才能将OData查询参数转换为对应的SQL语句，避免在内存中处理全量数据造成性能损耗。
• 若关联逻辑更复杂（如左连接、多条件关联），只需调整EF Core的查询语句即可，OData的查询特性会自动适配。

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