POCO属性加JsonPropertyName标注后Cosmos Db LINQ查询映射失效问题

问题根本原因 #

1. LINQ 转SQL的逻辑独立于通用序列化逻辑 #

你遇到的字段名不映射的问题，本质是Cosmos DB SDK中，LINQ查询的SQL生成逻辑和数据读写时的序列化逻辑是两套独立流程：

• 数据写入、读取反序列化时，会走你配置的序列化器（比如System.Text.Json），所以JsonPropertyName标注可以正常识别，完成date_sk和DateSk的映射
• LINQ表达式转Cosmos SQL的逻辑默认不会读取System.Text.Json.Serialization.JsonPropertyName的标注值，只会直接使用C#属性名生成查询字段，导致生成的SQL里用了不存在的DateSk字段。

2. 未配置LINQ序列化器的属性映射规则 #

默认情况下，Cosmos LINQ提供器要么只识别Newtonsoft.Json的[JsonProperty]标注，要么需要显式开启对JsonPropertyName的支持，你没有给GetItemLinqQueryable传入对应的序列化配置，就会直接用C#属性名生成查询语句。

3. 无报错的原因 #

Cosmos DB是无Schema的文档数据库，当查询的字段在文档中不存在时，该字段的取值为undefined，undefined和任何值做等值比较结果都为false，所以查询不会抛出异常，只会返回空结果集。

修复方案 #

你可以根据你使用的SDK版本选择对应的修复方式：

1. 使用System.Text.Json序列化的场景（推荐，适配现有标注）
   如果你用的是V3.28及以上版本的Cosmos SDK，首先在初始化CosmosClient时确保使用System.Text.Json序列化器，其次调用GetItemLinqQueryable时传入LINQ序列化配置，开启JsonPropertyName识别：

   var feeder = GetContainer()
       .GetItemLinqQueryable<TestEntity>(
           linqSerializerOptions: new CosmosLinqSerializerOptions 
           { 
               UseJsonPropertyNameAttribute = true 
           })
       .Where(f => f.DateSk == "2021-11-11");
   

2. 兼容旧版本Newtonsoft.Json序列化的场景
   如果你用的是依赖Newtonsoft.Json的旧版本SDK，将属性的标注替换为Newtonsoft.Json的JsonProperty即可：

   using Newtonsoft.Json;
   
   public class TestEntity { ...
      [JsonProperty("date_sk")]
      public Date DateSk { get; set; }
   }
   

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