iOS开发之自动化打包之fastlane和脚本

在测试app项目过程中，通常都是需要开发打测试包给到测试，随着项目的越来越大，打包的时间也越来越长，打一次包大概半个小时左右，打包过程可谓是相当漫长。而且打包的过程也比较繁琐，只有上一步完成后，才能人工点击进行下一步。频繁的回归测试需要频繁的打包，这对于我们的开发效率影响还是蛮大的。
因此，在这种情况下，自动化打包的优势就体现出来了，它不需要我们在电脑前一直关注打包的进程，极大的简化了我们的工作。
这里主要介绍通过Fastlane和sh脚本来实现自动化打包。

一、Fastlane自动化打包方案

Fastlane是一套使用Ruby写的自动化工具集，旨在简化Android和iOS的部署过程，自动化你的工作流。它可以简化一些乏味、单调、重复的工作，像截图、代码签名以及发布App。

1、安装xcode命令行工具

xcode-select --install，如果没有安装，会弹出对话框，点击安装。如果提示xcode-select: error: command line tools are already installed, use “Software Update” to install updates表示已经安装.

2、安装Fastlane

sudo gem install -n /usr/local/bin fastlane 安装完了执行fastlane --version，确认下是否安装完成和当前使用的版本号。
注意，这个安装过程会很长，要有点耐心哦

image.png

3、初始化Fastlane

cd到你的项目目录执行 fastlane init 由于这里是上传到蒲公英，所以选择的4，自定义配置

image.png

这里可能会一直卡在 bundle update，这是由于默认的source是 https://rubygems.org原因。所以我们需要关闭终端，删除fastlane目录并更改项目根目录下生成的Gemfile文件中的source地址https://gems.ruby-china.com，然后再重新第三步。
然后会出现提示让我们按enter，连续按3次进入，到这一步，fastlane就算安装完成啦。

4、蒲公英插件安装

在终端输入 fastlane add_plugin pgyer安装过程中会出现:

[15:09:26]: Seems like the plugin is not available on RubyGems, what do you want to do?
1. Git URL
2. Local Path
3. RubyGems.org ('fastlane-plugin-pgyer' seems to not be available there)
4. Other Gem Server
?  3 #这里我们选3
[15:09:30]: This change is necessary for fastlane plugins to work
[15:09:30]: Should fastlane modify the Gemfile at path
'/Users/apple/Desktop/test/Gemfile' for you? (y/n)
y   #这里我们选y，后续可能还会要输入两次密码获取权限，到这里插件就安装成功了。

5、配置文件

刚创建好打开的Fastfile文件，一个lane就是一个功能或者任务，如打包提交到App Store或者到蒲公英等。

image.png

我这里根据我的项目的自身的情况，进行了基本的打包上传文件配置。

default_platform(:ios)     #指定持续集成对象的平台名称
platform:ios do
  desc "dev蒲公英发版"
  lane :Develop do |options|     #给lane命名

  gym(
    clean:true, #是否清空以前的编译信息 true：是
    export_method: "ad-hoc", #导出方式目前支持app-store, package, ad-hoc, enterprise, development
    scheme:"testDemo", #指定scheme的名字,如果不指定，会列出所有的target要我们选择
    configuration: "Release",#Release 或者 Debug，我们一般用Release
    output_directory:"./fastlane/build",#ipa的存放目录
    output_name:get_build_number()#输出ipa的文件名为当前的build号
    )
  #蒲公英的配置 替换为自己的api_key和user_key
puts "开始上传到蒲公英"
pgyer(update_description: "自动化打包测试", api_key: "****", user_key: "****", password: "123456", install_type: "2")

#在上传完ipa后，打开ipa的存放文件夹，起到提示上传完成的作用
system "open ../fastlane/build"

end
end

配置好后，就可以运行啦，CD到我们项目的根目录，输入命令：fastlane Develop
⚠️命令由 fastlane + lane组成

image.png

经过一段时间的脚本运行后，打包就成功了。我们可以在根目录下的fastlane/build下看到我们打包的文件。然后脚本会继续运行上传到蒲公英。

[15:26:59]: Successfully exported and compressed dSYM file
[15:26:59]: Successfully exported and signed the ipa file:
[15:26:59]: /Users/apple/Documents/JuniorEnglish/fastlane/build/1.ipa
[15:26:59]: -------------------
[15:26:59]: --- Step: pgyer ---
[15:26:59]: -------------------
[15:26:59]: The pgyer plugin is working.
[15:26:59]: build_file: /Users/apple/Documents/JuniorEnglish/fastlane/build/1.ipa
[15:26:59]: Start upload /Users/apple/Documents/JuniorEnglish/fastlane/build/1.ipa to pgyer...
[15:28:44]: Upload success. Visit this URL to see: https://www.pgyer.com/TBX789
[15:28:44]: fastlane.tools just saved you 6 minutes! 
apple@LXKdeMacBook-Pro JuniorEnglish % 

二、脚本自动化打包方案

Fastlane使用的弊端是我们得去配置开发环境，相对新接触的开发者来说有点繁琐。而脚本自动化打包方案可以叫傻瓜式自动化打包，我们只需要将创建好的脚本放入项目的根目录，运行脚本就可以开始打包了。下面是自动化脚本的代码呈现：

#!/bin/bash
# 使用方法:
# step1: 将该脚本放在工程的根目录下（跟.xcworkspace文件or .xcodeproj文件同目录）
# step2: 根据情况修改下面的参数
# step3: 打开终端，执行脚本。（输入sh ，然后将脚本文件拉到终端，会生成文件路径，然后enter就可）

# =============项目自定义部分(自定义好下列参数后再执行该脚本)=================== #
#计时
SECONDS=0
# 是否编译工作空间 (例:若是用Cocopods管理的.xcworkspace项目,赋值true;用Xcode默认创建的.xcodeproj,赋值false)
is_workspace="true"

# .xcworkspace的名字，如果is_workspace为true，则必须填。否则可不填
workspace_name="testDemo"

# .xcodeproj的名字，如果is_workspace为false，则必须填。否则可不填
project_name="testDemo"

# 指定项目的scheme名称（也就是工程的target名称），必填
scheme_name="testDemo"

# 指定要打包编译的方式 : Release,Debug。一般用Release。必填
build_configuration="Release"

# method，打包的方式。方式分别为 development, ad-hoc, app-store, enterprise 。必填
method="development"

#compileBitcode选项没有配置,默认compileBitcode为YES,要设置成NO就可以了
compileBitcode="NO"

#  下面两个参数只是在手动指定Pofile文件的时候用到，如果使用Xcode自动管理Profile,直接留空就好
# (跟method对应的)mobileprovision文件名，需要先双击安装.mobileprovision文件.手动管理Profile时必填
mobileprovision_name=""

# 项目的bundleID，手动管理Profile时必填
bundle_identifier=""


# 蒲公英app key，更换为自己的蒲公英apikey
api_key="***"

echo "--------------------脚本配置参数检查--------------------"
echo "\033[33;1mis_workspace=${is_workspace} "
echo "workspace_name=${workspace_name}"
echo "project_name=${project_name}"
echo "scheme_name=${scheme_name}"
echo "build_configuration=${build_configuration}"
echo "bundle_identifier=${bundle_identifier}"
echo "method=${method}"
echo "mobileprovision_name=${mobileprovision_name} \033[0m"


# =======================脚本的一些固定参数定义(无特殊情况不用修改)====================== #


# 获取当前脚本所在目录
script_dir="$( cd "$( dirname "$0"  )" && pwd  )"
# 工程根目录
project_dir=$script_dir

# 时间
DATE=`date '+%Y-%m-%d_%H-%M-%S'`
# 指定输出导出文件夹路径
export_path="$project_dir/Package/$scheme_name-$DATE"

# 指定输出归档文件路径
export_archive_path="$export_path/$scheme_name.xcarchive"
# 指定输出ipa文件夹路径
export_ipa_path="$export_path"
# 指定输出ipa名称
ipa_name="${scheme_name}_${DATE}"
# 指定导出ipa包需要用到的plist配置文件的路径
export_options_plist_path="$project_dir/ExportOptions.plist"

commit_msg="$1"

echo "--------------------脚本固定参数检查--------------------"
echo "\033[33;1mproject_dir=${project_dir}"
echo "DATE=${DATE}"
echo "export_path=${export_path}"
echo "export_archive_path=${export_archive_path}"
echo "export_ipa_path=${export_ipa_path}"
echo "export_options_plist_path=${export_options_plist_path}"
echo "ipa_name=${ipa_name} \033[0m"
echo "===commit msg: $1==="

# =======================自动打包部分(无特殊情况不用修改)====================== #

echo "------------------------------------------------------"
echo "\033[32m开始构建项目  \033[0m"
# 进入项目工程目录
cd ${project_dir}

# 指定输出文件目录不存在则创建
if [ -d "$export_path" ] ; then
    echo $export_path
else
    mkdir -pv $export_path
fi

# 判断编译的项目类型是workspace还是project
if $is_workspace ; then
# 编译前清理工程
xcodebuild clean -workspace ${workspace_name}.xcworkspace \
                 -scheme ${scheme_name} \
                 -configuration ${build_configuration}

xcodebuild archive -workspace ${workspace_name}.xcworkspace \
                   -scheme ${scheme_name} \
                   -configuration ${build_configuration} \
                   -archivePath ${export_archive_path}
else
# 编译前清理工程
xcodebuild clean -project ${project_name}.xcodeproj \
                 -scheme ${scheme_name} \
                 -configuration ${build_configuration}

xcodebuild archive -project ${project_name}.xcodeproj \
                   -scheme ${scheme_name} \
                   -configuration ${build_configuration} \
                   -archivePath ${export_archive_path}
fi

#  检查是否构建成功
#  xcarchive 实际是一个文件夹不是一个文件所以使用 -d 判断
if [ -d "$export_archive_path" ] ; then
    echo "\033[32;1m项目构建成功     \033[0m"
else
    echo "\033[31;1m项目构建失败     \033[0m"
    exit 1
fi
echo "------------------------------------------------------"

echo "\033[32m开始导出ipa文件 \033[0m"


# 先删除export_options_plist文件
if [ -f "$export_options_plist_path" ] ; then
    #echo "${export_options_plist_path}文件存在，进行删除"
    rm -f $export_options_plist_path
fi
# 根据参数生成export_options_plist文件
/usr/libexec/PlistBuddy -c  "Add :compileBitcode bool ${compileBitcode}"  $export_options_plist_path
/usr/libexec/PlistBuddy -c  "Add :method string ${method}"  $export_options_plist_path
/usr/libexec/PlistBuddy -c  "Add :provisioningProfiles:"  $export_options_plist_path
/usr/libexec/PlistBuddy -c  "Add :provisioningProfiles:${bundle_identifier} string ${mobileprovision_name}"  $export_options_plist_path


xcodebuild  -exportArchive \
            -archivePath ${export_archive_path} \
            -exportPath ${export_ipa_path} \
            -exportOptionsPlist ${export_options_plist_path} \
            -allowProvisioningUpdates

# 检查ipa文件是否存在
if [ -f "$export_ipa_path/$scheme_name.ipa" ] ; then
    echo "\033[32;1mexportArchive ipa包成功,准备进行重命名\033[0m"
else
    echo "\033[31;1mexportArchive ipa包失败        \033[0m"
    exit 1
fi

# 修改ipa文件名称
mv $export_ipa_path/$scheme_name.ipa $export_ipa_path/$ipa_name.ipa

# 检查文件是否存在
if [ -f "$export_ipa_path/$ipa_name.ipa" ] ; then
    echo "\033[32;1m导出 ${ipa_name}.ipa 包成功        \033[0m"
    open $export_path
else
    echo "\033[31;1m导出 ${ipa_name}.ipa 包失败        \033[0m"
    exit 1
fi

# 删除export_options_plist文件（中间文件）
if [ -f "$export_options_plist_path" ] ; then
    #echo "${export_options_plist_path}文件存在，准备删除"
    rm -f $export_options_plist_path
fi

# 输出打包总用时
echo "\033[36;1m使用AutoPackageScript打包总用时: ${SECONDS}s \033[0m"

#上传ipa到蒲公英,如果不需要可以屏蔽掉
if [ -f "${export_ipa_path}/${ipa_name}.ipa" ]
then
    echo '开始上传ipa/apk到蒲公英'
    curl -F "file=@${export_ipa_path}/${ipa_name}.ipa" -F "_api_key=${api_key}" 'http://www.pgyer.com/apiv2/app/upload'
else
    echo "在目录：${export_ipa_path}/${ipa_name}.ipa 不存在"
fi
#输出总用时
echo "===Finished. Total time: ${SECONDS}s==="
exit 0

将编写好的脚本放入项目根目录下后，在终端输入：sh 路径，就开始了自动化打包。需要注意的是，项目的Product Name不能为中文，否则打包会失败。打包效果如下：

image.png

image.png

自动上传到蒲公英成功！

image.png

由于打包文件路径是在项目中，我们可以根据自己的需求改为其他输出路径，或者在git上忽略打包相关目录和文件。