Fastlane（一）：用法

fastlane是一个自动化构建工具，主要包含测试、打包、发布等功能，它内部是由ruby实现的，是一款自动化非常高的脚本工具。

1. 常规使用

使用fastlane并不复杂，多数情况下，只需要一个命令和一个Fastfile配置文件，就能使用fastlane去实现一些功能，比如签名、测试、打包等
下面是一个Fastfile文件中的代码，它的作用是打包程序。

default_platform :ios

lane :build do
    gym(export_method: 'enterprise')
end

有了这个Fastfile文件之后，只需要在终端中执行cd project_path进入到项目主目录，然后执行fastlane build，fastlane就会开始自动打包。当然，想要执行成功，那还需要提前把所有证书都配置正确了。

在使用fastlane时，一般分为两步:

1. 初始化
2. 配置Fastfile

下面以这两步分别来讲解如何使用fastlane：

1.1. 初始化

在使用fastlane时，一般是通过Fastfile这样的配置文件来跟它交互的，所以第一步初始化的目的是创建Fastlane文件(如果有需要，也可以创建其他类型的配置文件，如Appfile、Matchfile、Gymfile等)，具体而言，就是找到项目主目录，也就是xcodeproj或xcworkspace所在的目录下，创建一个名叫fastlane或.fastlane的文件夹，在这个文件夹下，创建配置文件Fastfile。目录结构如下：

-test.xcodeproj
-fastlane
  -Fastfile
  -Appfile

除了手动创建，fastlane也提供一个命令来简化这个过程

fastlane init

1.2. 配置Fastfile

配置Fastfile主要是在其内部创建各种lane，这些lane的作用就是帮助你达到某一种目的，比如你可能有一个叫做appstore的lane，用来发布app到appstore的lane；或者一个叫做adhoc的类，用来发布测试版本，等等，下面的例子中定义一个名叫build的lane，我们对它的期望打包app。

default_platform :ios

lane :build do
end

如果现在执行fastlane build，app并不会被打包，因为lane本身并没有任何具体的功能，它的作用是绑定各种具有特定功能的action，让这些action顺序执行。
那么，为了达到打包app的作用，需要在这个lane内部添加一个具有打包功能的action，比如gym，代码如下：

default_platform :ios

lane :build do
    gym(export_method: 'enterprise')
end

到目前为止，一个简单的Fastfile文件就配置完了，然后你可以先测试一下，首先需要把证书设置好，然后在终端执行cd project_path进入项目主目录，执行fastlane build，如果一切顺利，打包完成后你会在项目主目录得到一个ipa文件。

2. switch lane

switch lane 指的是在一个lane中调用另一个lane

default_platform :ios

lane :lane1 do
    puts "lane1"
    lane2
end 
    
lane :lane2 do
    puts "lane2"
end 

例子中，lane1方法中调用了lane2，执行fastlane lane1，部分输出如下

[✔] 🚀 
[16:09:47]: Driving the lane 'lane1' 🚀
[16:09:47]: --------------------------------------
[16:09:47]: --- Step: Switch to lane2 lane ---
[16:09:47]: --------------------------------------
[16:09:47]: Cruising over to lane 'lane2' 🚖
[16:09:47]: Cruising back to lane 'lane1' 🚘
[16:09:47]: 
lane1
lane2

可以看出，执行是成功的，这说明fastlane支持lane之间相互调用。
不过，在fastlane中，并不是所有lane都能相互调用，需要满足下面两个条件之一：

1. 两个lane同属于同一个platform
2. 被调用的lane不属于任何platform

那么，platform又是什么？

3. platform

首先，了解一下platform如何使用，Fastfile的内容如下：

platform :ios do
    lane :lane1 do
        puts "lane1"
    end 
    
    lane :lane2 do
        puts "lane2"
    end 
end

在这个例子中，设置了两个lane，名称分别是lane1和lane2，这两个lane被一个叫做ios的platform包围。

platform的作用和lane的作用类似，lane的作用是绑定多个action，而platform则是绑定多个lane。
由于fastlane目前可以在iOS、android和Mac这三个平台使用，所以可能在同一个Fastfile中存在不同平台的lane，使用platform可以使得lane的使用范围更加明确。还有一个需要注意的是，正如上一节所说的，属于不同platform的lane，不能相互调用

如果需要在Android端使用fastlane，则可以额外添加一个叫做:android的platform。另外，也可以在platform之外添加lane，这种lane叫做通用lane，可以被所有的lane调用。

代码如下：

lane :lane0 do
    puts "\nlane0"
end

platform :ios do
    lane :lane1 do
        puts "\nlane1"
    end 
    
    lane :lane2 do
        puts "\nlane2"
    end 
end

platform :android do
    lane :lane3 do
        puts "\nlane3"
    end 
    
    lane :lane4 do
        puts "\nlane4"
    end 
end

这个时候，如果在终端执行fastlane lane1，fastlane会告诉你它找不到lane1

[!] Could not find 'lane1'. Available lanes: lane0, ios lane1, ios lane2, android lane3, android lane4

但是，fastlane在错误信息里面指出可用的lanes有这些：lane0, ios lane1, ios lane2, android lane3, android lane4，那么不妨尝试一下，执行fastlane ios lane1

[✔] 🚀 
[16:21:29]: Driving the lane 'ios lane1' 🚀
[16:21:29]: 
lane1
[16:21:29]: fastlane.tools finished successfully 🎉

成功了

经过多次试验，可以发现当lane被定义在platform之内时，需要使用类似fastlane platform_name lane_name的命令结构来调用，比如调用lane1，则需要执行fastlane ios lane1；调用lane3，则需要执行fastlane android lane3；对于定义在platform之外的lane0，可以直接执行fastlane lane0。

4.default_platform

在实际使用中，很少有人会去执行带platform的命令，一般是执行命令fastlane lane_name，这是因为fastlane还提供了另一个方法：default_platform。

default_platform :ios

lane :lane0 do
    puts "\nlane0"
end

platform :ios do
    lane :lane1 do
        puts "\nlane1"
    end 
    
    lane :lane2 do
        puts "\nlane2"
    end 
end

platform :android do
    lane :lane3 do
        puts "\nlane3"
    end 
    
    lane :lane4 do
        puts "\nlane4"
    end 
end

现在，在这个例子中，执行fastlane lane1也可以成功调用lane1。这是因为上面的例子中在设置了默认platform

default_platform :ios

5. action

action可以看作是fastlane中的功能模块，每一个action都有其特定的功能，它规定了功能的具体实现。比如之前例子中的gym就是action，它是被用来打包工程的。

在fastlane中，内置了一系列的action，官方文档中将这些内置的action分为了以下几大类：

• Testing
• Building
• Screenshots
• Project
• Code Signing
• Documentation
• Beta
• Push
• Releasing your app
• Source Control
• Notifications
• Misc
• Deprecated
• Plugins

这里以cert这个action作为例子，来简单了解action一般如何使用。
Fastfile中的代码如下

default_platform :ios

platform :ios do
    lane :get_cert do
        cert(username: your_apple_id_username, development:false)
    end
end

如上述代码所示，只要使用类似action_name(options)的格式就能执行指定的action，其中options是一个Hash类型的值，所以也能写成类似action_name(key1:value1,key2:value2)的格式。

使用fastlane get_cert执行上述代码，fastlane会使用your_apple_id_username登录到苹果开发者网站查询证书信息，如果本地钥匙链中没有安装此账号对应证书，则fastlane会尝试创建一个新的证书，如果创建成功，fastlane会下载此证书并安装到钥匙链中，同时你也会得到对应的CSR文件、证书文件和其私钥。
除此以外，cert这个action中有很多option可被设置，具体可执行fastlane action cert进行查询。

6. 加载外部action

除了使用fastlane内置的action以外，还可以创建一些自定义action，并加载到fastlane中作为外部action。
当需要为fastlane添加一些外部action时，只需要将这些自定义的action文件放在fastlane/actions/路径下即可，fastlane会自动加载。
具体目录结构如下：

-test.xcodeproj
-fastlane
  -Fastfile
  -Appfile
  -actions
    -your_action1.rb
    -your_action2.rb

在Fastfile配置文件中，内置的action和外部action的用法一致。

7. 加载plugin

plugin是什么？
plugin实质上就是由一些action组成的，而且在加载到fastlane之后，这些action和其他action没有什么区别，使用方法完全一致。

plugin和外部action的区别？
如果你写了一些自定义的action，想分享给其他人使用，于是你提了一个PR给fastlane，但是fastlane由于一些原因没有接受。这个时候你还有一条路可走，那就是创建一个包含这些action的plugin，并发布到RubyGems上。

这里以加载fastlane-plugin-versioning为例，在fastlane/或fastlane/../路径下执行fastlane add_plugin versioning即可，接下来你就能在Fastfile中使用这个plugin中包含的action了。

fastlane add_plugin plugin_name的执行结果是在fastlane/路径下创建文件Pluginfile，并修改Gemfile的内容，以下是执行命令之后Pluginfile和Gemfile中的内容。

Pluginfile中内容如下：

# Autogenerated by fastlane
#
# Ensure this file is checked in to source control!

gem 'fastlane-plugin-versioning'

Gemfile中内容如下

# Autogenerated by fastlane
#
# Ensure this file is checked in to source control!

source "https://rubygems.org"

gem 'fastlane'

plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
eval_gemfile(plugins_path) if File.exist?(plugins_path)