Xcode 中如何使用 SwiftPM(Swift Package Manager)

[阅读难度:简单]

SwiftPM(Swift Package Manager)是 2018 年推出供 Swift 开发者进行包管理的工具,在这之前,老当益壮的 Cocoapods 依旧占据着大量的市场,近年俘获了越来越多开发者的 Carthage。苹果依旧推出了 SwiftPM,现已距推出时过去了两年的时间...


推出 SwiftPM 的原因

在 iOS 开发中,常见的包管理工具有 CocoapodsCarthage

CocoaPods 会自动为项目创建工作区,并自动更新,功能强大,对新人非常友好,易于使用。但对工程来说,CocoaPods 需要在本地维护一个资源库,且对工程干涉过深,对于一些项目模块化需求实践起来并不容易。

Carthage 是一款非常轻量级的工具,轻量级到没有 CocoaPods 那些便捷的命令例如 $pod search,想知道三方库是否支持 Carthage 还得去 github 上看库是否支持。其胜在对项目几乎无干涉,Carthage 工程文件下生成了专门管理依赖库的 Carthage 文件,开发者只需将引入的库拖入项目即可。

Carthage 支持二进制编译,极大的缩短了依赖库在开发中编译时间的开销,这对中大型项目意义重大。 CocoaPods 虽然也可以进行二进制编译,但需要依赖额外的工具库,过程也相当缓慢,个别库的二进制包可能会发生异常或临到发版时报错,到时候还得用非二进制库的方式打包。所以, Cocoapods 最好还是不要全部引入二进制包,其实这也是 CocoaPods 的优点之一,可以在开发中直接对源代码进行查看调试,而引入二进制包的 Carthage 则不行。

那么有没有能避免开发者去使用命令行甚至三方脚本来管理依赖库,对项目 无侵入、简单、易用、易调试,既能包含资源文件,又能针对 Swift 的 跨平台 特点的包管理工具?工具本身用 Swift 写的就更好了。


SwiftPM 中的一些概念

SwiftPM 是什么

SwiftPM 是管理 Swift 代码分发的工具,与 Swift 构建系统集成在一起,可以自动执行依赖项的下载,编译,链接,其本身也是一个库,使用 Swift 编写。

Modules(模块) :

Swift 将代码打包到模块中,每个模块都有单独的命名空间,强制执行访问控制。

Packages(包) :

包由 Swift 源文件与配置文件(Package.swift)组成。配置文件定义了包的名称及各种配置内容,包可以有多个 Targets。

Products(产品) :

target 可以用来构建库或可执行文件,库包含可被其他 Swift 代码导入的模块。可执行文件可以直接由操作系统运行。

Dependencies(依赖关系)

每个库都可能依赖其他库,以及依赖的具体版本。

SwiftPM 完全使用 Swift 编写,与Swift有着非常好的契合性,不需要额外的壳子,也不需要第三方脚本来管理,可以将 SwiftPM 看做是工程引入的一个特殊的库。


在 Xcode 中使用 SwiftPM

现在的 Xcode 已经整合了 SwiftPM。可在项目的 Project 中看到 “Swift Packages” 一栏:

下面尝试用 SwiftPM 来进行包管理。

1. 安装

SwiftPM 整合在 Xcode 中,对于 MacOS、iOS 开发者,安装Xcode即可,其他平台开发者可查阅官方文档。

2. 导入

在 Project 的 Swift Package 栏,点击下面列表的加号并填入需要引入库的地址,例如 Alamofire 的地址:https://github.com/Alamofire/Alamofire,在经过短暂的查找等待后,弹出了具体的导入配置界面:

导入规则 Rules 有三个选项: VersionBranchCommit

其中的 Version 可指定库的版本更新规则:

  1. Up to Next Major: 直到下一个大版本(5.2.2 ~ 6.00)
  2. Up to Next minor: 直到下一个中版本(5.2.2 ~ 5.3.0)
  3. Range: 限定版本范围(自定义范围)
  4. Exact: 指定固定版本(5.2.2)

没有特殊需求就使用默认选项,点击 Next 按钮,等待 Xcode 从网上拉取完毕。此处建议使用良好的网络进行拉取。

导入完成后,可以在 DriveData 下对应的工程文件中看到新增了一个 SourcePackages 文件,在子文件 checkouts 下可以看到所有通过SwiftPM引入的依赖库。

同时,可以看到工程内新增了一栏 Swift Package Dependencies

导入的库跟手动下载库后的文件结构基本相同,只多了一点点...

3. 配置文件一览

依赖库的相关配置在 Pacakage.swift 中:

配置文件中采用声明式语法创建了一个 Package 对象,Package 类来自 PackageDescription包 ,其主要作用是对包的描述。图中 Almofire 的配置参数如下:

name: 包名
platforms: 支持的平台
products: 编译后的library
targets: 包中包含的targets,其中.testTarget是供测试的target
swiftLanguageVersions: 库所使用的的 Swift 版本

除此之外,dependencies 参数为库指定依赖的库,SwiftPM 会自动加载所有依赖的库。例如在引入 Realm 时,其依赖于 RealmCore, Package.swift 中可以看到该字段:

let package = Package(
    //......
    dependencies: [
        .package(url: "https://github.com/realm/realm-core",.exact(Version(coreVersionStr)!)),
    ],
    //......

在 SwiftPM 加载时会自动加载指定 url 处的 realm-core。加载完毕后可在 Swift Package Dependencies 中看到 RealmCore。

更多配置相关的参数可以进入到 PackageDescription 库查看(即 Package.swift 文件头部 import 的 PackageDescription)

导入三方库的配置文件不需要我们更改什么,如果是我们自己创建的库给别人使用,或者直接将 SwiftPM 用来工程模块化,就需要自定义 Package.swift 中的参数。

4. 使用导入的库

在需要的地方引入库即可:

import Alamofire

[扩展]利用 Swift Package 进行模块化

假如需要将对系统类的一系列扩展封装成一个基础库,其他项目可通过SwiftPM依赖于它。
总共可分为两步:

1.创建库

  1. 打开 Xcode,新建一个Swift Package。创建完毕后Xcode自动为我们生成好了库的结构:

2)将代码文件加入到该模块的 Source文件夹 中。如果有多个文件夹,可分为多个 target 的方式在package.swift中进行配置,若有依赖于其他库可在 .dependencies字段后添加所依赖库的git地址。

3)因为 SwiftPM 是针对所有 Swift 项目,没有明确区分所限制的平台。此处封装的扩展库多针对于 UIKit ,在 Package.swift 文件中可以指定所支持的最低版本,但没有仅允许禁止某平台的字段,目前参考其他三方库的做法,在代码文件中使用判断运行环境:

#if os(iOS) || os(tvOS)
import UIKit
// 各种代码
#endif

2. 发布更新到远端库中

  1. 点击菜单栏的 source control 标签下的 “New Git Repositories”创建本地git仓库

  2. 点击Xcode左侧git管理的标签,右键创建远程库:

  1. 此处以 github 为例,只需登录账号就可以推送到github远端,也能推送到自己架设的内网gitlab服务上。这里别忘了版本号

上传成功后就可以通过 SwiftPM 在其他项目中导入我们的自定义库了:

总结

SwiftPM 做到了 Cocoapods 的简单易用 以及 Carthage 的轻量化无侵入,得益于其完全使用 Swift 编写而成,完美与 Xcode 深度融合,不需要额外的壳子或脚本。又因 Swift 本身定位是一门跨平台语言,所以 SwiftPM 不仅仅局限于本文中在 Xcode 中的使用。想要更深入了解跨平台方面的小伙伴可自行查阅官方文档,并结合其他三方库的配置来学习。

你可能感兴趣的:(Xcode 中如何使用 SwiftPM(Swift Package Manager))