Swift中如何从实例生成对象初始化代码用于单元测试

问题背景 #

在单元测试场景中，需要根据运行时实例生成可重建它的最简Swift代码。例如定义如下User结构体：

struct User {
    enum Role {
        case admin, marketing, tester, developer, sales
    }

    let name: String
    let email: String

    let icon: URL?
    let roles: [Role]

    public init(name: String, email: String, icon: URL? = nil, roles: [Role]? = nil) {
        self.name = name
        self.email = email
        self.icon = icon
        self.roles = roles
    }
}

运行时得到的实例输出为：

▿ User
  - name: "John Appleseed"
  - email: "john@example.com"
  - icon: nil
  ▿ roles: Optional([User.Role.admin])
    ▿ some: 1 element
      - User.Role.admin

期望生成的最简重建代码是：

User(
    name: "John Appleseed",
    email: "john@example.com",
    roles: [.admin]
)

使用print(String(reflecting: user))的基础输出存在模块前缀冗余、显式可选类型、包含nil属性、无缩进格式化等问题。尝试让类型遵循CustomReflectable虽有改善，但存在枚举值类型冗长、代码无缩进、需为所有类型维护协议的高工作量问题。

优化方案 #

1. 基于Swift Mirror的通用解析工具 #

无需让所有类型遵循协议，直接通过Mirror遍历实例属性，实现通用处理：

• 过滤nil属性：遍历属性时跳过值为nil的属性（尤其是带有默认值的可选属性）
• 简化枚举值：对于枚举类型，提取其case名称，去掉类型前缀；若枚举嵌套在结构体中，使用.前缀简化
• 移除模块前缀：解析类型名称时，去掉模块名部分
• 格式化缩进：生成代码时添加层级缩进，保持可读性

示例核心代码：

func generateInstanceCode<T>(_ instance: T) -> String {
    let mirror = Mirror(reflecting: instance)
    let typeName = String(describing: type(of: instance)).components(separatedBy: ".").last ?? ""
    
    var properties = [String]()
    let indent = "    "
    
    for child in mirror.children {
        guard let label = child.label else { continue }
        
        // 处理可选值，解包后的值非nil才保留
        let value: Any
        if let optional = child.value as? OptionalProtocol, let unwrapped = optional.unwrapped {
            value = unwrapped
        } else if case Optional<Any>.none = child.value {
            continue // 跳过nil属性
        } else {
            value = child.value
        }
        
        // 格式化属性值
        let valueString: String
        switch value {
        case let enumCase as CustomStringConvertible:
            let desc = enumCase.description
            valueString = desc.contains(".") ? desc.components(separatedBy: ".").last! : ".\(desc)"
        case let array as [Any]:
            let elementStrings = array.map { generateValueString($0) }
            valueString = "[\(elementStrings.joined(separator: ", "))]"
        case let string as String:
            valueString = "\"\(string)\""
        default:
            valueString = String(describing: value)
        }
        
        properties.append("\(indent)\(label): \(valueString)")
    }
    
    return "\(typeName)(\n\(properties.joined(separator: ",\n"))\n)"
}

// 辅助协议处理可选值
private protocol OptionalProtocol {
    var unwrapped: Any? { get }
}

extension Optional: OptionalProtocol {
    var unwrapped: Any? { self }
}

private func generateValueString(_ value: Any) -> String {
    if let enumCase = value as? CustomStringConvertible {
        let desc = enumCase.description
        return desc.contains(".") ? desc.components(separatedBy: ".").last! : ".\(desc)"
    } else if let string = value as? String {
        return "\"\(string)\""
    } else {
        return String(describing: value)
    }
}

2. 利用SwiftSyntax生成格式化代码 #

如果需要更严谨的代码生成（比如处理复杂类型、泛型等），可以使用SwiftSyntax库：

• 它能直接构建抽象语法树（AST），确保生成的代码语法正确
• 可配置代码风格（缩进、换行等）
• 自动处理类型简化、可选值解包等逻辑

核心思路是通过Mirror解析实例属性，然后用SwiftSyntax的API构建FunctionCallExprSyntax节点，最终输出格式化后的代码。

3. 轻量字符串替换增强 #

如果不想引入复杂工具，可在反射输出基础上做针对性字符串替换：

• 移除模块前缀：用正则替换\w+\.为空（针对类型前缀）
• 移除可选包装：替换Optional<(.+?)>\(some: (.+?))为$2
• 过滤nil属性：删除包含: nil的行
• 简化枚举值：替换User\.Role\.为.
• 添加缩进：对属性行统一添加缩进

示例正则替换逻辑：

func cleanReflectOutput(_ input: String) -> String {
    var output = input
    // 移除模块前缀
    output = output.replacingOccurrences(of: "\\w+\\.(?=[A-Z])", with: "", options: .regularExpression)
    // 解包可选值
    output = output.replacingOccurrences(of: "Optional<\\w+>\\(some: (.+?)\\)", with: "$1", options: .regularExpression)
    // 移除nil属性行
    output = output.components(separatedBy: "\n").filter { !$0.contains(": nil") }.joined(separator: "\n")
    // 简化枚举值
    output = output.replacingOccurrences(of: "\\w+\\.Role\\.", with: ".", options: .regularExpression)
    // 添加缩进
    let lines = output.components(separatedBy: "\n")
    let indentedLines = lines.enumerated().map { index, line in
        if index == 0 || line.hasSuffix(")") { return line }
        return "    " + line.trimmingCharacters(in: .whitespaces)
    }
    return indentedLines.joined(separator: "\n")
}

总结 #

• 通用Mirror解析工具适合大多数场景，无需修改现有类型，代码轻量化
• SwiftSyntax适合复杂项目，保证代码正确性和可扩展性
• 轻量字符串替换适合快速临时解决问题，但对复杂类型支持有限

内容的提问来源于stack exchange，提问作者Tieme