OpenIddict配置Azure Cosmos DB时ETag并发兼容问题如何解决
异常根因
这个异常本质是两层配置的逻辑冲突,没有正确对齐两种存储的并发机制要求:
- OpenIddict 的跨存储统一模型设计:所有OpenIddict实体(包括自定义扩展的
CustomOpenIdApplication)在模型构建阶段,默认会将自带的ConcurrencyToken属性标记为并发校验字段,适配关系型数据库的并发控制逻辑。 - Azure Cosmos DB EF Core 提供程序的硬性限制:仅支持将文档内置的系统字段
_etag作为合法的并发校验字段,不认可任何自定义属性作为并发令牌,且只有调用实体构建器的UseETagConcurrency()方法,才能正确触发_etag和实体属性的绑定流程。
之前修复方案无效的核心原因:
给ConcurrencyToken属性链式调用IsETagConcurrency()的操作,本质还是把自定义的ConcurrencyToken字段标记为并发令牌,并没有触发Cosmos提供程序要求的_etag绑定逻辑,模型中依然存在非_etag的并发字段,因此异常持续触发。
对比SQL Server存储无异常的表现,是因为SQL Server的EF Core提供程序原生支持自定义任意属性作为并发令牌,OpenIddict的默认配置完全兼容关系型存储的规则,因此不会触发校验异常。
正确修复步骤
- 保留
base.OnModelCreating(modelBuilder)的原有调用,确保OpenIddict的实体基础配置全部加载完成。 - 获取
CustomOpenIdApplication的实体构建器,先移除OpenIddict默认配置的、基于ConcurrencyToken的并发标记。 - 直接对实体构建器调用Cosmos提供程序原生的
UseETagConcurrency()方法,完成系统_etag字段的并发绑定。
对应的正确配置代码如下:
protected override void OnModelCreating(ModelBuilder modelBuilder) { // 加载OpenIddict自带的全部实体基础配置 base.OnModelCreating(modelBuilder); var customAppBuilder = modelBuilder.Entity<CustomOpenIdApplication>(); // 解绑ConcurrencyToken的并发标记角色 customAppBuilder.Property(b => b.ConcurrencyToken).Metadata.SetIsConcurrencyToken(false); // 启用Cosmos原生_etag并发机制,是Cosmos提供程序唯一认可的并发配置入口 customAppBuilder.UseETagConcurrency(); }
兼容逻辑说明
- 不需要删除
ConcurrencyToken属性本身:OpenIddict的业务逻辑在更新实体时会正常给该属性赋值,只是不再将它作为并发校验的依据,不会影响跨存储的代码一致性。 - 并发控制能力完全不受影响:开启
UseETagConcurrency()后,Cosmos提供程序会自动在文档写入、更新操作中读取系统_etag值做乐观并发校验,完全可以替代OpenIddict原来基于ConcurrencyToken的并发逻辑。 - 无需手动将
ConcurrencyToken映射到_etag字段:UseETagConcurrency()方法已经自动完成了系统字段和实体内置ETag属性的双向绑定,手动配置反而会引发模型映射冲突。
完成上述配置后,即可消除模型校验异常,同时保留正常的乐观并发控制能力,和SQL Server存储场景下的行为保持一致。
内容的提问来源于stack exchange,提问作者user1867325
相关产品推荐
相关产品推荐

