Json Serialization에서 속성을 제외하는 방법


235

직렬화하는 DTO 클래스가 있습니다.

Json.Serialize(MyClass)

공공 재산을 어떻게 제외시킬 수 있습니까?

(어딘가에서 내 코드에서 사용하기 때문에 공개되어야합니다)


4
어떤 직렬화 프레임 워크를 사용하십니까?
Pavel Gatilov

37
IgnoreDataMember ScriptIgnore JsonIgnore사용하는 시리얼 라이저에 따라
LB

3
[NonSerialized] 속성도 주목할 만합니다.이 속성은 속성이 아닌 필드에만 적용 할 수 있지만 JsonIgnore와 동일한 효과를 갖습니다.
Triynko

Trynko의 설명은 매우 유용합니다 .... 필드에서 IgnoreDataMember를 사용하면 오류는 없지만 적용되지는 않습니다.
Tillito

답변:


147

System.Web.Script.Serialization.NET 프레임 워크에서 사용 하는 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 및 Name 속성 만 직렬화되므로 결과 JSON 객체는 다음과 같습니다.

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

추신. System.Web.Extensions이것이 작동 하도록 " "에 대한 참조를 추가하는 것을 잊지 마십시오


10
네임 스페이스 ScriptIgnore에서 찾았 습니다 System.Web.Script.Serialization.
Sorangwala Abbasali

354

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 를 참조하십시오.


37
내가 OP라면 선택한 [ScriptIgnore] 솔루션보다이 답변을 선호합니다. 주로 Json 솔루션의 일치 성으로 인해 Json 문제가 발생합니다. 사용중인 라이브러리가 솔루션을 제공 할 때 System.Web.Extensions가 포함되는 이유는 무엇입니까? Json을 바꾸려면 System.Runtime.Serialization이 모든 serializer와 호환되어야하므로 절대적으로 가장 좋은 IMHO는 [IgnoreDataMember] 특성입니다.
Steve H.

IgnoreDataMember기본 JsonResult시리얼 라이저 에서는 작동하지 않습니다 .
hendryanw

1
NewtonSoft가 방금 저를 완전히 도와주었습니다. 백엔드 용 모델에서 지저분한 속성을 포함시키지 않고 json을 깨끗하게 보이게했습니다.
Sorangwala Abbasali

1
@JC Raja이 속성이 null 인 경우에만 탈염 동안 속성을 무시하는 방법
user123456

1
[NewtonSoft.Json] 직렬화 만 무시하고 싶습니다. 그렇다면 이것에 대한 해결책은 무엇입니까?
Trương Quốc Khánh

31

당신은 사용할 수 있습니다 [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와 이름은 일련 화됩니다.


1
답변의 URL이 손상되었습니다. 되어 [ScriptIgnore]컨트롤러가 기본 MVC 컨트롤러를 사용하는 경우 재산에 무엇을 사용해야 return Json(...?
Don Cheadle

2
나는 그것이 오래된 의견이라는 것을 알고 있지만, [ScriptIgnore]MVC 컨트롤러에서 사용 됩니다. 당신이 사용하는 경우,하지만주의 할 SignalR을 , 당신은 사용해야 [JsonIgnore]도.
Sam

22

죄송합니다. 다른 답변을 충분히 복사하여 붙여 넣을 수 없으므로 다른 답변을 작성하기로 결정했습니다.

일부 속성으로 속성을 장식하고 싶지 않거나 클래스에 액세스 할 수 없거나 런타임 중 직렬화 할 항목 등을 결정하려는 경우 Newtonsoft.Json에서 수행하는 방법은 다음과 같습니다.

//short helper class to ignore some properties from serialization
public class IgnorePropertiesResolver : DefaultContractResolver
{
    private IEnumerable<string> _propsToIgnore;
    public IgnorePropertiesResolver(IEnumerable<string> propNamesToIgnore)
    {
        _propsToIgnore = propNamesToIgnore;
    }
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
        JsonProperty property = base.CreateProperty(member, memberSerialization);
        property.ShouldSerialize = (x) => { return !_propsToIgnore.Contains(property.PropertyName); };
        return property;
    }
}

용법

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

누군가가 아무것도 추가하고 싶을 때 여기에 코드를 게시했습니다.

https://github.com/jitbit/JsonIgnoreProps

중요 업데이트 :ContractResolver 이 답변을 사용하기로 결정한 경우 객체 를 캐시해야합니다 . 그렇지 않으면 성능이 저하 될 수 있습니다.


15

내가 속성을 사용하여 코드를 장식 해야하는 것에 관심이 없다면 컴파일 타임에 여기서 일어날 수있는 일을 할 때 esp가 내 솔루션입니다.

자바 스크립트 시리얼 라이저 사용

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

1
논리가 약간 변경되고 PropertyExclusionConverter가로 바뀔 수 있습니다 PropertyInclusionConverter.
Zarepheth

이것은 단지 굉장
SaiKiran Mandhala

이것에 대한 한 가지 잠재적 인 문제는 객체가 직렬화 될 때마다 이름 일치 및 제외 작업을 수행해야한다는 것입니다. 그러나 컴파일 된 후에는 유형의 속성이 변경되지 않습니다. 유형별로 포함 할 이름을 미리 계산하고 각 행의 목록을 재사용해야합니다. 대규모 JSON 직렬화 작업의 경우 캐싱으로 인해 성능이 눈에 띄게 달라질 수 있습니다.
ErikE

9

사용중인 System.Text.Json경우을 사용할 수 있습니다 [JsonIgnore].
FQ :System.Text.Json.Serialization.JsonIgnoreAttribute

공식 Microsoft 문서 : JsonIgnoreAttribute

여기에 명시된 바와 같이 :

라이브러리는 .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

0

[NonSerialized]속성을 사용할 수도 있습니다

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

MS 문서에서 :

직렬화 가능 클래스의 필드를 직렬화하지 않아야 함을 나타냅니다. 이 클래스는 상속 될 수 없습니다.


예를 들어 Unity를 사용하는 경우 ( 이것은 Unity에만 해당되는 것이 아닙니다 )UnityEngine.JsonUtility

using UnityEngine;

MySerializableStruct mss = new MySerializableStruct 
{ 
    hiddenField = "foo", 
    normalField = "bar" 
};
Debug.Log(JsonUtility.ToJson(mss)); // result: {"normalField":"bar"}
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.