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

Question

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

指定一个字段总是首先出现就足够了。

Answer 1

受支持的方法是在要为其设置顺序的类属性上使用JsonProperty属性。 阅读JsonPropertyAttribute 订单文档以获取更多信息。

将JsonProperty传递给Order值，序列化程序将负责其余的工作。

 [JsonProperty(Order = 1)]

这非常类似于

 DataMember(Order = 1) 

System.Runtime.Serialization天数。

这是@kevin-babcock 的重要说明

... 仅当您在所有其他属性上设置大于 1 的订单时，将订单设置为 1 才有效。 默认情况下，任何没有 Order 设置的属性都将被赋予 -1 的顺序。 所以你必须要么给出所有序列化的属性和顺序，要么将你的第一个项目设置为 -2

Answer 2

您实际上可以通过实现IContractResolver或覆盖DefaultContractResolver的CreateProperties方法来控制顺序。

这是我对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);

Answer 3

在我的情况下，马蒂亚斯的回答不起作用。 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;
    }
}

Answer 4

在我的情况下，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;
        }
    }
}

Answer 5

这也适用于普通类、字典和 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);

Answer 6

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

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

Answer 7

如果您不想在每个类属性上放置JsonProperty Order属性，那么制作自己的 ContractResolver 非常简单...

IContractResolver 接口提供了一种自定义 JsonSerializer 如何将 .NET 对象序列化和反序列化为 JSON 的方法，而无需在类上放置属性。

像这样：

private class SortedPropertiesContractResolver : DefaultContractResolver
{
    // use a static instance for optimal performance
    static SortedPropertiesContractResolver instance;

    static SortedPropertiesContractResolver() { instance = new SortedPropertiesContractResolver(); }

    public static SortedPropertiesContractResolver Instance { get { return instance; } }

    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        var properties = base.CreateProperties(type, memberSerialization);
        if (properties != null)
            return properties.OrderBy(p => p.UnderlyingName).ToList();
        return properties;
    }
}

实施：

var settings = new JsonSerializerSettings { ContractResolver = SortedPropertiesContractResolver.Instance };
var json = JsonConvert.SerializeObject(obj, Formatting.Indented, settings);

Answer 8

实际上，由于我的 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));

Answer 9

如果您只想将单个属性拉到前面而不考虑可能不直观的数字系统，只需使用int.MinValue 。

[JsonProperty(Order = int.MinValue)]

Answer 10

以下递归方法使用反射对现有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);
    }
}

Answer 11

如果您控制（即编写）该类，请将属性按字母顺序排列，当JsonConvert.SerializeObject()被调用时，它们将按字母顺序序列化。

Answer 12

我想序列化一个 Complex 对象并保持属性的顺序，就像它们在代码中定义的那样。 我不能只添加[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();
    }
}

Answer 13

如果您想使用有序字段全局配置您的 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();
    }
}

我的回答在这里：

如何强制 ASP.NET Web API 始终返回 JSON？

Answer 14

更新

我刚刚看到了downvotes。 请参阅下面“史蒂夫”的答案，了解如何执行此操作。

原来的

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

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

其中 values 是引入的 IList 参数。

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

Answer 15

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

{ id: 1, name: 'John' }等价于{ name: 'John', id: 1 } （都代表一个严格等价的对象实例）