LiteDB中私有属性与长整型字段映射问题解析

问题背景

在使用LiteDB 5.0.21版本与.NET 8环境时，开发者遇到了一个关于对象映射的典型问题：当实体类中包含一个长整型(long)的私有set属性时，从数据库查询返回的对象中该属性值始终为零，而将set访问器改为public后则能正常显示数据库中的值。

问题重现

通过以下代码可以重现该问题：

public abstract class BaseEntity
{
    protected BaseEntity(Guid id) => Id = id;
    
    public void SetTicks() => Tick = DateTime.UtcNow.Ticks;

    [BsonId]
    public Guid Id { get; private set; }

    public long Tick { get; private set; }  // 问题所在：私有set导致映射失败
}

当Tick属性的set访问器为private时，从数据库查询返回的对象中Tick值始终为0；改为public后则能正确映射数据库中的值。

技术原理分析

这个问题实际上涉及LiteDB的核心对象映射机制：

1. 对象序列化机制：LiteDB在将BSON文档反序列化为.NET对象时，需要通过反射来设置属性值。对于私有set属性，标准的反射机制无法直接设置值。

2. 设计限制：LiteDB的默认BsonMapper实现只处理具有公共set访问器的属性，这是出于性能和安全性考虑的设计选择。

3. 类型特殊性：虽然问题中表现为long类型，但实际上这是所有类型属性的通用行为，与具体类型无关。

解决方案

对于需要保持属性封装性又需要LiteDB映射的场景，有以下几种解决方案：

1. 最简单的方案：将set访问器改为public

   public long Tick { get; set; }
   

2. 使用字段替代属性（需要自定义映射）：

   private long _tick;
   public long Tick => _tick;
   

3. 自定义BsonMapper（高级方案）： 继承BsonMapper并重写相关方法，实现对私有属性的支持。

最佳实践建议

1. DTO模式：考虑使用专门的数据传输对象(DTO)用于数据库交互，保持领域模型的纯洁性。

2. 显式映射：对于需要特殊处理的属性，可以使用[BsonField]等特性进行显式配置。

3. 文档设计：在设计文档数据库模型时，应优先考虑简单直接的属性设计，避免过度封装。

总结

这个问题揭示了ORM/ODM工具在对象映射时的常见限制。LiteDB作为轻量级文档数据库，默认不支持私有属性的映射是出于性能和复杂度的权衡。开发者应根据项目需求，在数据访问便捷性和对象封装性之间找到平衡点。对于大多数应用场景，使用public setter是最简单有效的解决方案；对于有严格封装要求的场景，则需要考虑更高级的自定义映射方案。