如何检测LiteDb变更?及模型与LiteDb的结构差异(含新增属性场景)
没问题,我来帮你梳理这两个LiteDB相关的问题,分两部分详细说明:
一、检测LiteDB中的数据变更
LiteDB本身提供了一些原生方案,也可以通过自定义封装实现更灵活的追踪:
利用LiteDB内置事件钩子
LiteDB的LiteDatabase对象自带了一系列Before/After事件,可以监听插入、更新、删除等操作的触发时机。示例代码如下:using var db = new LiteDatabase("mydb.db"); // 监听插入前的操作 db.Events.InsertBefores.Add((collectionName, docs) => { Console.WriteLine($"即将向[{collectionName}]集合插入{docs.Count}条数据"); // 这里可以直接获取待插入的文档内容,记录变更前置信息 }); // 监听更新后的操作 db.Events.UpdateAfters.Add((collectionName, docs) => { Console.WriteLine($"已完成[{collectionName}]集合的{docs.Count}条数据更新"); // 注意:LiteDB默认不会提供旧数据,如果需要对比变更前后的字段值,得在UpdateBefore事件里提前查询旧数据 }); // 监听删除后的操作 db.Events.DeleteAfters.Add((collectionName, ids) => { Console.WriteLine($"已从[{collectionName}]集合删除ID为:{string.Join(",", ids)}的数据"); });这种方式适合快速监听操作事件,但如果需要精确对比字段级的变更差异,就得结合自定义逻辑。
自定义追踪包装类
如果内置事件满足不了需求,你可以自己封装ILiteCollection<T>的操作方法,手动实现变更对比和日志记录。比如:public class TrackedLiteCollection<T> { private readonly ILiteCollection<T> _innerCollection; public TrackedLiteCollection(ILiteCollection<T> collection) { _innerCollection = collection; } public int Update(T newEntity) { // 先查询旧数据 var entityId = BsonMapper.Global.ToDocument(newEntity)["_id"]; var oldEntity = _innerCollection.FindById(entityId); // 对比新旧实体的字段差异 var fieldChanges = CompareEntityChanges(oldEntity, newEntity); // 记录变更日志(可以写入日志文件或LiteDB的专门日志集合) LogChange(fieldChanges); // 执行实际更新 return _innerCollection.Update(newEntity); } // 用反射实现字段对比逻辑 private Dictionary<string, (object OldValue, object NewValue)> CompareEntityChanges(T oldEntity, T newEntity) { var changes = new Dictionary<string, (object, object)>(); var properties = typeof(T).GetProperties(BindingFlags.Public | BindingFlags.Instance); foreach (var prop in properties) { var oldVal = prop.GetValue(oldEntity); var newVal = prop.GetValue(newEntity); if (!Equals(oldVal, newVal)) { changes.Add(prop.Name, (oldVal, newVal)); } } return changes; } private void LogChange(Dictionary<string, (object, object)> changes) { // 这里可以根据需求实现日志存储,比如写入LiteDB的ChangeLogs集合 // using var logDb = new LiteDatabase("mydb.db"); // var logCol = logDb.GetCollection<ChangeLog>("ChangeLogs"); // logCol.Insert(new ChangeLog { Timestamp = DateTime.Now, Changes = changes }); } }这种方式完全自定义,能满足你对变更追踪的精细化需求。
二、检测实体模型与LiteDB集合的结构差异
针对你提到的新增NewCol属性的场景,核心思路就是对比实体类的属性集合和数据库中实际存储的文档字段集合,具体实现如下:
using LiteDB; using System.Reflection; using System.Linq; public static class LiteDbSchemaChecker { public static (List<string> ModelOnlyFields, List<string> DbOnlyFields) CheckSchemaMatch<T>(ILiteCollection<T> collection) { var mapper = BsonMapper.Global; // 1. 获取实体类映射到LiteDB的字段名(处理BsonField等自定义映射) var modelFieldNames = typeof(T).GetProperties(BindingFlags.Public | BindingFlags.Instance) .Select(prop => mapper.GetMemberName(prop)) .ToList(); // 2. 从数据库集合中收集所有存在的字段名(取前10条文档做样本,平衡性能和准确性) var dbFieldNames = new HashSet<string>(); var sampleDocuments = collection.FindAll().Take(10); foreach (var doc in sampleDocuments) { foreach (var fieldKey in doc.Keys) { dbFieldNames.Add(fieldKey); } } // 3. 对比找出差异 var modelOnly = modelFieldNames.Where(field => !dbFieldNames.Contains(field)).ToList(); var dbOnly = dbFieldNames.Where(field => !modelFieldNames.Contains(field)).ToList(); return (modelOnly, dbOnly); } } // 使用示例 using var db = new LiteDatabase("mydb.db"); var tableCollection = db.GetCollection<Table>("table"); var (missingFields, extraFields) = LiteDbSchemaChecker.CheckSchemaMatch(tableCollection); if (missingFields.Any()) { Console.WriteLine($"检测到实体新增了数据库中不存在的字段:{string.Join(", ", missingFields)}"); // 可选:自动迁移,给现有文档添加新字段的默认值 foreach (var field in missingFields) { tableCollection.UpdateMany(BsonDocument.Empty, new BsonDocument { { field, BsonValue.Null } }); } } if (extraFields.Any()) { Console.WriteLine($"检测到数据库中存在实体未定义的字段:{string.Join(", ", extraFields)}"); }
补充说明:
- 用
mapper.GetMemberName(prop)可以正确处理属性的自定义映射(比如用[BsonField("custom_name")]标注的属性),避免字段名对比出错。 - 取前10条文档做样本是为了平衡性能和准确性,如果你的集合中文档字段差异较大,可以适当增加样本数量,或者遍历全量文档(注意性能开销)。
- 如果需要自动同步结构,比如给现有文档添加新字段的默认值,可以用
UpdateMany批量处理。
内容的提问来源于stack exchange,提问作者Atlantis
相关产品推荐
相关产品推荐

