FastEndpoints 项目中 ACL 生成器的字典污染问题解析

问题概述

在 FastEndpoints 5.25.0 版本中，使用源代码生成器为访问控制列表(ACL)生成权限代码时，发现了一个有趣的边界情况问题。当开发者定义权限描述时，生成器错误地将描述字典本身也包含到了权限字典中，导致权限工具函数返回了不正确的值。

问题表现

当开发者按照标准方式定义权限时，例如在端点配置中使用 AccessControl("TestPermission") 方法注册权限，生成的权限工具类 Allow 会包含两个内部字典：_permNames 和 _permCodes。正常情况下，这些字典应该只包含开发者显式定义的权限信息。

然而，在 5.25.0 版本中，Allow 类的静态属性 Descriptions（一个 Dictionary<string, string> 类型）也被错误地添加到了这两个权限字典中。这导致当调用 Allow.AllCodes() 等方法时，返回结果会包含一个意外的条目："System.Collections.Generic.Dictionary2[System.String,System.String]"`。

技术背景

FastEndpoints 的源代码生成器旨在简化权限管理，通过分析代码中的 AccessControl 调用自动生成权限相关的工具方法和数据结构。这种设计减少了手动维护权限列表的工作量，提高了开发效率。

在实现上，生成器会创建一个部分类 Allow，其中包含：

• 权限名称到代码的映射
• 权限代码到名称的映射
• 权限描述字典
• 各种便利方法如 AllCodes(), AllNames() 等

问题根源

经过分析，问题出在源代码生成器的逻辑中，它没有正确区分权限描述字典（Descriptions）和实际的权限条目。生成器在收集类成员时，错误地将描述字典的类型信息也当作一个权限条目处理。

临时解决方案

在官方修复发布前，开发者可以通过扩展 Allow 部分类来手动修正这个问题：

public partial class Allow
{
    static partial void Describe()
    {
        // 移除错误添加的描述字典条目
        _permCodes.Remove("System.Collections.Generic.Dictionary`2[System.String,System.String]");
        _permNames.Remove("Descriptions");
    }
}

这种方法虽然不够优雅，但能确保权限相关功能正常工作。

最佳实践建议

在使用 FastEndpoints 的 ACL 功能时，开发者应当：

1. 定期检查生成的权限列表是否符合预期
2. 在单元测试中加入对权限列表的验证
3. 关注官方更新，及时升级到修复版本

问题影响

这个问题虽然不会导致运行时错误，但会影响：

• 权限枚举功能的正确性
• 可能影响基于权限列表的自动化流程
• 导致前端展示不正确的权限选项

总结

源代码生成器是现代.NET开发中强大的工具，但也需要注意边界情况的处理。FastEndpoints 团队已经意识到这个问题，并在后续版本中进行了修复。开发者在使用这类高级功能时，应当保持对生成代码的审查习惯，确保其符合预期行为。