Cosmos DB中文档新增属性自动移至底部问题咨询

我太懂这种对文档整洁度的执念了——毕竟谁不想让数据库里的文档结构整整齐齐、一目了然呢！你遇到的这个问题，其实是Newtonsoft.Json的序列化规则加上Cosmos DB的更新特性共同导致的，咱们一步步来解决：

1. 最直接：给所有新增属性显式设置Order值 #

这是最省心的办法，就像你给现有属性做的那样，给每个新增的属性都加上[JsonProperty]并指定Order值，比如新增手机号属性：

[JsonProperty("phoneNumber", Order = 5)] 
public string PhoneNumber { get; set; }

这样它就会乖乖排在email（Order=4）的后面，不会跑到文档底部。

2. 一劳永逸：自定义序列化规则，按类定义顺序排列 #

如果你不想每次加属性都要手动写Order，可以修改全局的Json序列化配置，让序列化器按照你类中属性的定义顺序来排列未指定Order的字段：

首先自定义一个ContractResolver：

public class OrderedContractResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        return type.GetProperties(BindingFlags.Public | BindingFlags.Instance)
            .Select(p => base.CreateProperty(p, memberSerialization))
            // 先按指定的Order排序，没指定的放后面
            .OrderBy(p => 
            {
                var attr = p.AttributeProvider.GetAttributes(typeof(JsonPropertyAttribute), true)
                    .Cast<JsonPropertyAttribute>()
                    .FirstOrDefault();
                return attr?.Order ?? int.MaxValue;
            })
            // 没指定Order的，按类中属性的定义顺序排序
            .ThenBy(p => type.GetProperty(p.PropertyName).MetadataToken)
            .ToList();
    }
}

然后把这个Resolver配置到Cosmos Client的序列化器里：

var jsonSettings = new JsonSerializerSettings
{
    ContractResolver = new OrderedContractResolver(),
    Formatting = Formatting.Indented // 可选，让文档更易读
};

var cosmosClient = new CosmosClient(yourConnectionString, new CosmosClientOptions
{
    Serializer = new NewtonsoftJsonCosmosSerializer(jsonSettings)
});

这样一来，所有没指定Order的属性都会按照你在类里写的顺序排列，不会乱跑到底部。

3. 注意文档更新方式：用Replace而非Patch #

如果你是在更新现有文档，Cosmos DB的PatchItemAsync会只修改指定字段，新增的字段会被追加到文档末尾。这时候你需要改用ReplaceItemAsync，把整个对象重新序列化后写入数据库，这样属性顺序就会严格按照你的配置来。

内容的提问来源于stack exchange，提问作者Sam