使用JSON.NET的序列化字段的顺序

问题描述 投票:112回答:13

有没有办法使用JSON.NET指定序列化JSON对象中的字段顺序?

指定单个字段始终首先出现就足够了。

c# json json.net
13个回答
-4
投票

我通过反射(其中key是一个IList)跟随JsonConvert.SerializeObject(key)方法调用,并发现JsonSerializerInternalWriter.SerializeList被调用。它需要一个列表并循环通过via

for (int i = 0; i < values.Count; i++) { ...

其中value是引入的IList参数。

简短的回答是......不,没有内置的方法来设置字段在JSON字符串中列出的顺序。


0
投票

如果您控制(即写入)类,则按字母顺序放置属性,并在调用JsonConvert.SerializeObject()时按字母顺序序列化。


0
投票

我想序列化一个comblex对象并保持属性的顺序,就像它们在代码中定义的那样。我不能只添加[JsonProperty(Order = 1)]因为类本身超出了我的范围。

此解决方案还考虑了在基类中定义的属性应具有更高的优先级。

这可能不是防弹,因为没有定义MetaDataAttribute确保正确的顺序,但它似乎工作。对于我的用例,这没关系。因为我只想保持自动生成的配置文件的人类可读性。

public class PersonWithAge : Person
{
    public int Age { get; set; }
}

public class Person
{
    public string Name { get; set; }
}

public string GetJson()
{
    var thequeen = new PersonWithAge { Name = "Elisabeth", Age = Int32.MaxValue };

    var settings = new JsonSerializerSettings()
    {
        ContractResolver = new MetadataTokenContractResolver(),
    };

    return JsonConvert.SerializeObject(
        thequeen, Newtonsoft.Json.Formatting.Indented, settings
    );

}

public class MetadataTokenContractResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(
        Type type, MemberSerialization memberSerialization)
    {
        var props = type
           .GetProperties(BindingFlags.Instance
               | BindingFlags.Public
               | BindingFlags.NonPublic
           ).ToDictionary(k => k.Name, v =>
           {
               // first value: declaring type
               var classIndex = 0;
               var t = type;
               while (t != v.DeclaringType)
               {
                   classIndex++;
                   t = type.BaseType;
               }
               return Tuple.Create(classIndex, v.MetadataToken);
           });

        return base.CreateProperties(type, memberSerialization)
            .OrderByDescending(p => props[p.PropertyName].Item1)
            .ThenBy(p => props[p.PropertyName].Item1)
            .ToList();
    }
}


-1
投票

如果您想使用有序字段全局配置API,请结合Mattias Nordberg答案:

public class OrderedContractResolver : DefaultContractResolver
{
    protected override System.Collections.Generic.IList<JsonProperty> CreateProperties(System.Type type, MemberSerialization memberSerialization)
    {
        return base.CreateProperties(type, memberSerialization).OrderBy(p => p.PropertyName).ToList();
    }
}

我的答案在这里:

How to force ASP.NET Web API to always return JSON?


-6
投票

JSON格式中没有字段顺序,因此定义顺序没有意义。

{ id: 1, name: 'John' }相当于{ name: 'John', id: 1 }(两者都代表一个严格等同的对象实例)


219
投票

支持的方法是在要为其设置顺序的类属性上使用JsonProperty属性。阅读JsonPropertyAttribute order documentation了解更多信息。

JsonProperty传递给Order值,序列化器将负责其余部分。

 [JsonProperty(Order = 1)]

这非常类似于

 DataMember(Order = 1) 

System.Runtime.Serialization天。

这是来自@ kevin-babcock的重要说明

...将订单设置为1只有在所有其他属性上设置大于1的订单时才有效。默认情况下,任何没有Order设置的属性都将被赋予-1的顺序。因此,您必须提供所有序列化属性和订单,或将您的第一个项目设置为-2


117
投票

您实际上可以通过实施IContractResolver或覆盖DefaultContractResolverCreateProperties方法来控制顺序。

这是我简单实现IContractResolver的一个例子,它按字母顺序排列属性:

public class OrderedContractResolver : DefaultContractResolver
{
    protected override System.Collections.Generic.IList<JsonProperty> CreateProperties(System.Type type, MemberSerialization memberSerialization)
    {
        return base.CreateProperties(type, memberSerialization).OrderBy(p => p.PropertyName).ToList();
    }
}

然后设置设置并序列化对象,JSON字段将按字母顺序排列:

var settings = new JsonSerializerSettings()
{
    ContractResolver = new OrderedContractResolver()
};

var json = JsonConvert.SerializeObject(obj, Formatting.Indented, settings);

15
投票

就我而言,Mattias的回答没有用。从未调用过CreateProperties方法。

在对Newtonsoft.Json内部进行一些调试之后,我提出了另一个解决方案。

public class JsonUtility
{
    public static string NormalizeJsonString(string json)
    {
        // Parse json string into JObject.
        var parsedObject = JObject.Parse(json);

        // Sort properties of JObject.
        var normalizedObject = SortPropertiesAlphabetically(parsedObject);

        // Serialize JObject .
        return JsonConvert.SerializeObject(normalizedObject);
    }

    private static JObject SortPropertiesAlphabetically(JObject original)
    {
        var result = new JObject();

        foreach (var property in original.Properties().ToList().OrderBy(p => p.Name))
        {
            var value = property.Value as JObject;

            if (value != null)
            {
                value = SortPropertiesAlphabetically(value);
                result.Add(property.Name, value);
            }
            else
            {
                result.Add(property.Name, property.Value);
            }
        }

        return result;
    }
}

9
投票

在我的情况下,niaher的解决方案不起作用,因为它没有处理数组中的对象。

基于他的解决方案,这就是我提出的

public static class JsonUtility
{
    public static string NormalizeJsonString(string json)
    {
        JToken parsed = JToken.Parse(json);

        JToken normalized = NormalizeToken(parsed);

        return JsonConvert.SerializeObject(normalized);
    }

    private static JToken NormalizeToken(JToken token)
    {
        JObject o;
        JArray array;
        if ((o = token as JObject) != null)
        {
            List<JProperty> orderedProperties = new List<JProperty>(o.Properties());
            orderedProperties.Sort(delegate(JProperty x, JProperty y) { return x.Name.CompareTo(y.Name); });
            JObject normalized = new JObject();
            foreach (JProperty property in orderedProperties)
            {
                normalized.Add(property.Name, NormalizeToken(property.Value));
            }
            return normalized;
        }
        else if ((array = token as JArray) != null)
        {
            for (int i = 0; i < array.Count; i++)
            {
                array[i] = NormalizeToken(array[i]);
            }
            return array;
        }
        else
        {
            return token;
        }
    }
}

3
投票

正如Charlie所指出的,您可以通过在类本身中对属性进行排序来控制JSON属性的排序。不幸的是,这种方法不适用于从基类继承的属性。基类属性将按照它们在代码中的布局进行排序,但会出现在基类属性之前。

对于任何想知道为什么你想要按字母顺序排列JSON属性的人来说,使用原始JSON文件要容易得多,特别是对于具有大量属性的类,如果它们是有序的。


2
投票

这适用于普通类,字典和ExpandoObject(动态对象)。

class OrderedPropertiesContractResolver : DefaultContractResolver
    {
        protected override IList<JsonProperty> CreateProperties(System.Type type, MemberSerialization memberSerialization)
        {
            var props = base.CreateProperties(type, memberSerialization);
            return props.OrderBy(p => p.PropertyName).ToList();
        }
    }



class OrderedExpandoPropertiesConverter : ExpandoObjectConverter
    {
        public override bool CanWrite
        {
            get { return true; }
        }

        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
        {
            var expando = (IDictionary<string, object>)value;
            var orderedDictionary = expando.OrderBy(x => x.Key).ToDictionary(t => t.Key, t => t.Value);
            serializer.Serialize(writer, orderedDictionary);
        }
    }



var settings = new JsonSerializerSettings
        {
            ContractResolver = new OrderedPropertiesContractResolver(),
            Converters = { new OrderedExpandoPropertiesConverter() }
        };

var serializedString = JsonConvert.SerializeObject(obj, settings);

0
投票

以下递归方法使用反射对现有JObject实例上的内部令牌列表进行排序,而不是创建全新的已排序对象图。此代码依赖于内部Json.NET实现细节,不应在生产中使用。

void SortProperties(JToken token)
{
    var obj = token as JObject;
    if (obj != null)
    {
        var props = typeof (JObject)
            .GetField("_properties",
                      BindingFlags.NonPublic | BindingFlags.Instance)
            .GetValue(obj);
        var items = typeof (Collection<JToken>)
            .GetField("items", BindingFlags.NonPublic | BindingFlags.Instance)
            .GetValue(props);
        ArrayList.Adapter((IList) items)
            .Sort(new ComparisonComparer(
                (x, y) =>
                {
                    var xProp = x as JProperty;
                    var yProp = y as JProperty;
                    return xProp != null && yProp != null
                        ? string.Compare(xProp.Name, yProp.Name)
                        : 0;
                }));
    }
    foreach (var child in token.Children())
    {
        SortProperties(child);
    }
}

0
投票

实际上,由于我的Object已经是一个JObject,我使用了以下解决方案:

public class SortedJObject : JObject
{
    public SortedJObject(JObject other)
    {
        var pairs = new List<KeyValuePair<string, JToken>>();
        foreach (var pair in other)
        {
            pairs.Add(pair);
        }
        pairs.OrderBy(p => p.Key).ForEach(pair => this[pair.Key] = pair.Value);
    }
}

然后像这样使用它:

string serializedObj = JsonConvert.SerializeObject(new SortedJObject(dataObject));
© www.soinside.com 2019 - 2024. All rights reserved.