深入了解Swift Package Manager:从入门到实践

219 阅读4分钟

基础介绍

Swift Package Manager(SPM)是苹果公司为Swift语言精心打造的依赖管理工具。它与Swift语言紧密集成,支持多种平台(包括iOS、macOS和Linux),能够高效地自动化处理包的依赖关系,包括下载、编译、链接和管理等环节。

核心概念

主要特点

Package

包含Swift源代码和Package.swift配置文件的目录。

Products

包对外提供的产物,如库(Library)和可执行程序(Executable)。其中,库是最常见的类型,可被其他代码导入和复用。

Target

构建单元,包含一组源代码文件,可以依赖其他目标,如library或executable。

Dependencies

包所依赖的其他包,SPM会自动获取并构建这些依赖项。

Tools version

指定包支持的最低Swift工具链版本。

主要优势

  • 官方原生支持:由苹果公司开发,与Swift语言和Xcode深度集成,无需额外安装。
  • 跨平台支持:在所有支持Swift的平台上(Linux、macOS、Windows)都能正常工作。
  • 声明式依赖管理:通过Package.swift文件清晰地声明依赖关系。
  • 自动化管理:自动处理依赖的下载、编译和版本冲突解决(采用语义化版本控制)。
  • 与Xcode无缝集成:在Xcode中可以直接编辑和管理Swift包,添加依赖时可以输入包的URL或直接导入包,操作便捷。

常用命令

SPM提供了一系列常用的命令,方便开发者进行包的管理和操作:

swift package init --type library       # 初始化库包
swift build                              # 构建包
swift test                               # 运行测试
swift run <executable-target>            # 运行可执行目标
swift package resolve                    # 解析依赖
swift package update                     # 更新依赖

基本使用

创建Swift包

通过命令行可以快速创建Swift包,命令如下:

# 创建一个库包
swift package init --name MyLib --type library

# 创建一个可执行包
swift package init --name MyLib --type executable

这将在当前目录生成一个标准的库包结构:

MyLib/
├── Sources/
│   └── MyLib/
│       └── MyLib.swift
├── Tests/
│   └── MyLibTests/
│       └── MyLibTests.swift
└── Package.swift

Package.swift文件

Package.swift配置文件的内容通常如下:

// swift-tools-version:6.0
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription

let package = Package(
    name: "MyLib",
    platforms: [.iOS(.v18), .macOS(.v15)], // 指定包所支持的平台和最低版本
    products: [
        .library(name: "MyLib", targets: ["MyLib"]) // 指编译后的包,对外提供
    ],
    dependencies: [ // 声明此包所依赖的外部包
        .package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.8.0")
    ],
    targets: [ // 定义包的相关信息
        .target(
            name: "MyLib",
            dependencies: ["Alamofire"],
            resources: [.process("Resources")]
        ),
        .testTarget(
            name: "MyLibTests",
            dependencies: ["MyLib"]
        )
    ]
)

MyLib.swift文件

Sources目录是实现代码的存放位置,MyLib.swift一般作为程序的入口,用于处理命令行参数并调用核心功能。

构建和测试

# 编译包
swift build

# 运行测试
swift test

# 运行包
swift run

在Xcode中导入包

  1. 在Xcode中打开你的项目。
  2. 选择菜单栏的File > Add Packages...
  3. 在弹出的窗口中,选择Add Local添加本地的package,或输入包存在的网址。
  4. 选择完成后,点击Add Package,Xcode会自动解析并下载该包及其所有依赖项。
  5. 依赖的包会出现在项目导航器的Package Dependencies部分,然后可以在代码中直接import使用。

在Xcode中删除包

如果在Xcode中导入包后,无法在Package Dependencies部分删除包,可以在项目.xcodeproj包内内容下的project.pbxproj里进行包的删除,删除后保存文件即可。

安全防范

安全风险

编译后的Swift包通常以库或资源的形式存放在App内。如果是静态库,其目标代码会被链接到主可执行文件内;如果是动态框架,则会内嵌到App包的Frameworks目录下。由于目标文件包含汇编指令和符号表等信息,使用反编译工具仍可反编译为类C伪代码。因此,对静态库和目标文件的保护至关重要。

防范措施

Virbox Protector工具在保护静态库和动态库文件方面有成熟方案,可实现函数级和整体保护。静态库保护方案可参考官网文档静态库和目标文件保护最佳实践,动态库保护方案可参考官网文档Native程序保护最佳实践