c# - OData 无法识别我的集合属性

标签 c# asp.net-web-api odata microsoft-odata

当我发布一个没有填充集合的 ShakeoutDocument 时,OData Serializer 理解 JSON 并填充 ODataActionParameters 正确。

但是,当我将子记录添加到 ShakeoutDocument 的 集合属性中时...Odata Controller 的 ODataActionParameters 参数为空.我已将其缩小到 OData EDM 模型配置

  • 我如何正确地将集合属性(如下)“特征化”到 EDM 模型配置

类看起来像:
藏品是细节和印章(下)

public class ShakeoutDocument : Document
{
    public IObjectState ObjectState { get; set; } //<-- This "registers" just fine?

    public int ShakeoutId { get; set; }

    public string SchedulingBatch { get; set; }

    public int? ProductId { get; set; }

    public decimal? Gravity { get; set; }

    public decimal? Temperature { get; set; }

    public decimal? SedimentAndWater { get; set; }

    public DateTime? BatchEndDate { get; set; }

    public DateTime? SampleWorkedDate { get; set; }

    public string Witness { get; set; }

    public string Notes { get; set; }

    public List<ShakeoutDetail> Details { get; set; } //<-- How do I "register" this?

    public List<ShakeoutSeal> Seals { get; set; } //<-- How do I "register" this?
}

我当前的 EDM 配置如下所示:
我尝试了定义的各种方法 HERE .奇怪的是...IObjectState 注册得很好。

private static  IEdmModel GetEdmModel()
{
    var modelBuilder = new ODataConventionModelBuilder();
    modelBuilder.Namespace = "Pulse";
    modelBuilder.ContainerName = "PulseContainer";

    // -------------------
    // ENTITY SETS: Normal
    modelBuilder.EntitySet<tblDbcCommunications>("Communication");
    modelBuilder.EntitySet<tblDbcItems>("Item");
    modelBuilder.EntitySet<Meter>("Meter");
    modelBuilder.EntitySet<Product>("Products");
    modelBuilder.EntitySet<WarehouseMeter>("WarehouseMeters");
    modelBuilder.EntitySet<tblDbcCircuitOwner>("tblDbcCircuitOwner");
    modelBuilder.EntitySet<ShakeoutDetail>("ShakeoutDetails");
    modelBuilder.EntitySet<ShakeoutSeal>("ShakeoutSeals");

    // --------------------
    // ENTITY SETS: Complicated
    ConfigureEntitySet(modelBuilder, modelBuilder.EntitySet<ShakeoutDocument>("ShakeoutDocuments"));

    // ------------
    // KEY BINDINGS: Non-Entity
    //
    // - This area is for DTO's (there is no EF Configuration for these)
    modelBuilder.EntityType<WarehouseMeter>().HasKey(x => x.METER_ID);

    // -----------------
    // UNBOUND FUNCTIONS
    //  - Action    = Post
    //  - Function  = Get

    //----
    // ShakeoutDocument
    var createShakeoutDocument = modelBuilder.Action("CreateShakeoutDocument").ReturnsFromEntitySet<ShakeoutDocument>("ShakeoutDocument");
    createShakeoutDocument.CollectionParameter<int>("identities");

    var deleteShakeoutDocument = modelBuilder.Action("DeleteShakeoutDocument").ReturnsFromEntitySet<ShakeoutDocument>("ShakeoutDocument");
    deleteShakeoutDocument.Parameter<int>("key");

    var getShakeoutDocument = modelBuilder.Function("GetShakeoutDocument").ReturnsFromEntitySet<ShakeoutDocument>("ShakeoutDocument");
    getShakeoutDocument.Parameter<int>("key");

    var saveShakeoutDocument = modelBuilder.Action("SaveShakeoutDocument").ReturnsFromEntitySet<ShakeoutDocument>("ShakeoutDocument");
    saveShakeoutDocument.Parameter<ShakeoutDocument>("document");

    //----
    // ShakeoutDetail
    var saveShakeoutDetail = modelBuilder.Action("SaveShakeoutDetail").ReturnsFromEntitySet<ShakeoutDetail>("ShakeoutDetail");
    saveShakeoutDetail.Parameter<ShakeoutDetail>("detail");

    //----
    // ShakeoutSeal
    var saveShakeoutSeal = modelBuilder.Action("SaveShakeoutSeal").ReturnsFromEntitySet<ShakeoutSeal>("ShakeoutSeal");
    saveShakeoutSeal.Parameter<ShakeoutSeal>("seal");

    //----
    // Product
    var listProduct = modelBuilder.Function("ListProducts").ReturnsCollectionFromEntitySet<Product>("Product");

    //----
    // WarehouseMeter
    var findPulseMeter = modelBuilder.Function("FindWarehouseMeter").ReturnsCollectionFromEntitySet<WarehouseMeter>("WarehouseMeter");
    findPulseMeter.Parameter<string>("search");

    return modelBuilder.GetEdmModel();
}

private static EntitySetConfiguration<ShakeoutDocument> ConfigureEntitySet(ODataConventionModelBuilder modelBuilder, EntitySetConfiguration<ShakeoutDocument> configuration)
{
    // ---------------------
    // Collection Properties

    // FAILS: Meaning, the collection is not serialized & returned
    //var details = configuration.EntityType.CollectionProperty(x => x.Details);
    //var seals = configuration.EntityType.CollectionProperty(x => x.Seals);

    // FAILS: Meaning, the collection is not serialized & returned
    //configuration.HasManyBinding(x => x.Details, "ShakeoutDetail");
    //configuration.HasManyBinding(x => x.Seals, "ShakeoutSeal");

    // ------------------
    // Complex Properties
    configuration.EntityType.ComplexProperty(x => x.ObjectState);

    // IObjectState
    var objectState = modelBuilder.ComplexType<IObjectState>();
    objectState.CollectionProperty(x => x.Events);

    // Object State
    var newObjectState = modelBuilder.ComplexType<New>();
    newObjectState.DerivesFrom<IObjectState>();

    var submittedObjectState = modelBuilder.ComplexType<Submitted>();
    submittedObjectState.DerivesFrom<IObjectState>();

    // Object State Event
    var isNewObjectStateEvent = modelBuilder.ComplexType<IsNew>();
    isNewObjectStateEvent.DerivesFrom<IObjectStateEvent>();

    var isSubmittedObjectStateEvent = modelBuilder.ComplexType<IsSubmitted>();
    isSubmittedObjectStateEvent.DerivesFrom<IObjectStateEvent>();

    return configuration;
}

发送此 JSON 有效:
如果我 SEND 这个 JSON 没有填充 Details & Seals 集合..它会正确序列化。

如果我填充 Details & Seals 集合...参数为 NULL。

{
    "DocumentTypeId": 1,
    "GlobalId": "e8c9d71d-2773-e911-b71a-8cdcd4471a95",
    "ParentId": null,
    "AuthorId": 1,
    "PublisherId": null,
    "RevisionNumber": 0,
    "PublishedDate": null,
    "IsActive": true,
    "Id": 44,
    "CreateUserId": "(removed)",
    "CreateDate": "2019-05-10T08:25:46.31-05:00",
    "UpdateUserId": "(removed)",
    "UpdateDate": "2019-05-10T08:25:46.31-05:00",
    "ShakeoutId": 44,
    "SchedulingBatch": null,
    "ProductId": null,
    "Gravity": null,
    "Temperature": null,
    "SedimentAndWater": null,
    "BatchEndDate": null,
    "SampleWorkedDate": null,
    "Witness": null,
    "Notes": null,
    "Seals": [],
    "Details": [],
    "ObjectState": {
        "@odata.type": "#Namespace...ShakeoutDocument.New",
        "Name": "New",
        "Events": [
            {
                "@odata.type": "#Namespace...ShakeoutDocument.IsNew",
                "Name": "IsNew"
            }
        ]
    }
}

接收失败:
这显示了从服务发送回客户端的对象和客户端收到的 JSON。

enter image description here

未绑定(bind)函数看起来像:
为了完整起见,我包括了这个......

[HttpPost]
[ODataRoute("SaveShakeoutDocument")]
public IHttpActionResult SaveDocument(ODataActionParameters parameters)
{
    var provider = Application.ShakeoutDocumentProvider;
    var document = null as ShakeoutDocument;

    try
    {
        document = provider.Get(key);
    }
    catch (Exception ex)
    {
        LogException(ex);

        throw;
    }

    return Ok(document);
}

更新 1:
$MetaData 似乎了解集合类型...

<EntityType Name="ShakeoutDocument" BaseType="Pulse.Document">
    <Property Name="ObjectState" Type="Pulse.IObjectState" Nullable="false"/>
    <Property Name="ShakeoutId" Type="Edm.Int32" Nullable="false"/>
    <Property Name="SchedulingBatch" Type="Edm.String"/>
    <Property Name="ProductId" Type="Edm.Int32"/>
    <Property Name="Gravity" Type="Edm.Decimal"/>
    <Property Name="Temperature" Type="Edm.Decimal"/>
    <Property Name="SedimentAndWater" Type="Edm.Decimal"/>
    <Property Name="BatchEndDate" Type="Edm.DateTimeOffset"/>
    <Property Name="SampleWorkedDate" Type="Edm.DateTimeOffset"/>
    <Property Name="Witness" Type="Edm.String"/>
    <Property Name="Notes" Type="Edm.String"/>
    <NavigationProperty Name="Details" Type="Collection(Pulse.ShakeoutDetail)"/>
    <NavigationProperty Name="Seals" Type="Collection(Pulse.ShakeoutSeal)"/>
</EntityType>

更新 2:
我刚刚注意到...ShakeoutDetails 和 ShakeoutDetail 的 NavigationPropertyBinding 为“Meter”...ShakeoutDocument 中不存在(并且永远不会包含在内,因为这是模型而不是实体)。

<?xml version="1.0" encoding="UTF-8"?>
<EntityContainer Name="PulseContainer">
   <EntitySet Name="Communication" EntityType="Pulse.tblDbcCommunications" />
   <EntitySet Name="Item" EntityType="Pulse.tblDbcItems" />
   <EntitySet Name="Meter" EntityType="Pulse.Meter" />
   <EntitySet Name="Products" EntityType="Pulse.Product" />
   <EntitySet Name="WarehouseMeters" EntityType="Pulse.WarehouseMeter" />
   <EntitySet Name="tblDbcCircuitOwner" EntityType="Pulse.tblDbcCircuitOwner" />
   <EntitySet Name="ShakeoutDetails" EntityType="Pulse.ShakeoutDetail">
      <NavigationPropertyBinding Path="Meter" Target="Meter" />
   </EntitySet>
   <EntitySet Name="ShakeoutSeals" EntityType="Pulse.ShakeoutSeal" />
   <EntitySet Name="ShakeoutDocuments" EntityType="Pulse.ShakeoutDocument" />
   <EntitySet Name="ShakeoutDocument" EntityType="Pulse.ShakeoutDocument" />
   <EntitySet Name="ShakeoutDetail" EntityType="Pulse.ShakeoutDetail">
      <NavigationPropertyBinding Path="Meter" Target="Meter" />
   </EntitySet>
   <EntitySet Name="ShakeoutSeal" EntityType="Pulse.ShakeoutSeal" />
   <EntitySet Name="Product" EntityType="Pulse.Product" />
   <EntitySet Name="WarehouseMeter" EntityType="Pulse.WarehouseMeter" />
   <ActionImport Name="CreateShakeoutDocument" Action="Pulse.CreateShakeoutDocument" EntitySet="ShakeoutDocument" />
   <ActionImport Name="DeleteShakeoutDocument" Action="Pulse.DeleteShakeoutDocument" EntitySet="ShakeoutDocument" />
   <FunctionImport Name="GetShakeoutDocument" Function="Pulse.GetShakeoutDocument" EntitySet="ShakeoutDocument" IncludeInServiceDocument="true" />
   <ActionImport Name="SaveShakeoutDocument" Action="Pulse.SaveShakeoutDocument" EntitySet="ShakeoutDocument" />
   <ActionImport Name="SaveShakeoutDetail" Action="Pulse.SaveShakeoutDetail" EntitySet="ShakeoutDetail" />
   <ActionImport Name="SaveShakeoutSeal" Action="Pulse.SaveShakeoutSeal" EntitySet="ShakeoutSeal" />
   <FunctionImport Name="ListProducts" Function="Pulse.ListProducts" EntitySet="Product" IncludeInServiceDocument="true" />
   <FunctionImport Name="FindWarehouseMeter" Function="Pulse.FindWarehouseMeter" EntitySet="WarehouseMeter" IncludeInServiceDocument="true" />
</EntityContainer>

最佳答案

根据您的最新更新,我认为导航属性绑定(bind)的问题很有趣。

它没有解析 Meter,你应该看看 https://odata.github.io/WebApi/13-03-NavigationPropertyBindingWithComplexType/ (如果需要,还可以查看 Transient Actions)

关于c# - OData 无法识别我的集合属性,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/56115354/

相关文章:

c# - PointToScreen 多个显示器

c# - 使用包含 EF 时可能的 SQL 注入(inject)?

c# - 如何使用 Json.NET 在 C# 中将根节点添加到 JSON?

model-binding - ASP.NET Web API Controller 无法处理动态对象?

json - 缩短 JSON : does it make sense? 中的属性名称

asp.net - 使用 OData 插入具有关系的记录

c# - 如何在 uwp 的 xaml 中拉伸(stretch)/调整 svgs 的大小?

c# - 在内存中缓存应用程序数据 : MVC Web API

ODataModel 在读取中传递 "expand"参数

java - 在没有 Entity Framework 的情况下构建 OData API