Как вернуть чистый JSON из службы WCF?

233

Я пытаюсь вернуть JSON из службы WCF. Этот сервис просто возвращает некоторый контент из моей базы данных. Я могу получить данные. Тем не менее, я обеспокоен форматом моего 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». Я также понятия не имею, почему вставляются escape-символы. Моя сущность выглядит следующим образом:

[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;
    }
}

Как вернуть «чистый» JSON из службы WCF? Спасибо!

user208662
источник
SOAP должен возвращать XML. Вы можете использовать конечную точку REST для возврата JSON. Взгляните на stackoverflow.com/questions/186631/…
Акира Ямамото
4
Кстати, если кто-то еще сталкивался с этим и задавался вопросом, почему свойство «d» существует, оно должно исправить уязвимость JSON . Удаление этого снова делает вас уязвимым.
Алекс
4
@Alex - эта уязвимость зависит от переопределения объекта Array, что больше невозможно в современных браузерах. См stackoverflow.com/questions/16289894/...
Cheeso
Это хорошо. :) Половина моего ответа все еще верна - она ​​была там, чтобы исправить эту уязвимость.
Алекс

Ответы:

213

Измените тип возврата вашего GetResults на List<Person>.
Исключите код, который вы используете для сериализации списка в строку 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")]

WebInvoke с Method = "GET" аналогичен WebGet, но поскольку некоторые из моих методов являются POST, я использую весь WebInvoke для согласованности.

UriTemplate устанавливает URL, по которому метод доступен. Так что я могу получить на http://myserver/myvdir/JsonService.svc/players и это просто работает.

Также проверьте IIRF или другое средство переписывания URL, чтобы избавиться от .svc в URI.

Cheeso
источник
Cheeso - я попробовал этот подход, прежде чем опубликовать этот вопрос. Когда я использую этот подход, я получаю сообщение об ошибке «Конечные точки, использующие« UriTemplate », не могут использоваться с« System.ServiceModel.Description.WebScriptEnablingBehavior '». Что я делаю не так? Спасибо!
user208662
28
используйте <webHttp /> вместо <webScriptEnablingBehavior /> в вашем файле .config.
Cheeso
9
Хорошо, я заменил <enableWebScript /> на <webHttp />, и это сработало.
MGOwen
3
MGowen - К вашему сведению, лучше всего задавать новый вопрос, чтобы ... открыть новый вопрос, а не публиковать вопрос в качестве комментария к старому ответу.
Cheeso
5
Фавр видит, что ты там сделал.
ruffin
93

Если вы хотите хороший JSON без жесткого кодирования атрибутов в ваших классах обслуживания,

использовать <webHttp defaultOutgoingResponseFormat="Json"/>в своем поведении конфигурации

JeremyWeir
источник
28

Это выполняется в web.config для вашего веб-сервиса. Установите для bindingBehavior значение <webHttp>, и вы увидите чистый JSON. Дополнительный «[d]» задается поведением по умолчанию, которое необходимо перезаписать.

Дополнительно смотрите этот пост в блоге: http://blog.clauskonrad.net/2010/11/how-to-expose-json-endpoint-from-wcf.html

user517301
источник
8

Я столкнулся с той же проблемой и решил ее, изменив значение атрибута BodyStyle на «WebMessageBodyStyle.Bare»:

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

Возвращенный объект больше не будет упакован.

KhalilG
источник
1

Когда вы используете метод GET, контракт должен быть таким.

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

с этим у нас есть JSON без параметра загрузки

Альдо Флорес @alduar http://alduar.blogspot.com

alduar
источник
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