问题描述

如何将实体发布到OData终结点，同时将其与正文中的其他现有实体关联？

考虑以下类结构(示例)：

class Invoice
{
    public int Id { get; set; }

    public Person Issuer { get; set; }

    public Person Recipient { get; set; }

    // other properties
}

class Person
{
    public int Id { get; set; }

    // other properties
}

• GET http://host/odata/People(1)

  返回PersonId = 1

• GET http://host/odata/Invoices(2)?$expand='Issuer, Recipient'

  返回Invoice，其中Id = 2和Issuer和Recipient都在有效负载中展开

现在考虑以下要求：

我要在系统中创建新发票，该发票将与现有的开票人和收件人相关联

理想情况下，我希望帖子正文如下所示：

• POST http://host/odata/Invoices

  { "Issuer"："/odata/People(1)"， "Recipient"："/odata/People(2)"， "Property1"："omeValue"， "Property2"："100"， ..。 )

一旦服务器收到此负载，它应该：

1. 加载Issuer属性所需的"People(1)"Person。如果不存在，则应返回错误请求。
2. 加载Recipient属性所需的"People(2)"Person。如果不存在，则应返回错误请求。
3. 新建Invoice实例，并从上面分配Issuer和Recipient，然后将其保存到数据库。

1. POST http://host/odata/Invoices

   { "Property1": "someValue", "Property2": "100" }

2. PUT http://host/odata/Invoices(x)/Issuer/$ref

   {"@odata.id":"http://host/odata/People(1)"}

3. PUT http://host/odata/Invoices(x)/Recipient/$ref

   {"@odata.id":"http://host/odata/People(2)"}

   /li>

但是，我希望能够在应该自动创建实例的单个POST操作中执行所有这些操作。

我尝试了一些想法，看看服务器会接受什么，这似乎成功了：

{
    "Issuer": { "@odata.id": "/odata/People(1)" },
    "Recipient": { "@odata.id": "/odata/People(2)" },
    "Property1": "someValue",
    "Property2": "100",
    ...
}

但我不知道如何从中读取/解析ID(就像在专用的Ref方法中是如何完成的)，或者即使OData标准支持这一点。

目前，我将求助于仅在模型和服务器中传递ID属性，假设这将始终意味着现有的关系，但这并不理想，因为它不够通用，并且会使我的API缺乏灵活性。

推荐答案

最简单的解决方案是直接公开模型中的ForeignKey属性。即使在MS文档Entity Relations in OData v4 Using ASP.NET Web API 2.2解释$ref中使用的模型也会暴露FK。

class Invoice
{
    public int Id { get; set; }

    public int Issuer_Person_Id { get; set; }
    [ForeignKey(nameof(Issuer_Person_Id)]
    public Person Issuer { get; set; }

    public int Recipient_Person_Id { get; set; }
    [ForeignKey(nameof(Recipient_Person_Id)]
    public Person Recipient { get; set; }

    // other properties
}

这不会使您的API僵化，而是使您的API更灵活。 这还使您可以更好地控制模型的数据库实现，同时仍不依赖于数据库引擎。

在启用延迟加载的环境中，如果您需要检查相关实体是否存在而无需将其加载到内存中，则包括FK具有一些额外的性能优势。

注意：通过将FK包含在模型中，$ref语法和批处理仍然可以使用，但我们现在可以访问更实用的FK ID值，这些值可以在服务器端代码中轻松验证，就像更容易发送值一样。

现在，在PATCH或POST中，我们可以直接使用ID链接Person记录。

要实现这一点，客户端和服务器端都需要相同级别的信息/理解，因此仍然是通用，$metadata文档全面描述了哪些FK字段链接了相关实体，但此处演示的良好命名约定可以帮助

{
    "Issuer_Person_Id": 1,
    "Recipient_Person_Id": 2,
    "Property1": "someValue",
    "Property2": "100",
    ...
}

小心：
许多模型设计器选择不是来公开ForeignKey属性的原因之一是，当您尝试同时发送或处理ForeignKey和相关实体时，存在歧义。
对于PATCH没有念力，V4.0规范专门告诉USE忽略相关实体，根本不应该发送。

11.4.3 Update an Entity
如果更新既指定了对单值导航属性的绑定，又指定了根据同一导航属性绑定到主体实体的键属性的Dependent属性，则将忽略Dependent属性，并根据绑定中指定的值更新关系。

对于POST但是，如果请求和FK中都提供了相关实体，则假定相关实体是深度插入，忽略FK。

11.4.2.2 Create Related Entities when Creating an Entity
每个包含的相关实体都遵循创建实体的规则进行处理，就像它是根据原始目标URL发布的一样，该原始目标URL使用指向此相关实体的导航路径扩展。

启用FKS后，我的建议是在客户端采取措施，以确保您不会尝试将请求中的FK和相关实体发回API。

我同意您建议的POST中的@odata.id是一个合乎逻辑的结论，但是它引发了其他潜在的实现问题，这就是协议提供针对表示ForeignKey引用的$ref端点的直接CRUD操作的概念的原因。

{
    "@type":"#container.Invoice",
    "Issuer": { "@id": "People(1)" },
    "Recipient": { "@id": "People(2)" },
    "Property1": "someValue",
    "Property2": "100",
    ...
}