Sourcery插件开发终极指南：10个技巧打造专属代码生成工具链

【免费下载链接】Sourcery Meta-programming for Swift, stop writing boilerplate code. 项目地址: https://gitcode.com/gh_mirrors/so/Sourcery

Sourcery是一款强大的Swift元编程工具，能够帮助开发者自动生成重复性代码，显著提升开发效率。本指南将通过10个实用技巧，带你从零开始构建属于自己的Sourcery插件，轻松实现代码自动化生成，告别繁琐的手动编码工作。

一、快速入门：Sourcery核心概念解析 🚀

Sourcery通过模板文件解析Swift代码结构，自动生成相应的代码文件。其核心工作流程包括：代码解析→模板处理→代码生成。项目中提供的daemon.gif动态展示了实时代码生成过程，左侧修改模板文件，右侧立即显示生成结果，真正实现"所见即所得"的开发体验。

Sourcery守护进程模式实时生成代码效果，模板修改与代码生成同步完成

二、环境搭建：3步完成插件开发准备工作

1. 克隆项目仓库

   git clone https://gitcode.com/gh_mirrors/so/Sourcery
   

2. 配置开发环境 确保安装最新版本的Xcode和Swift工具链，项目根目录下的Package.swift定义了所有依赖项，通过swift package resolve命令即可完成依赖配置。

3. 了解项目结构 插件开发主要涉及以下目录：

   • Plugins/SourceryCommandPlugin/：命令行插件实现
   • Sourcery/Templates/：内置模板文件
   • SourceryFramework/Sources/Generating/：代码生成核心逻辑

三、插件开发实战：从模板到命令的完整流程

技巧1：掌握模板语法基础

Sourcery支持Stencil和Swift两种模板格式。以Templates/AutoEquatable.stencil为例，基础语法结构如下：

{% for type in types.classes %}
extension {{ type.name }}: Equatable {
    static func == (lhs: {{ type.name }}, rhs: {{ type.name }}) -> Bool {
        {% for variable in type.variables %}
        lhs.{{ variable.name }} == rhs.{{ variable.name }} &&
        {% endfor %}
        true
    }
}
{% endfor %}

技巧2：创建自定义命令插件

通过继承CommandPlugin协议实现自定义命令，核心代码位于Plugins/SourceryCommandPlugin/SourceryCommandPlugin.swift：

struct SourceryCommandPlugin {
    // 插件实现代码
}

extension SourceryCommandPlugin: CommandPlugin {
    func performCommand(context: PluginContext, arguments: [String]) throws {
        // 命令执行逻辑
    }
}

技巧3：利用注解控制代码生成

在源码中添加特殊注解可以精确控制生成行为：

// sourcery: skipEquality
class User {
    let id: Int
    let name: String
}

通过Parsing/Utils/AnnotationsParser.swift解析注解，实现条件性代码生成。

四、高级技巧：提升插件功能与性能

技巧4：实现模板继承与包含

使用{% include %}指令复用模板片段，如SwiftTemplates/Includes.swifttemplate所示：

{% include "lib/Equality.swift" %}

// 主模板内容

技巧5：利用守护进程模式加速开发

启动daemon模式实现实时代码生成：

sourcery --watch

如daemon.gif展示，修改模板后无需手动运行命令，生成代码会自动更新。

技巧6：调试模板的实用方法

1. 使用{{ type | dump }}打印类型信息
2. 通过{% if debug %}...{% endif %}添加调试代码
3. 查看SourceryTests/Stub/Result/目录下的预期输出文件

五、实战案例：构建Mock生成插件

技巧7：解析协议生成Mock实现

参考Resources/Inside-iOS-Dev-Sourcery-Intro-To-Mocking-Video-Thumbnail.png中的视频教程思路，实现协议自动Mock：

使用Sourcery生成Mock对象的视频教程封面，展示了iOS开发中Mock测试的应用场景

核心实现步骤：

1. 解析协议方法和属性
2. 生成遵循协议的Mock类
3. 添加方法调用记录功能

技巧8：处理泛型与复杂类型

在模板中通过type.genericParameters访问泛型信息，处理复杂类型：

{% for parameter in type.genericParameters %}
{{ parameter.name }}: {{ parameter.typeName }}
{% endfor %}

六、测试与发布：确保插件质量

技巧9：编写插件单元测试

利用SourceryTests/目录下的测试框架，为插件添加单元测试：

• 测试模板渲染结果
• 验证命令行参数解析
• 检查异常处理逻辑

技巧10：插件分发与版本管理

1. 遵循CHANGELOG.md记录版本变更
2. 使用RELEASING.md中的发布流程
3. 通过CocoaPods发布，配置文件为Sourcery.podspec

七、总结与资源推荐

通过本文介绍的10个技巧，你已经掌握了Sourcery插件开发的核心知识。进一步学习可参考：

• 官方文档：docs/usage.html
• 模板示例：Templates/目录下的各类模板文件
• 高级指南：guides/Writing templates.md

Sourcery作为Swift元编程的利器，能够极大减少重复性工作，让开发者专注于核心业务逻辑。开始创建你的第一个插件，体验代码自动生成的魅力吧！✨

【免费下载链接】Sourcery Meta-programming for Swift, stop writing boilerplate code. 项目地址: https://gitcode.com/gh_mirrors/so/Sourcery