Vendure电商平台中EntityHydrator对customFields的重复加载问题分析

问题背景

在Vendure电商平台的核心服务中，EntityHydratorService负责处理实体字段的水合(hydration)操作。水合是指将数据库中的原始数据转换为应用程序中的实体对象的过程。该服务通过检查某些字段是否已存在于本地来避免不必要的数据库查询。

问题现象

在处理customFields(自定义字段)时，EntityHydratorService采用了特殊的处理逻辑。具体表现为：

1. 对于普通字段，服务会将关系路径按点号分割后逐级检查
2. 但对于customFields开头的路径，服务会将整个路径作为单一键名进行检查

这种特殊处理导致了customFields字段总是会被重新从数据库获取，即使它们已经被加载过。

技术分析

在核心代码中，存在以下关键逻辑：

const parts = !relation.startsWith('customFields') ? relation.split('.') : [relation];

这种实现方式会导致以下问题：

1. 对于customFields.myField这样的路径，服务会尝试查找entity['customFields.myField']属性
2. 但实际上customFields是以嵌套对象形式存储的，正确的访问方式应该是entity.customFields.myField
3. 由于第一种访问方式永远不会匹配，customFields总是会被标记为"未加载"，从而触发重复查询

解决方案

经过验证，直接移除对customFields的特殊处理是可行的。即将上述代码简化为：

const parts = relation.split('.');

这种修改后：

1. 服务会正确识别已加载的customFields
2. 不会影响现有功能
3. 减少了不必要的数据库查询

深入探讨

这个问题可能源于早期TypeORM版本的兼容性考虑。随着TypeORM的更新，原先需要特殊处理的情况可能已不复存在。此外，代码中还发现一个相关现象：当关系路径上存在null值时，服务会将其视为"未加载"，而实际上null值可能表示该关系确实不存在（与undefined不同）。

最佳实践建议

对于使用Vendure的开发者，在处理自定义字段时应注意：

1. 监控数据库查询，检查是否有重复加载customFields的情况
2. 考虑更新到包含此修复的版本
3. 对于性能敏感的场景，可以临时应用此修改作为优化

总结

EntityHydratorService中对customFields的特殊处理已不再必要，简化后的代码不仅解决了重复加载问题，还使逻辑更加清晰。这体现了软件迭代过程中持续优化和简化的重要性，也提醒我们在处理特殊case时要定期评估其必要性。