c# - 是否可以在 ODataController 中返回不同的模型？

Question

在 OData v4 Controller 中，是否可以为 Get() 和 Get([FromIDataUri] key) 返回不同的模型？

我喜欢使用 ViewModel，当使用 Get() 方法时，我想返回一个 xxxOverviewViewModel。使用 Get([FromIDataUri] key) 方法时，我想返回一个 xxxViewModel。

这是否可能，如果可能，如何实现？

我尝试返回不同的模型，但我总是得到 406 Acceptable。

Webapi.config:

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.EnableCors();

        config.MapODataServiceRoute("ODataRoute", "odata", GetEdmModel());

        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        config.Filter().Expand().Select().OrderBy().MaxTop(null).Count();
    }

    private static IEdmModel GetEdmModel()
    {
        var builder = new ODataConventionModelBuilder();
        builder.EntitySet<ComplaintViewModel>("ComplaintOData");
        return builder.GetEdmModel();

    }
}

投诉数据 Controller

public class ComplaintODataController : ODataController
{
    private readonly QueryProcessor _queryProcessor;

    public ComplaintODataController(QueryProcessor queryProcessor)
    {
        _queryProcessor = queryProcessor;
    }

    [EnableQuery]
    public IQueryable<ComplaintOverviewViewModel> Get()
    {
        var result = _queryProcessor.Handle(new GetAllComplaintsQuery());
        return result;
    }

    // WHEN CALLING THIS METHOD I GET A 406: 
    [EnableQuery]
    public ComplaintViewModel Get([FromODataUri] int key)
    {
        var result = _queryProcessor.Handle(new GetComplaintByIdQuery { Id = key });
        return result;
    }
}

编辑:

我的 GetAllComplaintsQuery.Handle 方法如下所示:

public IQueryable<ComplaintOverviewViewModel> Handle(GetAllComplaintsQuery query)
{
    // .All is an IQueryable<Complaint>
    var result = _unitOfWork.Complaints.All.Select(c => new ComplaintOverviewViewModel
    {
        ComplaintType = c.ComplaintType.Description,
        CreationDate = c.CreationDate,
        Customer = c.Customer,
        Description = c.Description,
        Id = c.Id,
        SequenceNumber = c.SequenceNumber,
        Creator = c.Creator.Name
    });

    return result;
}

这是我的ComplaintConfiguration

public class ComplaintConfiguration : EntityTypeConfiguration<Complaint>
{
    public ComplaintConfiguration()
    {
        Property(p => p.SequenceNumber).HasDatabaseGeneratedOption(DatabaseGeneratedOption.Computed);
        Property(p => p.Description).IsRequired();
    }
}

Answer 1

您没有包含您的 ViewModel 类的定义，所以让我首先确保我们在您实际尝试实现的目标方面达成一致。

当客户端从无参数 Get() 请求投诉 记录列表时，您似乎想要返回一些受限制的字段集但是当客户向 Get([FromODataUri] int key) 提出具体投诉时您想要包含其他字段的方法。

我使用以下层次结构对此假设进行建模:

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

public class ComplaintOverviewViewModel : ComplaintTypeViewModel
{
    public string Name { get; set; }
}

public class ComplaintViewModel : ComplaintOverviewViewModel
{
    public string Details { get; set; }
}

运行测试，GET /odata/ComplaintOData按预期返回了一个只有 Id 和 Name 的列表，GET /odata/ComplaintOData(1)返回包含 Details 以及其他两个字段的单个记录，也符合预期。

我从来不需要更改 Controller 或 WebApiConfig.cs 的代码除了 builder.EntitySet<ComplaintTypeViewModel>("ComplaintOData"); 中的字符串参数它必须与 ccontroller 匹配(您的代码中有 "ComplaintTypeOData")。

自从它起作用后，我试图弄清楚如何重现您的 406。我已经更改了 ComplaintViewModel扩展ComplaintTypeViewModel直接而不是扩展 ComplaintOverviewViewModel (请注意，我刚刚复制了 Name 属性):

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

public class ComplaintOverviewViewModel : ComplaintTypeViewModel
{
    public string Name { get; set; }
}

public class ComplaintViewModel : ComplaintTypeViewModel
{
    public string Name { get; set; }
    public string Details { get; set; }
}

这也很好用。

我可以重现您的 406 的唯一方法是更改​​ ComplaintViewModel 没有有ComplaintTypeViewModel在它的继承层次中:

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

public class ComplaintOverviewViewModel : ComplaintTypeViewModel
{
    public string Name { get; set; }
}

public class ComplaintViewModel
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Details { get; set; }
}

这最终给了我来自 GET /odata/ComplaintOData(1) 的 406 代码同时 GET /odata/ComplaintOData仍然返回带有 Id 和 Name 的列表就好了。

因此，看起来只要所有您的ViewModel 类都扩展了相同的T。来自 builder.EntitySet<T>("name")您可以从 Get() 返回其中任何一个 Controller 中的重载。请检查您如何定义您的 ViewModels