wcf - 如何使用 Json.Net 从 WCF Rest 服务 (.NET 4) 返回 json，而不是用引号引起来的字符串？

Question

更新 2010 年 10 月 19 日我知道我不久前问过这个问题，但这些答案中显示的解决方法很难令人满意，这仍然是许多人的常见问题。 WCF 就是不灵活。我创建了自己的开源 C# 库，用于在没有 WCF 的情况下创建 REST 服务。检查restcake.net或rest.codeplex.com有关该图书馆的信息。结束更新

更新 2012 年 8 月 2 日 ASP.NET Web API (以前的 WCF Web API，REST WCF 的替代品)使用 Json.NET默认情况下结束更新

DataContractJsonSerializer 无法处理Json.Net 的许多场景。正确配置后(特别是循环)处理得很好。

服务方法可以返回特定的对象类型(在本例中为 DTO )，在这种情况下将使用 DataContractJsonSerializer ，或者我可以让该方法返回一个字符串，并且我自己用 Json.Net 进行序列化。问题是，当我返回 json 字符串而不是对象时，发送到客户端的 json 会用引号括起来。

使用DataContractJsonSerializer，返回特定对象类型，响应为:
{"Message":"Hello World"}

使用Json.Net返回json字符串，响应为:
"{\"消息\":\"Hello World\"}"

我不想在客户端上对结果进行 eval() 或 JSON.parse() 操作，如果 json 以字符串形式返回并用引号括起来，那么我就必须这样做。我意识到这种行为是正确的；这不是我想要/需要的。我需要原始 json；当服务方法的返回类型是对象而不是字符串时的行为。

那么，如何让我的方法返回对象类型，但不使用 DataContractJsonSerializer？我怎样才能告诉它使用 Json.Net 序列化器？

或者，有没有办法直接写入响应流？那么我可以自己返回原始 json 吗？没有引号？

这是我设计的示例，供引用:

[DataContract]
public class SimpleMessage
{
    [DataMember]
    public string Message { get; set; }
}

[ServiceContract]
[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
[ServiceBehavior(InstanceContextMode = InstanceContextMode.Single)]
public class PersonService
{
    // uses DataContractJsonSerializer
    // returns {"Message":"Hello World"}
    [WebGet(UriTemplate = "helloObject")]
    public SimpleMessage SayHelloObject()
    {
        return new SimpleMessage("Hello World");
    }

    // uses Json.Net serialization, to return a json string
    // returns "{\"Message\":\"Hello World\"}"
    [WebGet(UriTemplate = "helloString")]
    public string SayHelloString()
    {
        SimpleMessage message = new SimpleMessage() { Message = "Hello World" };
        string json = JsonConvert.Serialize(message);
        return json;
    }

    // I need a mix of the two.  Return an object type, but use the Json.Net serializer.
}

Answer 1

我终于找到了解决这个问题的方法。这不是我想要的(返回特定的对象类型，并以某种方式指示 WCF 使用 Json.Net 序列化器，而不是 DataContractJsonSerializer)，但它工作得很好，而且简单明了。

使用这个新的解决方案扩展我设计的示例:

[WebGet(UriTemplate = "hello")]
public void SayHello()
{
    SimpleMessage message = new SimpleMessage() {Message = "Hello World"};
    string json = JsonConvert.Serialize(message);
    HttpContext.Current.Response.ContentType = "application/json; charset=utf-8";
    HttpContext.Current.Response.Write(json);
}

注意 void 的返回类型。我们不返回任何内容，因为它将使用 DataContractJsonSerializer 进行序列化。相反，我直接写入响应输出流。由于返回类型为 void，处理管道不会将 content-type 设置为默认类型“application/json”，因此我显式设置它。

因为这使用 HttpContext ，我猜它只有在你有 [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)] 时才有效。在您的服务类上，因为这将强制对服务的请求通过 ASP.NET 管道。如果没有 asp.net 兼容性，HttpContext 将不可用，因为 wcf 托管应该与主机无关。

使用此方法，在 Firebug 中 GET 请求的结果看起来很完美。正确的内容类型、正确的内容长度和原始 json，不包含在引号中。而且，我正在使用 Json.Net 获得我想要的序列化。两全其美。

当我的服务方法将 [DataContract] 对象类型作为输入参数时，我不能 100% 肯定在反序列化方面可能会遇到哪些障碍。我假设 DataContractJsonSerializer 也将用于此目的。当我到达那座桥时，我会跨过那座桥……如果它造成了问题。到目前为止，我的简单 DTO 还没有做到这一点。

更新请参阅奥列格的回答(UPDATE2 部分)。他将服务方法的返回类型从 void 更改为 System.ServiceModel.Channels.Message ，而不是使用 HttpContext.Current.Response.Write() ，他使用:

return WebOperationContext.Current.CreateTextResponse (json,
    "application/json; charset=utf-8", Encoding.UTF8);

这确实是一个更好的解决方案。谢谢奥列格。

更新2还有另一种方法可以实现这一点。将服务的返回类型从 Message 更改为 Stream，然后返回:

WebOperationContext.Current.OutgoingResponse.ContentType = "application/json; charset=utf-8";
return new MemoryStream(System.Text.Encoding.UTF8.GetBytes(json));

我尚未进行任何具体测试，但对于可能返回大量数据的方法来说，这可能是更好的选择。我不知道这对于非二进制数据是否重要。无论如何，一个想法。