本文我带领敏捷大拇指上各位Swift开发者一起看看如何通过Swift Package Manager(以下简称SPM)来构建一个简单的开发环境。




1、创建一个Product

假设我们要创建一个最基本的平衡二叉树,可以执行下面这些命令:

[Bash shell] 纯文本查看 复制代码
mkdir BST
cd BST
swift package init --type=library


这样,SPM就会为我们创建下面的目录结构:

如何通过Swift Package Manager 来构建一个简单的开发环境 1

如何通过Swift Package Manager来构建一个简单的开发环境 - 敏捷大拇指 - 如何通过Swift Package Manager 来构建一个简单的开发环境 1


在这个目录结构里,我们可以了解以下内容:

  • Swift通过Modules来管理代码,默认情况下,所有在Sources目录下的文件都在同一个module中(稍后我们也会看到多个module的情况);
  • 所有Sources目录中的代码和根目录的Package.swift文件形成了一个Package;
  • 在一个Package里,我们可以定义一个或多个Target;
  • Target可以是我们在一开始定义的library,它可以被其他的Swift module使用;也可以是一个executable,稍后,我们会看到它的用法。





2、创建第一个module

在Sources根目录中,所有源代码默认都是在同一个module中的。我们先在BST.swift中编写一些示例代码:

[Swift] 纯文本查看 复制代码
open class BST { 
    public init() { 
        print("New BST initialized.") 
    }
}
extension BST: CustomStringConvertible { 
    public var description: String { 
        return "BST" 
    }
}


它们当然还不是BST的正式实现,我们在这里只是为了演示module的用法。然后,我们在Tests/BSTTests/BSTTests.swift里,添加一个演示用的测试用例:

[Swift] 纯文本查看 复制代码
class BSTTests: XCTestCase { 
    func testExample() { 
        XCTAssertEqual(BST().description, "BST") 
    }
}


因为我们实现的CustomStringConvertible只是简单返回了字符串"BST",因此上面的比较应该是相等的。

完成之后,在项目根目录执行:

[Bash shell] 纯文本查看 复制代码
swift build


,我们就生成了一个Swift module:

如何通过Swift Package Manager 来构建一个简单的开发环境 2

如何通过Swift Package Manager来构建一个简单的开发环境 - 敏捷大拇指 - 如何通过Swift Package Manager 来构建一个简单的开发环境 2


执行

[Bash shell] 纯文本查看 复制代码
swift test


,SPM就会帮我们完成之前定义的测试用例:

如何通过Swift Package Manager 来构建一个简单的开发环境 3

如何通过Swift Package Manager来构建一个简单的开发环境 - 敏捷大拇指 - 如何通过Swift Package Manager 来构建一个简单的开发环境 3


从上面的结果可以看到,所有测试都通过了。不过,我们创建library,最终还是为了提供给应用程序使用的。因此,接下来,我们就来了解如何给package添加一个可执行程序,我们把它定义在一个新的module中。




3、创建多个module

默认情况下,Sources目录中所有代码都是在同一个module中的。因此,要创建多个module,我们要在Sources目录中创建多个子目录,像这样:

  • BST:表示BST module,并且把之前创建的BST.swift移动到这里;
  • Application:表示我们要新添加的应用程序;在其中,添加一个main.swift;这是每一个应用程序都必须定义的文件。


最终,我们的目录看起来是这样的:

如何通过Swift Package Manager 来构建一个简单的开发环境 4

如何通过Swift Package Manager来构建一个简单的开发环境 - 敏捷大拇指 - 如何通过Swift Package Manager 来构建一个简单的开发环境 4


然后,在main.swift中,添加下面的代码:

[Swift] 纯文本查看 复制代码
import BST
let bst = BST()
print(bst)


重新执行

[Bash shell] 纯文本查看 复制代码
swift build


,我们会得到下面的错误:

如何通过Swift Package Manager 来构建一个简单的开发环境 5

如何通过Swift Package Manager来构建一个简单的开发环境 - 敏捷大拇指 - 如何通过Swift Package Manager 来构建一个简单的开发环境 5


显然,尽管我们使用了import BST,SPM在生成Application module的时候,并不知道它和BST之间存在依赖关系。为了解决这个问题,我们需要在Package.swift中,添加必要的依赖关系:

[Swift] 纯文本查看 复制代码
let package = Package( 
    name: "BST", 
    targets: [ 
        Target(name: "Application", dependencies: ["BST"]) 
    ]
)


这样,我们就创建了一个叫做Application的target,它依赖我们之前创建的BST module。完成后,重新执行

[Bash shell] 纯文本查看 复制代码
swift build


,就可以看到成功了:

如何通过Swift Package Manager 来构建一个简单的开发环境 6

如何通过Swift Package Manager来构建一个简单的开发环境 - 敏捷大拇指 - 如何通过Swift Package Manager 来构建一个简单的开发环境 6


编译好的两个swift module在./build/debug目录中,我们直接执行Application

就可以看到结果了:

如何通过Swift Package Manager 来构建一个简单的开发环境 7

如何通过Swift Package Manager来构建一个简单的开发环境 - 敏捷大拇指 - 如何通过Swift Package Manager 来构建一个简单的开发环境 7