从 FengNiao 中学习 Swift (一)

2017-12-03  本文已影响192人  要上班的斌哥

FengNiao 是喵大创建并开源的一款 Mac 命令行工具,该工具可用于清理项目中未使用的图片资源。喵大是通过直播现场编程的方式来编写这款工具,该直播的录播地址如下。

在这个博客系列中我将会把自己学习过程记录下来,算是一个总结。

GitHub 准备

在这里我将自己的练习项目命名为 FengNiaoCopy ,在项目开始的时候,我们创建一个空的 GitHub 代码仓库,然后将 FengNiaoCopy clone 到本地。在开始一个由 GitHub 托管的项目之前,我们第一个重要的工作就是编写 .gitignore 文件,这个文件用来说明在我们项目中的哪些文件可以使用 git 来做版本控制管理,哪些文件不要使用 git 来做版本控制管理。.gitignore 文件的编写规则我们可以在 GitHub 的 gitignore 仓库中可以找到 。由于我们使用的是 Swift 语言,所以找对应的 Swift 语言的 gitignore 文件。

image.png
在本地 FengNiaoCopy 项目的根目录下创建一个 .gitignore 文件并复制 Swift 语言的 gitignore 文件。
image.png

Swift Package Manager 使用

Swift Package Manager 是 Swift 使用的一个包管理器,和 CocoaPods、Carthage 类似,都是可以用来做依赖管理的。具体的详细信息可以参考 https://swift.org/getting-started/。这里我们只关注几个具体的操作。
先使用 swift package --version 命令查看本地上的 Swift Package Manager 版本号,我使用的 Xcode 版本是 8.3.2 。

image.png

使用 swift package init 命令初始化 FengNiaoCopy 项目


image.png

这个时候你会发现我们无法使用 Xcode 来打开这个 FengNiaoCopy 项目,因为 FengNiaoCopy 项目中还没有生成 xcodeproj 文件。那么接下来我们使用 swift package generate-xcodeproj 命令来生成该文件


image.png

使用 Xcode 打开该项目,我们可以看到 Sources 和 Tests 文件夹,猜一下也可以知道 Sources 文件夹主要是用来放置项目代码,Tests 文件夹 主要是用来放置测试代码,Package 文件是用来做项目依赖管理的。FengNiaoCopy 作为项目主工程,FengNiaoKitCopy 作为主工程的一个依赖库。


image.png

为了体现这个依赖,我们需要修改 Package.swift 文件,FengNiaoKitCopy 和 FengNiaoCopy 作为 2 个 Target,FengNiaoCopy 这个 Target 依赖于 FengNiaoKitCopy Target。

// swift-tools-version:3.1
import PackageDescription
let package = Package(
    name: "FengNiaoCopy",
    targets: [
        Target(name: "FengNiaoKitCopy", dependencies: []),
        Target(name: "FengNiaoCopy", dependencies: ["FengNiaoKitCopy"])
    ]
)

一个项目基本上都会依赖于一个第三方库,FengNiaoCopy 也不例外,FengNiaoCopy 依赖 Rainbow,CommandLine,Spectre,PathKit 这四个第三方库,那么 Package.swift 该怎么写呢?使用 dependencies 制定 url 和版本号

// swift-tools-version:3.1
import PackageDescription
let package = Package(
    name: "FengNiaoCopy",
    targets: [
        Target(name: "FengNiaoKitCopy", dependencies: []),
        Target(name: "FengNiaoCopy", dependencies: ["FengNiaoKitCopy"])
    ],
    dependencies: [
        .Package(url: "https://github.com/onevcat/Rainbow", majorVersion: 2),
        .Package(url: "https://github.com/jatoben/CommandLine", "3.0.0-pre1"),
        .Package(url: "https://github.com/kylef/Spectre.git", majorVersion: 0, minor: 7),
        .Package(url: "https://github.com/kylef/PathKit.git", majorVersion: 0, minor: 8)
    ]
)

在 FengNiaoCopy 的开发测试过程中,我们会使用到一些图片资源,但是我们不希望这个资源在打包的时候被打包到我们的执行文件里面,那么 Package.swift 该怎么写呢?使用 exclude 来排除对应的资源文件夹。

// swift-tools-version:3.1

import PackageDescription
let package = Package(
    name: "FengNiaoCopy",
    targets: [
        Target(name: "FengNiaoKitCopy", dependencies: []),
        Target(name: "FengNiaoCopy", dependencies: ["FengNiaoKitCopy"])
    ],
    dependencies: [
        .Package(url: "https://github.com/onevcat/Rainbow", majorVersion: 2),
        .Package(url: "https://github.com/jatoben/CommandLine", "3.0.0-pre1"),
        .Package(url: "https://github.com/kylef/Spectre.git", majorVersion: 0, minor: 7),
        .Package(url: "https://github.com/kylef/PathKit.git", majorVersion: 0, minor: 8)
    ],
    exclude: [ "Tests/Fixtures" ]
)

到这里,我们在 Xcode 中使用 Command + U 编译,发现并没有出现下载依赖的情况。我们这里还是需要回到命令行中,执行 swift build 命令。


image.png

执行 swift build 命令之后,再次回到 Xcode 检查之后,发现没有出现多个 Target 。到这里还是需要一个步骤,我们使用 Swift Package Manager 生成的变动并不会自动同步到 Xcode 中,需要我们使用 swift package generate-xcodeproj 命令再次生成 xcodeproj 文件来更新 Xcode 的项目配置。

image.png

到这里我们算是完成了 package.swift 的配置了,那么接下来就是提交代码了。完成一个阶段性的任务提交一次代码是个非常好的习惯。

上一篇下一篇

猜你喜欢

热点阅读