WebApi序列化出错

时间:2016-06-16 15:06:07

标签: c# asp.net-web-api

我有一个带有多个控制器的WebApi会返回不同的结果。例如,一个控制器返回一个IEnumberable,另一个控制器返回一个Bar,另一个控制器返回IEnumberable等IEnumberable等,我所要做的就是:

return Ok(thething)

并且一切正常,即使是复杂的嵌套对象也没有问题序列化。

现在,客户要求在包装器中返回所有结果:

public class Wrapper
{
    public bool Success { get; set; }
    public int ErrorCode { get; set; }
    public String ErrorMessage { get; set; }
    public String Referer { get; set; }
    public Object Payload { get; set; }
}

认为这将是微不足道的,但当我尝试从控制器返回时:

return Ok( new Wrapper { Success=true, Referer="me", Payload=thething)

我收到序列化错误。

异常消息是:

  

'ObjectContent`1'类型无法序列化响应正文   内容类型'application / xml;字符集= UTF-8' 。

内部异常消息是:

  

类型   “System.Linq.Enumerable + WhereSelectListIterator 2[[EPiServer.Find.Api.SearchHit 1 [[DGTNext.Api.Data.Entities.ProductSummary,   DGTNext.Api.Entities,Version = 1.0.0.0,Culture = neutral,   PublicKeyToken = null]],EPiServer.Find,Version = 9.6.0.3185,   文化=中性,   公钥= 8fe83dea738b45b7],[DGTNext.Api.Data.Entities.ProductSummary,   DGTNext.Api.Entities,Version = 1.0.0.0,Culture = neutral,   具有数据协定名称的PublicKeyToken = null]]'   'ArrayOfProductSummary:http://schemas.datacontract.org/2004/07/DGTNext.Api.Data.Entities'   不是预期的。如果是的话,请考虑使用DataContractResolver   使用DataContractSerializer或添加静态未知的任何类型   已知类型的列表 - 例如,通过使用KnownTypeAttribute   属性或将它们添加到传递给的已知类型列表中   串行器。

我做错了什么?为什么Ok()函数之前似乎处理任何对象,但现在有问题?

感谢。

编辑:根据要求,一个导致错误的简单示例:

class Foo {
    public int AnInt { get; set; }
}


public IHttpActionResult Get() {
    return Ok(new Wrapper { Success=true, Referer="me", Payload= new Foo {AnInt = 7}});
}

编辑:

好吧,我想出了一些解决方案,但它仍然提出了一些问题。

我在Payload的类型中使我的Wrapper变得通用。

public class Wrapper<T>
{
    public bool Success { get; set; }
    public int ErrorCode { get; set; }
    public String ErrorMessage { get; set; }
    public String Referer { get; set; }
    public T Payload { get; set; }
}

现在,这有效:

public IHttpActionResult Get() {
    List<Foo> foos = new List<Foo>();
    foos.Add(new Foo { AnInt = 7 });
    foos.Add(new Foo { AnInt = 8 });
    return Ok(new Wrapper<IEnumerable<Foo>> { Success=true, Referer="me", Payload= foos});
}

它返回:

{"Success":true,"ErrorCode":0,"ErrorMessage":null,"Referer":"me","Payload":[{"AnInt":7},{"AnInt":8}]}

我的“真实”电话:

public IHttpActionResult Get() {
    IEnumerable<ProductSummary> prods =  db.getProductSummaries(shopId, culture, queryParams, paging);
    return Ok(new Wrapper<IEnumerable<ProductSummary>> { Success = true, Referer = "me", Payload = prods });
}

返回:

<WrapperOfArrayOfProductSummaryzc2y5_Pnl>
    <ErrorCode>0</ErrorCode>
    <ErrorMessage i:nil="true"/>
    <Payload>
        <d2p1:ProductSummary>
            <d2p1:Culture i:nil="true"/>
            <d2p1:Guid i:nil="true"/>
            <d2p1:Id>2</d2p1:Id>
            <d2p1:Name>Letto Asia</d2p1:Name>
            <d2p1:ambient>
                <d2p1:Id>1073741838</d2p1:Id>
                <d2p1:Name>notte</d2p1:Name>
            </d2p1:ambient>  
    etc.

所以不错,但这提出了两个问题:

  1. 为了测试webapi,我通过在Firefox地址栏中放置一个URL并在浏览器中查看结果来调用它。为什么世界上第一次调用返回Json,第二次调用XML?据我所知,我只是使用默认的一切。

  2. 为什么XML现在将该命名空间添加到所有元素名称?我可以阻止这个吗?当我在没有包装器的情况下返回相同的东西时,这种情况并没有发生。

1 个答案:

答案 0 :(得分:5)

将此代码添加到 Application_Start 下面的 global.asax

.Ignore 更新为 .Serialize 。它必须工作。

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;
        GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);

或者您可以查看此answer