Sourcery项目中AutoMockable模板处理可变参数的问题解析

概述

Sourcery是一个强大的Swift代码生成工具，其中的AutoMockable模板用于自动生成协议(protocol)的模拟实现(mock)。最近发现该模板在处理可变参数(variadic parameters)时存在编译问题，本文将详细分析这个问题及其解决方案。

问题背景

在Swift中，可变参数允许函数接受零个或多个特定类型的值。语法上通过在参数类型后添加...来表示。例如：

func example(args: String...)

当使用Sourcery的AutoMockable模板为包含可变参数的协议生成mock实现时，生成的代码会出现编译错误。这是因为模板没有正确处理可变参数在存储时的类型转换。

问题表现

考虑以下协议定义：

protocol ExampleVararg {
  func toto(args: any StubWithSomeNameProtocol...)
}

当前AutoMockable模板(2.1.7版本)生成的mock代码会尝试将可变参数直接存储在属性中：

var totoArgsAnyStubWithSomeNameProtocolVoidReceivedArgs: (any StubWithSomeNameProtocol...)?

这种写法会导致编译错误，因为Swift不允许将可变参数类型直接用作属性类型。

正确实现方式

正确的做法是将可变参数转换为数组类型进行存储。对于上述例子，mock实现应该是：

var totoArgsAnyStubWithSomeNameProtocolVoidReceivedArgs: ([(any StubWithSomeNameProtocol)])?

在函数实现中，可变参数会自动转换为数组，因此可以直接存储：

func toto(args: any StubWithSomeNameProtocol...) {
  totoArgsAnyStubWithSomeNameProtocolVoidReceivedArgs = args
  // ...
}

更深层次的问题

这个问题还延伸到了闭包参数中包含可变参数的情况。例如：

func foo(closure: (String...) -> Void)

对于这种情况，正确的mock实现应该是：

var fooClosure: (([String]) -> Void)?

因为Swift本身不支持在闭包类型中直接使用可变参数语法。

解决方案

解决这个问题的核心在于修改AutoMockable模板，使其能够：

1. 识别参数是否为可变参数
2. 对于可变参数，在属性声明中使用数组类型而非可变参数语法
3. 正确处理闭包参数中的可变参数情况

模板中的类型处理宏需要被重写，以区分常规类型和可变参数类型，并做相应的转换。

总结

Sourcery的AutoMockable模板在处理Swift可变参数时需要特别注意类型转换问题。正确的做法是将可变参数视为数组进行存储和传递，这既符合Swift的语言特性，也能保证生成的代码可编译通过。这个问题提醒我们，在使用代码生成工具时，需要充分理解生成的代码与实际语言特性的匹配关系。