如何从Json序列化中排除属性

abithluo  于 2023-07-01  发布在  其他
关注(0)|答案(9)|浏览(210)

我有一个DTO类,我序列化它

Json.Serialize(MyClass)

我怎么能排除它的一个公共属性?
(It必须是公共的,因为我在其他地方的代码中使用了它)

eqfvzcg8

eqfvzcg81#

如果你使用的是Json.Net属性[JsonIgnore]在序列化或反序列化时会忽略字段/属性。

public class Car
{
  // included in JSON
  public string Model { get; set; }
  public DateTime Year { get; set; }
  public List<string> Features { get; set; }

  // ignored
  [JsonIgnore]
  public DateTime LastModified { get; set; }
}

或者,您可以使用DataContract和DataMember属性来选择性地序列化/反序列化属性/字段。

[DataContract]
public class Computer
{
  // included in JSON
  [DataMember]
  public string Name { get; set; }
  [DataMember]
  public decimal SalePrice { get; set; }

  // ignored
  public string Manufacture { get; set; }
  public int StockCount { get; set; }
  public decimal WholeSalePrice { get; set; }
  public DateTime NextShipmentDate { get; set; }
}

有关详细信息,请参阅http://james.newtonking.com/archive/2009/10/23/efficient-json-with-json-net-reducing-serialized-json-size

czfnxgou

czfnxgou2#

**如果你在.NET framework中使用System.Web.Script.Serialization**你可以在不应该被序列化的成员上放置一个ScriptIgnore属性。请看here的例子:

考虑以下(简化)情况:

public class User {
    public int Id { get; set; }
    public string Name { get; set; }
    [ScriptIgnore]
    public bool IsComplete
    {
        get { return Id > 0 && !string.IsNullOrEmpty(Name); }
    } 
}

在这种情况下,只有Id和Name属性将被序列化,因此生成的JSON对象将如下所示:

{ Id: 3, Name: 'Test User' }

**PS.**不要忘记添加对“System.Web.Extensions“的引用,这样才能正常工作

exdqitrt

exdqitrt3#

  • 编辑2023-06-29:更新了答案并添加了有关.NET核心和System.Text.json * 的信息

如果你不想用一些属性来修饰属性,或者你没有访问类的权限,或者你想决定在运行时 * 序列化什么,下面是你的操作方法:

1.在Newtonsoft.Json中

Newtonsoft的解决方案非常简单:

//short helper class to ignore some properties from serialization
public class IgnorePropertiesResolver : DefaultContractResolver
{
    private readonly HashSet<string> ignoreProps;
    public IgnorePropertiesResolver(IEnumerable<string> propNamesToIgnore)
    {
        this.ignoreProps = new HashSet<string>(propNamesToIgnore);
    }

    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        JsonProperty property = base.CreateProperty(member, memberSerialization);
        if (this.ignoreProps.Contains(property.PropertyName))
        {
            property.ShouldSerialize = _ => false;
        }
        return property;
    }
}

用途

JsonConvert.SerializeObject(YourObject, new JsonSerializerSettings()
        { ContractResolver = new IgnorePropertiesResolver(new[] { "Prop1", "Prop2" }) });

如果您决定使用这个答案,请确保缓存ContractResolver对象,否则性能可能会受到影响。
我在这里发布了代码,以防有人想添加任何东西:https://github.com/jitbit/JsonIgnoreProps

2.在System.Text.Json

.NET核心默认使用System.Text.Json,它更快,但你没有Newtonsoft的所有灵活性。然而,这里有一些在运行时排除属性***的解决方案***:
1.在.NET 7及更高版本中,您可以控制哪些属性被序列化,如下所述:https://devblogs.microsoft.com/dotnet/system-text-json-in-dotnet-7/#example-conditional-serialization
1.在.NET 6(及更低版本)中,你可以强制转换到一个接口(我个人认为这是最干净的)或使用Map器。这两个选项都在本答案https://stackoverflow.com/a/61344654/56621中描述

nx7onnlm

nx7onnlm4#

可以使用[ScriptIgnore]

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    [ScriptIgnore]
    public bool IsComplete
    {
        get { return Id > 0 && !string.IsNullOrEmpty(Name); }
    }
}

在这种情况下,将只序列化Id和名称

ejk8hzay

ejk8hzay5#

如果你不像我一样热衷于用属性来装饰代码,尤其是当你在编译时无法判断会发生什么的时候,这里是我的解决方案。
使用JavaScript序列化程序

public static class JsonSerializerExtensions
{
    public static string ToJsonString(this object target,bool ignoreNulls = true)
    {
        var javaScriptSerializer = new JavaScriptSerializer();
        if(ignoreNulls)
        {
            javaScriptSerializer.RegisterConverters(new[] { new PropertyExclusionConverter(target.GetType(), true) });
        }

        return javaScriptSerializer.Serialize(target);
    }
        
    public static string ToJsonString(this object target, Dictionary<Type, List<string>> ignore, bool ignoreNulls = true)
    {
        var javaScriptSerializer = new JavaScriptSerializer();
        foreach (var key in ignore.Keys)
        {
            javaScriptSerializer.RegisterConverters(new[] { new PropertyExclusionConverter(key, ignore[key], ignoreNulls) });
        }
        return javaScriptSerializer.Serialize(target);
    }
 }
    
    
public class PropertyExclusionConverter : JavaScriptConverter
{
    private readonly List<string> propertiesToIgnore;
    private readonly Type type;
    private readonly bool ignoreNulls;
    
    public PropertyExclusionConverter(Type type, List<string> propertiesToIgnore, bool ignoreNulls)
    {
        this.ignoreNulls = ignoreNulls;
        this.type = type;
        this.propertiesToIgnore = propertiesToIgnore ?? new List<string>();
    }
    
    public PropertyExclusionConverter(Type type, bool ignoreNulls)
        : this(type, null, ignoreNulls){}
    
    public override IEnumerable<Type> SupportedTypes
    {
        get { return new ReadOnlyCollection<Type>(new List<Type>(new[] { this.type })); }
    }
    
    public override IDictionary<string, object> Serialize(object obj, JavaScriptSerializer serializer)
    {
       var result = new Dictionary<string, object>();
       if (obj == null)
       {
           return result;
       }
       var properties = obj.GetType().GetProperties();
       foreach (var propertyInfo in properties)
       {
           if (!this.propertiesToIgnore.Contains(propertyInfo.Name))
           {
               if(this.ignoreNulls && propertyInfo.GetValue(obj, null) == null)
               {
                     continue;
               }
               result.Add(propertyInfo.Name, propertyInfo.GetValue(obj, null));
           }
        }
        return result;
    }
    
    public override object Deserialize(IDictionary<string, object> dictionary, Type type, JavaScriptSerializer serializer)
    {
        throw new NotImplementedException(); //Converter is currently only used for ignoring properties on serialization
    }
}
jgwigjjp

jgwigjjp6#

如果你使用的是System.Text.Json,那么你可以使用[JsonIgnore]
FQ:System.Text.Json.Serialization.JsonIgnoreAttribute
官方Microsoft文档:JsonIgnoreAttribute
here所述:
该库作为.NET Core 3.0共享框架的一部分内置。
对于其他目标框架,请安装System.Text.Json NuGet包。该软件包支持:

  • .NET Standard 2.0及更高版本
  • .NET Framework 4.6.1及更高版本
  • .NET Core 2.0、2.1和2.2
pu3pd22g

pu3pd22g7#

对于C# 9的记录,它是[property: JsonIgnore]

using System.Text.Json.Serialization;

public record R(
   string Text2
   [property: JsonIgnore] string Text2)

对于经典样式,它仍然只是[JsonIgnore]

using System.Text.Json.Serialization;

public record R
{
   public string Text {get; init; }

   [JsonIgnore] 
   public string Text2 { get; init; }
}
ivqmmu1c

ivqmmu1c8#

也可以使用[NonSerialized]属性

[Serializable]
public struct MySerializableStruct
{
    [NonSerialized]
    public string hiddenField;
    public string normalField;
}

From the MS docs
指示不应序列化可序列化类的字段。这个类不能被继承。
例如,如果您使用Unity(这不仅适用于Unity),那么这适用于UnityEngine.JsonUtility

using UnityEngine;

MySerializableStruct mss = new MySerializableStruct 
{ 
    hiddenField = "foo", 
    normalField = "bar" 
};
Debug.Log(JsonUtility.ToJson(mss)); // result: {"normalField":"bar"}
ve7v8dk2

ve7v8dk29#

为dotnet核心添加System.Text.Json版本
对于编译时,按照上面的答案添加[JsonIgnore]。
对于运行时,需要将JsonConverter添加到选项中。
首先,为要排除的类型创建一个JsonConverter,例如下面的ICollection<LabMethod>

public class LabMethodConverter : JsonConverter<ICollection<LabMethod>>
{
    public override ICollection<LabMethod> Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        //deserialize JSON into a ICollection<LabMethod>
        return null;
    }

    public override void Write(Utf8JsonWriter writer, ICollection<LabMethod> value, JsonSerializerOptions options)
    {
        //serialize a ICollection<LabMethod> object
        writer.WriteNullValue();
    }
}

然后在序列化Json时添加到选项

var options = new JsonSerializerOptions();
options.Converters.Add(new LabMethodConverter());
var new_obj = Json(new { rows = slice, total = count }, options);

相关问题