排除 ODataConventionModelBuilder 中实现的接口

Question

我在使用 Web API 2 和 OData v3 时遇到了一个奇怪的问题，特别是 ODataConventionModelBuilder。我的 WebApiConfig.cs:

中有以下代码

// Web API configuration and services
var builder = new ODataConventionModelBuilder();

// Adding all the entity sets here, then complex types, custom actions, ...
builder.EntitySet<Address>("Addresses");
/* ... */

builder.AddComplexType(typeof(CustomerSearchResultDto));
/* ... */

var customerSearchAction = builder.Entity<Customer>().Collection.Action("Search");
        patientSearchAction.Parameter<string>("pattern");
        patientSearchAction.Parameter<bool>("searchDeactivated");

// These are the interfaces that some entities implement. These MUST NOT be put into the model
var interfaces = typeof(ICustomer).Assembly.GetTypes().Where(t => t.IsInterface).ToArray();
builder.Ignore(interfaces);

// Building models
var model = builder.GetEdmModel();
config.Routes.MapODataServiceRoute("odata", "odata", model);

模型构建良好，无一例外。但是一些实体实现的接口被转换为复杂类型，这当然是荒谬的，并且会在客户端引起相当多的命名空间混淆。这是生成的元数据的摘录 (service:1111/$metadata)

<ComplexType Name="IAddress">
    <Property Name="Street1" Type="Edm.String" />
    <Property Name="Street2" Type="Edm.String" />
    <Property Name="Zip" Type="Edm.String" />
    <Property Name="City" Type="Edm.String" />
    <Property Name="Country" Type="Edm.String" />
</ComplexType>

我也尝试过使用builder.Ignore<IAddress>，但没有用。我做错了什么？

Answer 1

我猜你有一个属性定义为 IAddress，例如：

public class Customer
{
    public int CustomerId { get; set; }

    public IAddress Address { get; set; }

    ...
}

因此，builder.Ignore(interfaces);无法正常工作。

如果是这样，您可以：

更改模型定义，使用抽象 class，不使用接口。
或者，尝试 Ignore 属性。

Answer 2

我找到了更好的解决方案。在 WebApiConfig.cs 我为每个实体做：

builder.EntitySet<Address>("Addresses").EntityType.DerivesFromNothing();

如果实体派生自另一个实体，我使用 DerivesFrom() 方法。为了避免命名空间与我的复杂类型发生冲突，我使用了 DTO。由于我有很多，我只是像这样批量添加它们（使用反射）：

var builderMethod = builder.GetType().GetMethod("ComplexType");
foreach (var type in typeof (WebApiConfig).Assembly.GetTypes().Where(x => x.Name.EndsWith("Dto")))
{
    var genericMethod = builderMethod.MakeGenericMethod(type);
    genericMethod.Invoke(builder, null);
}

这个效果很好。

排除 ODataConventionModelBuilder 中实现的接口

Exclude implemented interfaces in ODataConventionModelBuilder

c#

odata

asp.net-web-api

asp.net-web-api2