Sourcery项目中Automockable生成器对复合类型处理的问题分析

问题背景

在Swift开发中，Sourcery是一个强大的代码生成工具，其中的Automockable模板可以自动为协议生成Mock实现类。然而，在处理包含复合类型(如协议组合)的参数时，当前的实现存在一个编译错误问题。

问题现象

当协议方法参数使用协议组合类型(如any (FooProtocol & BarProtocol))时，生成的Mock类会出现编译错误。这是因为生成的变量名中直接包含了&符号，这在Swift中是不合法的标识符字符。

技术分析

当前错误实现

生成的Mock类中，变量命名直接包含了原始类型声明中的&符号，例如：

var executeParameterAnyFooProtocol&BarProtocolVoidCallsCount = 0

这种命名会导致编译器报错，因为&不是有效的标识符字符。

正确实现方式

正确的做法应该是将特殊字符替换为合法字符或完全移除。对于协议组合类型，可以：

1. 移除&符号
2. 用下划线_替代
3. 使用更简洁的命名方式

例如，上述变量应该被命名为：

var executeParameterAnyFooProtocolBarProtocolVoidCallsCount = 0

解决方案

命名规范化处理

在代码生成过程中，需要对类型名称进行规范化处理：

1. 移除所有空格
2. 将特殊字符(如&)替换为下划线或直接移除
3. 确保最终标识符符合Swift命名规范

实现建议

在模板处理阶段，可以添加一个字符串处理过滤器，对类型名称进行净化：

func sanitizeTypeName(_ name: String) -> String {
    return name.replacingOccurrences(of: "&", with: "")
              .replacingOccurrences(of: " ", with: "")
}

影响范围

这个问题会影响所有使用Automockable模板且协议方法包含协议组合类型参数的场景。虽然不常见，但在设计精细的协议体系时，这种用法并不罕见。

最佳实践建议

1. 对于复杂的类型参数，考虑在协议设计时使用typealias简化
2. 在生成Mock前，检查协议方法的参数类型是否包含特殊字符
3. 定期更新Sourcery版本以获取最新的修复和改进

总结

Sourcery的Automockable功能在大多数情况下工作良好，但在处理特殊类型时需要注意命名规范问题。通过适当的字符串处理和命名规范化，可以确保生成的代码始终能够编译通过。这个问题也提醒我们，在自动化代码生成过程中，对输出结果进行充分的验证和测试同样重要。