¿Cómo puedo excluir algunas propiedades públicas de ser serializadas en un JsonResult?

Question

Tengo un modelo de vista personalizado que se serializó usando un JsonResult. ViewModel tiene algunas propiedades que deben ser públicas, pero al mismo tiempo estas propiedades no deberían estar visibles en la salida resultante de Json.

Ya he intentado utilizar el atributo [NonSerialized], pero eso no pareció tener ningún efecto.

¿Hay alguna manera simple de hacer esto? ¿O tendría que codificar mi propio tipo de resultado (en cuyo caso probablemente no me moleste)?

Answer 1

Puede poner un atributo [ScriptIgnore] en los miembros que no se deben serializar. Ver ScriptIgnoreAttribute Class in MSDN para un ejemplo.

Answer 2

No es exactamente la respuesta que está buscando, pero puede hacer trampa Json() usando el siguiente código y clases anónimas:

MyModel model = ...; 
return Json(new MyModel {model.Prop1, model.Prop2}); 

Answer 3

Puede crear una clase contenedora que expone sólo aquellas propiedades que desee en el JsonResult. En el siguiente ejemplo, Cow tiene 2 propiedades: "Leg" y "Moo". Supongamos que quiere exponer solo "Leg" como una propiedad. Entonces

Dim cw como CowWrapper = Nueva CowWrapper (c)

devolverá una clase contenedora que sólo expone "Pierna". Esto también es útil para cosas como DataGridView si solo quieres mostrar algún subconjunto de las propiedades.

Public Class vaca

Pública de sólo lectura de la pierna de Propiedad() As String

get 

     return "leg" 

    end get 

extremo propiedad

Pública de sólo lectura MOO propiedad() As String

get 

     return "moo" 

    end get 

extremo propiedad

fin de la clase

Public Class CowWrapper

Private m_cow as Cow = Nothing 

Public Sub New(ByVal cow as Cow) 

    m_cow = cow 

end Sub 


    m_cow = cow 

Pública de sólo lectura de la pierna de Propiedad() As String

get 

     return m_cow.Leg() 

    end get 

extremo propiedad

Clase final

Answer 4

extender la clase JavaScriptConverter a no incluir prope rties con el NonSerializedAttribute. Luego puede crear un ActionResult personalizado que use su JavaScriptConverter para serializar el objeto.

Esto crea una clase sólida y comprobable sin tener que (re) generar clases de envoltura ni usar objetos anónimos.

Answer 5

Echa un vistazo a JSON.NET de James Newton-King. Hará lo que estás buscando.

Answer 6

Simplemente cree una interfaz para devolver en lugar de una clase.

public interface IMyViewModel { 
    string MyPublicProperty { get; set; } 
} 

A continuación, cree una clase que hereda la interfaz

public class MyViewModel : IMyViewModel { 
    public string MyPublicProperty { get; set; } 
    public string MyNotSoPublicProperty { get; set; } 
} 

y devolver la interfaz, no a la clase, en el controlador de Acción

public JsonResult MyJson(){ 
    IMyViewModel model = new MyViewModel(); 
    return Json(model); 
} 

Y el JSON resultante será

{ 
    'MyPublicProperty': '' 
} 

Uno de los desafíos en las secuencias de comandos del lado del cliente es que, si está cambiando las clases, no tiene idea de si está destruyendo la implementación del lado del cliente o no. Si utiliza tipos de interfaz en su JSON, comprenderá que si cambia la interfaz, está haciendo algo que posiblemente mate la implementación del lado del cliente. Y también le evita duplicar la verificación del lado del cliente en vano si está cambiando algo que NO está en la interfaz (por lo que no se serializa).

También, muchas veces, sus ViewModels pueden tener grandes colecciones o tipos complejos en ellos que no necesariamente desea entregar al cliente. Puede llevar mucho tiempo serializar o exponer información que simplemente no pertenece al código del cliente. El uso de interfaces hará que sea más transparente saber qué es lo que está en la salida.

Además, el uso de atributos como [ScriptIgnore] en una propiedad solo se aplica a un escenario específico (Serialización de JavaScript), lo que le obliga a enfrentar exactamente el mismo problema si posteriormente lo serializa a XML, por ejemplo. Esto innecesariamente ensuciaría tus modelos de vista con toneladas de atributos. ¿Cuántos de ellos realmente quieres allí? El uso de intefaces se aplica en cualquier lugar y ningún modelo de vista debe estar repleto de atributos adicionales.