FreeSql中AuditValue审计功能与Repository更新问题的分析与解决

问题背景

在使用FreeSql ORM框架时，开发人员发现当同时使用AuditValue审计功能、Repository的AttachOnlyPrimary属性以及UpdateAsync方法时，会出现两个主要问题：

1. AuditValue事件被触发了两次
2. 检测到的数据更新不完整

这些问题影响了审计功能的准确性和可靠性，可能导致审计日志记录不完整或重复。

问题分析

经过深入分析，这些问题主要源于FreeSql内部的事件触发机制和Repository的工作方式之间的交互问题。具体表现为：

1. 双重触发：当使用Repository进行更新操作时，FreeSql的内部机制可能导致AuditValue事件被多次触发，这通常发生在实体状态跟踪和实际更新操作两个阶段。

2. 数据不完整：由于事件触发时机的问题，审计功能可能无法捕获到所有被修改的字段，特别是在使用AttachOnlyPrimary模式时，这种模式只附加主键信息，可能导致审计功能无法正确识别所有变更。

解决方案

FreeSql团队在3.5.100-preview20241123版本中解决了这些问题。主要改进包括：

1. 优化事件触发机制：调整了内部事件触发逻辑，确保审计事件只在适当的时机触发一次。

2. 改进数据变更检测：增强了变更检测算法，确保在使用AttachOnlyPrimary时仍能正确识别所有数据变更。

3. 包结构调整：建议用户迁移到FreeSql.DbContext包，该包包含了更完善的实现，而FreeSql.Repository包将不再维护。

升级建议

对于遇到此问题的用户，建议采取以下步骤：

1. 升级到最新预览版本：

   <PackageReference Include="FreeSql.DbContext" Version="3.5.100-preview20241124" />
   <PackageReference Include="FreeSql.Provider.Sqlite" Version="3.5.100-preview20241123" />
   

2. 移除对FreeSql.Repository的引用，完全使用FreeSql.DbContext替代。

3. 重新测试审计功能，确保在AttachOnlyPrimary和UpdateAsync组合使用时审计日志记录正常。

技术细节

在底层实现上，FreeSql团队优化了实体状态管理和变更跟踪的流程。新的实现确保：

• 审计事件只在实体实际提交到数据库前触发一次
• 即使在使用AttachOnlyPrimary时，也能正确捕获所有字段变更
• 保持了高性能的同时提供了更可靠的审计功能

总结

FreeSql作为一款功能强大的ORM框架，不断优化其内部机制以提供更好的开发体验。这次对审计功能的改进解决了在实际开发中遇到的具体问题，特别是与Repository模式结合使用时的一些边界情况。开发者应及时升级到最新版本以获得这些改进，并遵循推荐的包使用方式，以获得最佳的功能支持和稳定性。