是否可以从.NET中的REST API获取复杂的Entity Framework对象而无需创建ViewModel对象?

时间:2015-12-15 13:36:21

标签: c# asp.net-mvc entity-framework asp.net-core entity-framework-core

想象一组实体框架实体:

public class Country {
    public string CountryCode { get; set; }
    public string Name { get; set; }
    public string Flag { get; set; }
}

public class Market {
    public string CountryCode { get; set; }
    public virtual Country Country { get; set; }
    public int ProductID { get; set; }      
    public virtual Product Product { get; set; }
}

public class Product {
    public int ProductID { get; set; }
    public string Name { get; set; }
    public virtual ICollection<Market> Markets{ get; set; }
}

想象一下DOTNET 5 api GET

// GET api/product
[HttpGet]
public async Task<IActionResult> GetProduct([FromRoute] int id)
{
    return Ok(await _context.Products
        .Include(p => p.Markets)
        .SingleAsync(m => m.ProductID == id));
}

如果实体没有附加市场,数据会毫无问题地返回,但只要我附加了一些链接项,我就会收到错误:

  

HTTP错误502.3 - 错误的网关
  指定的CGI应用程序遇到错误,服务器终止了该过程。

我模糊地回忆起以前的应用程序,其中每个复杂的EF对象都有一个“仅基元”类型的对象来发送和接收客户端的这个对象,但我想知道是否有一种方法可以在没有中间对象的情况下进行通信?

例如:

public class ProductViewModel {
    public int ProductID { get; set; }
    public string Name { get; set; }
    public List<MarketViewModel> Markets{ get; set; }
}

public class MarketViewModel {
    public int ProductID { get; set; }
    public Country Country { get; set; }
}

我担心的是从客户端来回翻译每个复杂对象的编码开销(我承认,我不确定这是不是一件坏事,也许它必须完成)。

由于脚手架API似乎直接接收和返回实体,我发现自己想知道是否有办法直接处理对象的复杂部分

编辑#1:

Per Noel的评论如下,如果我将导致错误的代码更改为

    [HttpGet("{id}", Name = "GetProduct")]
    public async Task<IActionResult> GetProduct([FromRoute] int id)
    {

        Product product = await _context.Products
            .Include(t => t.Markets)
            .SingleAsync(m => m.ProductID == id);

        throw new System.Exception("error sample");
        return Ok(product);
    }

正确抛出堆栈跟踪。如果我删除了异常,则会出现500网关错误。我同意它看起来可能是序列化错误,但很难说。

编辑2 - 根据以下Oleg的评论:

错误网关的解决方案是首先在NewtonSoft.Json文件的依赖项中显式更新project.json的更新版本:

"dependencies": {
  "Newtonsoft.Json": "8.0.1-beta3",

接下来你必须改变Startup.cs文件

    public void ConfigureServices(IServiceCollection services)
    {

         services.AddMvc()
            .AddJsonOptions(options => {
                options.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
            });

有了这两个设置,不再出现坏网关,并且api调用成功地按预期返回复杂对象。

2 个答案:

答案 0 :(得分:4)

在我看来,您在await的电话中错过了SingleAsync。尝试使用

[HttpGet]
public async Task<IActionResult> GetProduct([FromRoute] int id)
{
    return Ok(await _context.Products
        .Include(p => p.Markets)
        .SingleAsync(m => m.ProductID == id));
}

更新:我找到了the issue。我建议您检查一下您可以检查package.lock.json以查看将通过自动解析依赖项加载哪个版本。然后我建议显式在最新版本8.0.1-beta3中添加Newtonsoft.Json到项目的依赖项。此外,您应该在Newtonsoft.Json.ReferenceLoopHandling.Ignore的配置中添加SerializerSettings.ReferenceLoopHandling的设置。有关详细信息,请参阅the issue

答案 1 :(得分:0)

您可以返回匿名对象或使用ExpandoObject / JsonObject:

public HttpResponseMessage Get()
{
    return this.Request.CreateResponse(
        HttpStatusCode.OK,
        new { Message = "Hello", Value = 123 });
}

// JsonObject

dynamic json = new JsonObject();
json.Message = "Hello";
json.Value = 123;

return new HttpResponseMessage<JsonObject>(json);

// ExpandoObject

 dynamic expando = new ExpandoObject();
    expando.message = "Hello";
    expando.message2 = "World";
    return expando;