如何从WCF服务返回干净的JSON?


233

我正在尝试从WCF服务返回一些JSON。该服务仅从我的数据库返回一些内容。我可以得到数据。但是,我担心JSON的格式。当前,返回的JSON格式如下:

{"d":"[{\"Age\":35,\"FirstName\":\"Peyton\",\"LastName\":\"Manning\"},{\"Age\":31,\"FirstName\":\"Drew\",\"LastName\":\"Brees\"},{\"Age\":29,\"FirstName\":\"Tony\",\"LastName\":\"Romo\"}]"} 

实际上,我希望JSON的格式尽可能整洁。我相信(我可能是不正确的),以干净的JSON表示的相同结果集应如下所示:

[{
  "Age": 35,
  "FirstName": "Peyton",
  "LastName": "Manning"
}, {
  "Age": 31,
  "FirstName": "Drew",
  "LastName": "Brees"
}, {
  "Age": 29,
  "FirstName": "Tony",
  "LastName": "Romo"
}]

我不知道“ d”来自哪里。我也不知道为什么要插入转义字符。我的实体如下所示:

[DataContract]
public class Person
{
    [DataMember]
    public string FirstName { get; set; }

    [DataMember]
    public string LastName { get; set; }

    [DataMember]
    public int Age { get; set; }

    public Person(string firstName, string lastName, int age)
    {
        this.FirstName = firstName;
        this.LastName = lastName;
        this.Age = age;
    }
}

负责返回内容的服务定义为:

[ServiceContract(Namespace = "")]
[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class TestService
{
    [OperationContract]
    [WebGet(ResponseFormat = WebMessageFormat.Json)]
    public string GetResults()
    {
        List<Person> results = new List<Person>();
        results.Add(new Person("Peyton", "Manning", 35));
        results.Add(new Person("Drew", "Brees", 31));
        results.Add(new Person("Tony", "Romo", 29));

        // Serialize the results as JSON
        DataContractJsonSerializer serializer = new DataContractJsonSerializer(results.GetType());
        MemoryStream memoryStream = new MemoryStream();
        serializer.WriteObject(memoryStream, results);

        // Return the results serialized as JSON
        string json = Encoding.Default.GetString(memoryStream.ToArray());
        return json;
    }
}

如何从WCF服务返回“干净” JSON?谢谢!


SOAP应该返回XML。您可以使用REST端点返回JSON。看看stackoverflow.com/questions/186631/...
山本晃

4
顺便说一句,如果其他人遇到这个问题,并且想知道为什么其中存在“ d”属性,那么就可以在那里修补JSON漏洞。删除它会使您再次脆弱。
亚历克斯(Alex)

4
@Alex-漏洞取决于重新定义Array对象,在现代浏览器中不再可能。见stackoverflow.com/questions/16289894/...
Cheeso

非常好。:)虽然我的回答一半仍然是正确的-它在那里修补了该漏洞。
Alex

Answers:


213

将GetResults的返回类型更改为List<Person>
消除用于将List序列化为json字符串的代码-WCF会自动为您执行此操作。

使用您对Person类的定义,此代码对我有用:

public List<Person> GetPlayers()
{
    List<Person> players = new List<Person>();
    players.Add(new  Person { FirstName="Peyton", LastName="Manning", Age=35 } );
    players.Add(new  Person { FirstName="Drew", LastName="Brees", Age=31 } );
    players.Add(new  Person { FirstName="Brett", LastName="Favre", Age=58 } );

    return players;
}

结果:

[{"Age":35,"FirstName":"Peyton","LastName":"Manning"},  
 {"Age":31,"FirstName":"Drew","LastName":"Brees"},  
 {"Age":58,"FirstName":"Brett","LastName":"Favre"}]

(全部一行)

我还在方法上使用了此属性:

[WebInvoke(Method = "GET",
           RequestFormat = WebMessageFormat.Json,
           ResponseFormat = WebMessageFormat.Json,
           UriTemplate = "players")]

使用Method =“ GET”的WebInvoke与WebGet相同,但是由于我的某些方法是POST,因此为了保持一致性,我使用了所有WebInvoke。

UriTemplate设置该方法可用的URL。因此,我可以进行GET http://myserver/myvdir/JsonService.svc/players,它可以正常工作。

还要检查IIRF或其他URL重写器,以摆脱URI中的.svc。


Cheeso-在发布此问题之前,我尝试过这种方法。当我使用这种方法时,出现错误消息“使用'UriTemplate'的端点不能与'System.ServiceModel.Description.WebScriptEnablingBehavior'一起使用”。我究竟做错了什么?谢谢!
user208662 2010年

28
在.config文件中使用<webHttp />而不是<webScriptEnablingBehavior />。
Cheeso 2010年

9
好的,我用<webHttp />替换了<enableWebScript />并成功了。
MGOwen

3
MGowen-仅供参考,问一个新问题时最好的选择是...打开一个新问题,而不是将该问题作为对旧答案的评论发布。
Cheeso

5
法弗尔(Favre)看到您在那里做了什么。
鲁芬2012年

93

如果您希望在不将属性硬编码到服务类的情况下使用漂亮的json,

<webHttp defaultOutgoingResponseFormat="Json"/>你的行为的配置



8

我遇到了同样的问题,并通过将BodyStyle属性值更改为“ WebMessageBodyStyle.Bare”来解决了这个问题:

[OperationContract]
[WebGet(BodyStyle = WebMessageBodyStyle.Bare, RequestFormat = WebMessageFormat.Json,
        ResponseFormat = WebMessageFormat.Json, UriTemplate = "GetProjectWithGeocodings/{projectId}")]
GeoCod_Project GetProjectWithGeocodings(string projectId);

返回的对象将不再被包装。


1

使用GET方法时,合同必须是这个。

[WebGet(UriTemplate = "/", BodyStyle = WebMessageBodyStyle.Bare, ResponseFormat = WebMessageFormat.Json)]
List<User> Get();

有了这个,我们有一个没有boot参数的json

奥尔多·弗洛雷斯(Aldo Flores)@alduar http://alduar.blogspot.com


1

在您的IServece.cs中添加以下标记:BodyStyle = WebMessageBodyStyle.Bare

 [WebInvoke(Method = "GET", ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "Getperson/{id}")]

    List<personClass> Getperson(string id);

您还能解释为什么BodyStyle会影响结果吗?
MBH 2016年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.