ASP.NET MVC: Contrôle de la sérialisation des noms de propriété avec JsonResult

Est-il un moyen pour contrôler la sortie JSON de JsonResult avec des attributs, semblable à la façon dont vous pouvez utiliser XmlElementAttribute et de ses frères pour contrôler la sortie de la sérialisation XML?

Par exemple, pour la classe suivante:

public class Foo
{
    [SomeJsonSerializationAttribute("bar")]
    public String Bar { get; set; }

    [SomeJsonSerializationAttribute("oygevalt")]
    public String Oygevalt { get; set; }
}

J'aimerais pour ensuite obtenir la sortie suivante:

{ bar: '', oygevalt: '' }

Par opposition à:

{ Bar: '', Oygevalt: '' }
  • Découvrez la nouvelle édition de la Sierra: kohari.org/2009/08/10/siesta-painless-rest-via-asp-net-mvc
  • Ça a l'air prometteur (et intéressant!), mais je m'attendais à quelque chose de déjà cuit. Une façon d'obtenir de l'existant sérialiseur à l'égard de la DataContract attributs?
InformationsquelleAutor Daniel Schaffer | 2009-08-19
  1. 38

    Je voulais quelque chose d'un peu plus cuit dans le cadre de ce que Jarrett a suggéré, voici donc ce que j'ai fait:

    JsonDataContractActionResult:

    public class JsonDataContractActionResult : ActionResult
{
    public JsonDataContractActionResult(Object data)
    {
        this.Data = data;
    }

    public Object Data { get; private set; }

    public override void ExecuteResult(ControllerContext context)
    {
        var serializer = new DataContractJsonSerializer(this.Data.GetType());
        String output = String.Empty;
        using (var ms = new MemoryStream())
        {
            serializer.WriteObject(ms, this.Data);
            output = Encoding.Default.GetString(ms.ToArray());
        }
        context.HttpContext.Response.ContentType = "application/json";
        context.HttpContext.Response.Write(output);
    }
}

    JsonContract() la méthode, ajouté à ma classe de contrôleur de base:

        public ActionResult JsonContract(Object data)
    {
        return new JsonDataContractActionResult(data);
    }

    Exemple D'Utilisation:

        public ActionResult Update(String id, [Bind(Exclude="Id")] Advertiser advertiser)
    {
        Int32 advertiserId;
        if (Int32.TryParse(id, out advertiserId))
        {
            //update
        }
        else
        {
            //insert
        }

        return JsonContract(advertiser);
    }

    Remarque: Si vous êtes à la recherche de quelque chose de plus performant que JsonDataContractSerializer, vous pouvez faire la même chose à l'aide de JSON.NET au lieu de cela. Alors que JSON.NET ne semble pas utiliser DataMemberAttribute, il possède son propre JsonPropertyAttribute qui peut être utilisé pour accomplir la même chose.

    • La partie impressionnante sur MVC est de savoir comment facile ce genre de choses est d'écrire. Vous pouvez mettre ensemble vraiment de des solutions sophistiquées assez rapidement!
    • En effet, il est! Je n'ai pas l'intention de jamais regarder en arrière pour WebForms.
    • Très belle solution! Le JsonDataContractActionResult classe peut être simplifié davantage si vous héritez de JsonResult au lieu de la base ActionResult - alors vous n'avez qu'à remplacer le ExecuteResult méthode!
    • J'ai peut être raté quelque chose, mais je ne pense pas que le memorystream est nécessaire. Vous pouvez écrire directement à la réponse outputstream: sérialiseur.WriteObject(contexte.HttpContext.Réponse.OutputStream, Données); j'ai essayé et ça semble bien fonctionner...
    InformationsquelleAutor Daniel Schaffer
  2. 16

    Voici ma mise en œuvre de Daniel Schaffer réponse, avec les améliorations suggérées par Justin Rusbatch et Daniel incorporated.

    using System;
using System.Runtime.Serialization.Json;
using System.Web.Mvc;

public class JsonDataContractActionResult : JsonResult
{
    public JsonDataContractActionResult( Object data )
    {
        this.Data = data;
    }

    public override void ExecuteResult( ControllerContext context )
    {
        var serializer = new DataContractJsonSerializer( this.Data.GetType() );
        context.HttpContext.Response.ContentType = "application/json";
        serializer.WriteObject( context.HttpContext.Response.OutputStream, 
            this.Data );
    }
}
    • +1 - du mieux que je peux dire, le DataContractJsonSerializer est toujours pas pris en charge directement dans MVC 4, donc c'est une solution élégante.
    InformationsquelleAutor Charlie Kilian
  3. 5

    Je sais que c'est une vieille question, mais pour ceux qui sont à la recherche pour juste comment éviter les propriétés d'être sérialisé utiliser le ScriptIgnoreAttribute dans l'espace de noms System.Web.Script.La sérialisation. Malheureusement toujours pas controler le nom de la sérialisé propriétés, mais quelqu'un pourrait trouver cela utile.

    public class MyClass {

    [ScriptIgnoreAttribute]
    public bool PropertyNotSerialized { get; set; }

    public bool AnyProperty { get; set; }
}

    Sera de sortie en tant que résultat Json suivantes:

    {"AnyProperty ": false}
    • Je peux confirmer que cela fonctionne. Cet espace est situé dans le Système.Web.Les Extensions de l'assemblée.
    • Parfait... Tanx beaucoup, Il fonctionne correctement...
    InformationsquelleAutor Danny Pérez
  4. 4

    C'est la solution à utiliser NewtonSoft Json.Net (pour la performance)
    J'ai trouvé une partie de la solution ici et SI

    public class JsonNetResult : ActionResult
{
public Encoding ContentEncoding { get; set; }
public string ContentType { get; set; }
public object Data { get; set; }
public JsonSerializerSettings SerializerSettings { get; set; }
public Formatting Formatting { get; set; }
public JsonNetResult(object data, Formatting formatting)
: this(data)
{
Formatting = formatting;
}
public JsonNetResult(object data):this()
{
Data = data;
}
public JsonNetResult()
{
Formatting = Formatting.None;
SerializerSettings = new JsonSerializerSettings();
}
public override void ExecuteResult(ControllerContext context)
{
if (context == null)
throw new ArgumentNullException("context");
var response = context.HttpContext.Response;
response.ContentType = !string.IsNullOrEmpty(ContentType)
? ContentType
: "application/json";
if (ContentEncoding != null)
response.ContentEncoding = ContentEncoding;
if (Data == null) return;
var writer = new JsonTextWriter(response.Output) { Formatting = Formatting };
var serializer = JsonSerializer.Create(SerializerSettings);
serializer.Serialize(writer, Data);
writer.Flush();
}
}

    De sorte que, dans mon contrôleur, je peux le faire

            return new JsonNetResult(result);

    Dans mon modèle, je peux maintenant avoir:

        [JsonProperty(PropertyName = "n")]
public string Name { get; set; }

    Remarque que maintenant, vous devez définir le JsonPropertyAttribute pour chaque propriété que vous souhaitez sérialiser.

    • un million de mercis
    InformationsquelleAutor Daniel
  5. 1

    La réponse est facile: la DataContractJsonSerializer doit respecter les [DataContract] et [DataMember] attributs dans le Système.Moment de l'exécution.La sérialisation de l'espace de noms de la BCL.

    • Pour être clair pour ceux qui ne connaissent pas, Nate est l'expression de l'-désiré - le comportement de la MVC, pas le vrai comportement de la MVC aujourd'hui. Comme de MVC2, MVC utilise le JavaScriptSerializer, qui ne prend pas en charge les attributs DataMember pris en charge par la WCF DataContract sérialiseur. Une coutume ActionResult est nécessaire aujourd'hui de faire MVC utiliser le DataContract/DataMember attributs.
    InformationsquelleAutor Nate Kohari