iOS 的自動構建流程

作者 | ZenonHuang 
來源 | 掘金，點擊閱讀原文查看作者更多文章

前言

一個對效率有追求的公司，都應該有一套自動構建系統。

目前使用的這套 iOS 構建流程，經歷 2 年的使用，基本穩定下來。

這篇文章主要用來記錄📝 目前自己使用的 Jenkins 打包📦腳本。

用來打包做類似事情的工具很多，更主要的是為什麼使用自動構建:

• 效率上，解放出開發人員的時間。也更方便其他同事使用。

• 保證打包的標準，避免配置或環境問題，帶來的失敗。把事情做對，比做快更重要。

• 權限安全上，通過構建系統集中管理，對於使用者來說是一個黑盒。

• 項目流程上，便於有需求時做 Daily Build 或者 自動測試。

對於 如何安裝 Jenkins 或者 Jenkins 參數配置 之類的基本配置不做涉及。

網上已經有不少詳細的文章進行介紹。比如 手把手教你利用Jenkins持續集成iOS項目 https://www.jianshu.com/p/41ecb06ae95f。

大體的iOS 構建流程

先介紹整體的構建流程，具體的內容會在下面分步驟介紹.

下面使用的相應 ruby 腳本已經上傳 github 倉庫,注意的是，裡面的變量進行了脫敏處理，根據自己需要去稍作修改

構建前

• 設置構建名

• 配置 app 圖標水印（build號，分支）

• ruby 腳本根據參數，修改工程 bundleID ，宏等

• 安裝第三方依賴，pod update

執行構建

• xcodebuild clean

• xcodebuild archive

• xcodebuild exportArchive

構建完成

• 上傳分發平臺: 蒲公英/fir/appstore（歷史版本記錄: git tag ）

• 符號表處理：上傳 bugly

• 歸檔產物: 上傳 FTP 伺服器

• 清理: 刪除 IPA 等

• 設置構建描述

• 通知: 企業微信 webhook 機器人推送

構建前設置構建名

首先設置我們的構建名稱，我這裡使用到幾個參數:

• BUILD_NUMBER ,Jenkins 自帶的參數，代表第幾次構建

• BetaPlatform ,設置的選項參數，代表分發平臺。我這裡的值分別是:fir,pgyer,appstore

• Mode,設置的選項參數，代表 Xcode 構建的環境設置，為 Snapshot 和 Release

• Branch,Jenkins 自帶的參數，代表 Git 分支名稱

配置 APP 圖標

為了打包後進行測試的 APP ,便於定位問題，可以在 App Logo 上打上水印，加入構建使用的 git 分支名，jenkins 構建號，app 版本號 等關鍵信息。

配置圖標水印的流程為:

• 判斷此次是否為 appstore 分發平臺。如果是 appstore 的話，將舊有的圖標目錄清理掉，然後將圖標複製到使用的目錄中。

• 如果不是 appstore ，則為測試平臺分發，進行水印處理。

打包前替換資源

Note:
在處理圖標做替換時，原來有兩種方式，一種是在構建完成後，進入 app 的資源中進行替換（現在行不通了）。另一種是，直接修改工程中的資源。
目前是用的方法，就是直接修改工程目錄中的圖標源文件.所以要在構建之前完成加水印替換 Logo.

因為要使用替換資源的方式，所以準備兩個目錄。

一個目錄作為 源目錄，存放未處理的圖片。一個目錄作為目標目錄，存儲 App Logo 使用的圖片。

為什麼使用兩個圖片目錄存儲？假設只用一個，原圖為A，當第一次處理，圖片為 A1水印圖片，當第二次再拿到的圖片，已經是被處理過的 A1水印圖片了，而不是原圖A 。

這裡注意 icons_path 為存放原圖的地址， icons_dest_path 為要修改使用的目標路徑。命名為 AppIcon-Internal。

可以參考 iOS APP圖標版本化 https://www.jianshu.com/p/a37e114b7e66

關於 version 的獲取， 因為目前版本有改動，使用 ruby 去獲取,腳本會在後面提供連結:

version=$(ruby ./ToolChain/ruby/dy_build_version.rb ${Mode})

還有一個臨時存放路徑，要提前創建好這個文件夾:

tmp_path="/Users/${sys_username}/Desktop/iOS_IPA/IconVersioning

ImageMagick

添加水印主要使用到了命令行工具 ImageMagick ,所以要先安裝:

brew install imagemagick
# 安裝Ghostscript，它提供了支持ImageMagick的字體。
brew install ghostscript

腳本內容

具體的腳本如下:

#!/bin/bash -l

echo "🐛 --- 配置 app 圖標 "

#本機 Mac 的用戶名
sys_username="$USER"
#Jenkins 構建的任務名
jenkinsName=${JOB_NAME}
# 工程名
APP_NAME="your app name"
#項目 repo 目錄
Workspace="${WORKSPACE}"


project_infoplist_path="./${APP_NAME}/Info.plist"
#臨時圖片存放路徑
tmp_path="/Users/${sys_username}/Desktop/iOS_IPA/IconVersioning"

# 如果平臺為 appstore
if [ "$BetaPlatform" = "appstore" ];then
echo "🍃🍃🍃 上傳平臺 為 appstore 🍃🍃🍃"
echo "icons_path: ${icons_path}"
echo "icons_dest_path: ${icons_dest_path}"

#1.清除原來 png 文件
find "${icons_dest_path}" -type f -name "*.png" -print0 |
while IFS= read -r -d '' file; do
echo "rm file $file"
rm -rf $file
done

#2. icons_path 複製到icons_dest_path
find "${icons_path}" -type f -name "*.png" -print0 |
while IFS= read -r -d '' file; do
echo "file: ${file}"
image_name=$(basename $file)
echo "copy image: ${image_name}"
cp $file ${icons_dest_path}/${image_name}
done


else
# 如果平臺為其它內測分發平臺
echo "🍃🍃🍃 上傳平臺 為 pagyer/fir,加水印 🍃🍃🍃"

convertPath=`which convert`
echo ${convertPath}
if [[ ! -f ${convertPath} || -z ${convertPath} ]]; then
echo "warning: Skipping Icon versioning, you need to install ImageMagick and ghostscript (fonts) first, you can use brew to simplify process:
brew install imagemagick
brew install ghostscript"
exit -1;
fi

# 說明
# version app-版本號
# build_num app-構建版本號.
version=$(ruby ./ToolChain/ruby/dy_build_version.rb ${Mode})
build_num=${BUILD_NUMBER}

# 檢查當前所處Git分支
cut="$Branch"
echo ${cut#*/}
#shell 截取字符串
branch=${cut#*/}

shopt -s extglob
build_num="${build_num##*( )}"
shopt -u extglob

#圖片顯示的文字內容
if [ "${isBeta}" = "YES" ];then
echo " 🍜🍜🍜 為Beta 版本"
caption="${version}($build_num)\n${branch}(Beta)"
else
caption="${version}($build_num)\n${branch}"
fi

echo $caption

function abspath() { pushd . > /dev/null; if [ -d "$1" ]; then cd "$1"; dirs -l +0; else cd "`dirname \"$1\"`"; cur_dir=`dirs -l +0`; if [ "$cur_dir" == "/" ]; then echo "$cur_dir`basename \"$1\"`"; else echo "$cur_dir/`basename \"$1\"`"; fi; fi; popd > /dev/null; }


function processIcon() {
base_file=$1
temp_path=$2
dest_path=$3

if [[ ! -e $base_file ]]; then
echo "error: file does not exist: ${base_file}"
exit -1;
fi

if [[ -z $temp_path ]]; then
echo "error: temp_path does not exist: ${temp_path}"
exit -1;
fi

if [[ -z $dest_path ]]; then
echo "error: dest_path does not exist: ${dest_path}"
exit -1;
fi

file_name=$(basename "$base_file")
final_file_path="${dest_path}/${file_name}"

base_tmp_normalizedFileName="${file_name%.*}-normalized.${file_name##*.}"
base_tmp_normalizedFilePath="${temp_path}/${base_tmp_normalizedFileName}"

# Normalize
echo "Reverting optimized PNG to normal"
echo "xcrun -sdk iphoneos pngcrush -revert-iphone-optimizations -q '${base_file}' '${base_tmp_normalizedFilePath}'"
xcrun -sdk iphoneos pngcrush -revert-iphone-optimizations -q "${base_file}" "${base_tmp_normalizedFilePath}"

width=`identify -format %w "${base_tmp_normalizedFilePath}"`
height=`identify -format %h "${base_tmp_normalizedFilePath}"`

band_height=$((($height * 50) / 100))
band_position=$(($height - $band_height))
text_position=$(($band_position - 8))
point_size=$(((15 * $width) / 100))

echo "Image dimensions ($width x $height) - band height $band_height @ $band_position - point size $point_size"

#
# blur band and text
#
convert "${base_tmp_normalizedFilePath}" -blur 10x8 /tmp/blurred.png
convert /tmp/blurred.png -gamma 0 -fill white -draw "rectangle 0,$band_position,$width,$height" /tmp/mask.png
convert -size ${width}x${band_height} xc:none -fill 'rgba(0,0,0,0.2)' -draw "rectangle 0,0,$width,$band_height" /tmp/labels-base.png
convert -background none -size ${width}x${band_height} -pointsize $point_size -fill white -gravity center -gravity South caption:"$caption" /tmp/labels.png

convert "${base_tmp_normalizedFilePath}" /tmp/blurred.png /tmp/mask.png -composite /tmp/temp.png

rm /tmp/blurred.png
rm /tmp/mask.png

#
# compose final image
#
filename=New"${base_file}"
convert /tmp/temp.png /tmp/labels-base.png -geometry +0+$band_position -composite /tmp/labels.png -geometry +0+$text_position -geometry +${w}-${h} -composite -alpha remove "${final_file_path}"

# clean up
rm /tmp/temp.png
rm /tmp/labels-base.png
rm /tmp/labels.png
rm "${base_tmp_normalizedFilePath}"

echo "Overlayed ${final_file_path}"
}



#把 appIcon 的圖片，複製到 AppIcon-Internal
icons_path="${Workspace}/${APP_NAME}/Resources/Assets.xcassets/AppIcon.appiconset"
icons_dest_path="${Workspace}/${APP_NAME}/Resources/Assets.xcassets/AppIcon-Internal.appiconset"

icons_set=`basename "${icons_path}"`

echo "icons_path: ${icons_path}"
echo "icons_dest_path: ${icons_dest_path}"

mkdir -p "${tmp_path}"

if [[ $icons_dest_path == "\\" ]]; then
echo "error: destination file path can't be the root directory"
exit -1;
fi

rm -rf "${icons_dest_path}"
cp -rf "${icons_path}" "${icons_dest_path}"

# Reference: https://askubuntu.com/a/343753
find "${icons_path}" -type f -name "*.png" -print0 |
while IFS= read -r -d '' file; do
echo "$file"
processIcon "${file}" "${tmp_path}" "${icons_dest_path}"
done

fi

Ruby 修改工程參數

這裡使用 ruby 實現參數修改(當然也可使用 python 等各種語言，自己方便就 OK )。

根據自己的場景做區分，有的參數時不要的可以不做。這裡主要記錄筆者自己用到的，修改參數和添加參數標記的方法

目前做的操作：

• 區分是否 beta 版本 -- 修改定義 beta 宏 的真假值

• 不同分發平臺，使用不同 bundleID -- 對 bundleID 進行修改

#!/bin/bash -l

export LANG=en_US.UTF-8
export LANGUAGE=en_US.UTF-8
export LC_ALL=en_US.UTF-8

echo ${isBeta}
echo ${channel}

if [ "${isBeta}" = "YES" ];then
echo " 🍜🍜🍜 為Beta 版本"
ruby ./ToolChain/ruby/dy_build_global.rb -isbeta-BETA -channel-${channel}
else
echo " 🍜🍜🍜 不是 Beta 版本"
ruby ./ToolChain/ruby/dy_build_global.rb -channel-${channel}
fi


if [ "$BetaPlatform" = "pgyer" ];then
echo "pgyer 🌹 修改bundleID com.xx.yy.test , profile"
ruby ./ToolChain/ruby/dy_edit_profile.rb
fi

if [ "$BetaPlatform" = "appstore" ];then
echo "appstore 🚀 保持 bundleID,profile"
fi

if [ "$BetaPlatform" = "fir" ];then
echo "fir 🚀 保持 bundleID,profile"
fi

腳本裡依靠 CocoaPods 開源的 Xcodeproj ，對工程的 name.xcodeproj/project.pbxproj 文件進行配置修改。

python 的話，可以使用這個項目 mod-pbxproj

Pod 操作

安裝/更新第三方庫，這裡使用到的是 Cocoapods,其它的包管理器可使用其它方式。

echo "🌲 --- Pod 操作 "

pod update --verbose --no-repo-update

echo "🌲 --- Pod 完成 "

執行構建準備工作

在開始之前，我們要做些準備工作，比如設置要使用的變量，常量。

需要提前寫好，儘量避免散落。

echo "🌰 --- 獲取材料 ----"

#本機 Mac 的用戶名
sys_username="$USER"
#Jenkins 構建的任務名
jenkinsName=${JOB_NAME}
# 工程名
APP_NAME=""
#scheme名
SCHEME_NAME=""

#工程絕對路徑
project_path="${WORKSPACE}"
#時間
DATE="$(date +%Y-%m-%d-%H-%M-)"
#info.plist路徑
project_infoplist_path="./${APP_NAME}/Info.plist"

#buglys 命令行工具路徑
buglyPath=/Users/${sys_username}/Desktop/buglySymboliOS

Build 號相關

舊有的方式，是直接通過 info.plist 取:

#version
bundleVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleShortVersionString" "${project_infoplist_path}")

#bundleID
BundleID=$(/usr/libexec/PlistBuddy -c "print CFBundleIdentifier" "${project_infoplist_path}")

然而在新的 Xcode 取 版本號 和 bundleID 的方式發生變化，現在 info.plist 裡的值是變量名,取版本號為 $(MARKETING_VERSION), bundleID 為 $(PRODUCT_BUNDLE_IDENTIFIER).

結局思路是通過腳本到工程配置裡去獲取，下面使用 ruby 實現了這兩個目的。 

我們將 App 與 Jenkins 的 build number 設置為同一個，方便需要時，查看構建的參數以及符號表等:

#通過腳本取得取版本號 x.x.x
bundleShortVersion=$(ruby ./ToolChain/ruby/dy_build_version.rb "${Mode}")

#通過腳本取得 bundleID
BundleID=$(ruby ./ToolChain/ruby/dy_build_bundIeID.rb "${Mode}")

#修改 ipa 的 build 號，和 jenkins 構建號相同
/usr/libexec/PlistBuddy -c "Set :CFBundleVersion $BUILD_NUMBER" "${project_infoplist_path}"

#取build值
bundleVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleVersion" "${project_infoplist_path}")

# bundleVersion 正常情況要與 BUILD_NUMBER 一樣
echo "BundleID:${BundleID} Verision:${bundleVersion} Jenkins Build: $BUILD_NUMBER "

使用 security 解鎖鑰匙串.

加入 security 解鎖操作的原因,是在子節點 ssh 登錄上去之後，keychain 沒有被解鎖.導致打包失敗.
解決方案是用 security unlock-keychain 命令將證書解鎖。

# 這裡默認是 login keychain，login keychain 的密碼默認是用戶的登錄密碼
security -v unlock-keychain -p "password"

另外可以通過命令查看描述文件的詳細信息 包括UUID等信息

/usr/bin/security cms -D -i 文件路徑

Xcodebuild

對工程進行構建打包，主要在於使用 Xcodebuild .
分為三個階段：

• Clean

• Archive

• Export

如果在執行過程中又不喜歡日誌輸出的，可以在命令行最後加上

-quiet #只有 warn 和 error 才會輸出

清理工程

每次構建時，對工程進行 clean ,保證沒有其它影響的因素。
使用xcodebuild clean [-optionName]...清除編譯過程生成文件,使用如下：

#//下面是集成有Cocopods的用法
echo "🏎️🏎️ =================clean================= 🏎️🏎️ "

xcodebuild clean -workspace "${APP_NAME}.xcworkspace" -scheme "${APP_NAME}" -configuration ${development_mode} -UseModernBuildSystem=YES

非 cocoapods 的工程，將 -workspace "${APP_NAME}.xcworkspace" 換成 -project ${APP_NAME}.xcodeproj 即可。
新版本的 Xcode 有了新的構建系統，使用 -UseModernBuildSystem= 來做新舊區分。

構建 archive 包

Xcodebuild archive

echo "🚗🚗🚗 *** 正在 編譯工程 For ${development_mode} 🚗🚗🚗"

xcworkspace=${project_path}/${APP_NAME}.xcworkspace
echo "acrhivie xcworkspace : ${xcworkspace}"

xcodebuild \
archive -workspace ${xcworkspace} \
-scheme ${SCHEME_NAME} \
-configuration ${development_mode} \
-archivePath ${build_path}/${APP_NAME}.xcarchive \
-quiet


echo '✅ *** 編譯完成 ***'

導出 IPA 包

security -v unlock-keychain -p "yourpassword"

echo '🚄 ***************** 正在 打包 ***************** 🚄 '


xcodebuild -exportArchive -archivePath ${build_path}/${APP_NAME}.xcarchive \
-exportPath ${exportFilePath} \
-exportOptionsPlist ${exportOptionsPlist_path} \
-allowProvisioningUpdates \
-quiet

更新到Xcode9.0後，之前寫的自動打包腳本不可用了。

需要添加 -allowProvisioningUpdates，獲取訪問鑰匙串權限的關鍵所在，設置了這個欄位就會在打包過程彈框請求獲取鑰匙串內容權限。

exportOptionsPlist 設置

特別說明的是，exportOptionsPlist 一定要檢查,不同的環境和分發平臺要選擇對。

最簡單方式，就是調好需要的環境後，直接手動 archive ,export 出來，使用產物裡的 exportOptionsPlist 文件。

檢查 ipa

檢查對應路徑是否有 **.ipa 文件:

if [ -e ${exportFilePath}/${APP_NAME}.ipa ]; then
echo "✅ *** .ipa文件已導出 ***"
echo $exportFilePath

else
echo "❌ *** 創建.ipa文件失敗 ***"
exit 1
fi

echo '📦 *** 打包完成 ***'

構建完成上傳分發平臺

這裡分為 蒲公英,fir,appstore 三個平臺，上傳 IPA.

如果為 appstore, 則多出一個 git tag 的相關操作，標記上當前版本的提交，方便需要時直接回退代碼進行查看。

下面使用的三個上傳命令，最好先提前在機器上實驗可以正常用再構建。

if [ "$BetaPlatform" = "pgyer" ];then

echo "🚀 上傳蒲公英 ++++++++++++++upload+++++++++++++"
#User Key
uKey="User Key"
#API Key
apiKey="API Key"
#執行上傳至蒲公英的命令
curl -F "file=@${IPA_PATH}" -F "uKey=${uKey}" -F "_api_key=${apiKey}" -F "buildPassword=yourpassword" -F "buildInstallType=2" http://www.pgyer.com/apiv2/app/upload
echo "✅ Finsh - 蒲公英上傳完畢"
fi


if [ "$BetaPlatform" = "fir" ];then
echo "🚀 上傳Fir ++++++++++++++upload+++++++++++++"

fir p ${IPA_PATH} -T your_token

echo "✅ Finsh - Fir 上傳完畢"
fi



if [ "$BetaPlatform" = "appstore" ];then

echo "🏠 --appstore xcrun 上傳到 appstore "

xcrun altool --upload-app -f ${IPA_PATH} -u your_account -p your_app_password --verbose

echo "📝 --appstore 增加 Git Tag "

echo "---- 當前 Tag -"
git tag

echo "---- 打 Tag --"
GitTag=V${bundleShortVersion}_${bundleVersion}

git tag -a ${GitTag} -m "Tag:${GitTag} "
echo "Tag ${GitTag}"

#推送標籤
git push origin ${GitTag}

echo "✅ - Git Tag 推送完畢 "
fi

符號表處理

上傳 bugly

echo " 📦 - 開始符號表 相關工作 -"

echo " ©️ 上傳符號表 -- ©️"

if [ "$BetaPlatform" = "appstore" ];then
echo "🚀 Bugly 正式版本符號表"
buglyID= your_product_buglyID
buglyKey= your_product_buglyKey

else
echo "🚀 Bugly 測試版本符號表"
buglyID= your_dev_buglyID
buglyKey=your_dev_buglyKey
fi

dSYMPath=$exportFilePath/${APP_NAME}.xcarchive/dSYMs/
cd $buglyPath

echo " 開始上傳符號表 "
java -jar buglySymboliOS.jar \
-i ${dSYMPath}/${APP_NAME}.app.dSYM \
-u -id ${buglyID} \
-key ${buglyKey} \
-package ${BundleID} \
-version ${bundleShortVersion}

echo "✅ 上傳符號表完畢 - ✅ "

歸檔產物

進行完所有操作後，對於產物做一次保存，需要時可以用上。

壓縮

首先將文件壓縮

echo "📦 壓縮文件 - 📦 "

#打開目錄
cd $exportFilePath
zip -r ./${JOB_NAME}_${BUILD_NUMBER}.zip ./*

#清理文件 **.xcarchive
rm -rf ${APP_NAME}.xcarchive

上傳 FTP 伺服器

通過 FTP 插件，把 zip 文件上傳到歸檔的路徑下

產物清理

刪除 IPA 等文件，注意的是，當狀態為 success 才清理，避免有時上傳出問題，可以進行手動上傳。

構建描述

設置構建描述

進行通知

完成後，企業微信 webhook 機器人推送，效果如下：

這裡設置成可選項，避免頻繁打擾其它同事。腳本如下:

if [ "${BotPush}" = "YES" ];then

version=$(ruby ./ToolChain/ruby/dy_build_version.rb ${Mode})
downUrl="pgyer url"

if [ "$BetaPlatform" = "fir" ];then
downUrl="fir url"
fi

#群裡機器人地址
ROBOT=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=yourkey

curl ''${ROBOT}'' \
-H 'Content-Type: application/json' \
-d '
{
"msgtype": "markdown",
"markdown": {
"content": "### iOS 構建 \n版本 <font color=\"warning\">'${version}'</font> <font color=\"info\">#'${BUILD_NUMBER}'</font>\n環境 <font color=\"comment\">'${Mode}'</font>\n平臺 <font color=\"warning\">'${BetaPlatform}'</font>\n>[下載地址 ]('${downUrl}')"
}
}'

fi

參考文章

[1] https://juejin.im/post/6844903843994533896 
[2]https://www.cnblogs.com/zhou--fei/p/11371019.html 
[3] https://www.jianshu.com/p/4f4d16326152 
[4] https://www.jianshu.com/p/f50053d50436 
[5] https://dengweijun.com/2018/12/26/Xcode%E8%87%AA%E5%8A%A8%E6%89%93%E5%8C%85%E9%82%A3%E4%BA%9B%E4%BA%8B/

就差您點一下了 👇👇👇