Swift-Macros 项目教程

1. 项目的目录结构及介绍

Swift-Macros 项目的目录结构如下：

Swift-Macros/
├── README.md
├── Sources/
│   └── SwiftMacros/
│       ├── MacroKit.swift
│       ├── PublicInit.swift
│       ├── GenerateMock.swift
│       ├── KeyPathIterable.swift
│       ├── StaticMemberIterable.swift
│       └── MoreMacros.swift
├── Tests/
│   └── SwiftMacrosTests/
│       ├── XCTestManifests.swift
│       ├── MacroKitTests.swift
│       ├── PublicInitTests.swift
│       ├── GenerateMockTests.swift
│       ├── KeyPathIterableTests.swift
│       ├── StaticMemberIterableTests.swift
│       └── MoreMacrosTests.swift
├── Package.swift
└── .gitignore

目录结构介绍

• README.md: 项目说明文档。
• Sources/SwiftMacros/: 包含所有宏的实现文件。
  • MacroKit.swift: 宏工具包的入口文件。
  • PublicInit.swift: 生成公共成员初始化器的宏。
  • GenerateMock.swift: 生成测试模拟对象的宏。
  • KeyPathIterable.swift: 类似于 CaseIterable，但用于可用的键路径。
  • StaticMemberIterable.swift: 类似于 CaseIterable，但用于可用的静态成员。
  • MoreMacros.swift: 包含更多宏的实现。
• Tests/SwiftMacrosTests/: 包含所有宏的测试文件。
  • XCTestManifests.swift: 测试清单文件。
  • MacroKitTests.swift: 宏工具包的测试文件。
  • PublicInitTests.swift: 公共成员初始化器的测试文件。
  • GenerateMockTests.swift: 生成测试模拟对象的测试文件。
  • KeyPathIterableTests.swift: 键路径可迭代宏的测试文件。
  • StaticMemberIterableTests.swift: 静态成员可迭代宏的测试文件。
  • MoreMacrosTests.swift: 更多宏的测试文件。
• Package.swift: Swift 包管理文件。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

项目的启动文件是 Sources/SwiftMacros/MacroKit.swift。这个文件是宏工具包的入口文件，包含了项目中所有宏的注册和初始化逻辑。

import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros

public struct MacroKit: MacroProtocol {
    public static func register() {
        // 注册所有宏
        PublicInitMacro.register()
        GenerateMockMacro.register()
        KeyPathIterableMacro.register()
        StaticMemberIterableMacro.register()
        // 其他宏的注册
    }
}

3. 项目的配置文件介绍

项目的配置文件是 Package.swift。这个文件定义了 Swift 包的依赖关系、目标和产品。

// swift-tools-version:5.5
import PackageDescription

let package = Package(
    name: "SwiftMacros",
    products: [
        .library(name: "SwiftMacros", targets: ["SwiftMacros"]),
    ],
    dependencies: [
        .package(url: "https://github.com/apple/swift-syntax.git", from: "0.50500.0"),
    ],
    targets: [
        .target(name: "SwiftMacros", dependencies: [
            .product(name: "SwiftSyntax", package: "swift-syntax"),
            .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
            .product(name: "SwiftSyntaxMacros", package: "swift-syntax"),
        ]),
        .testTarget(name: "SwiftMacrosTests", dependencies: ["SwiftMacros"]),
    ]
)

配置文件介绍

• name: 包的名称。
• products: 定义了包提供的产品，这里是一个库 SwiftMacros。
• dependencies: 定义了包的依赖关系，这里依赖了 swift-syntax 包。
• targets: 定义了包的目标，包括主目标 SwiftMacros 和测试目标 SwiftMacrosTests