【iOS】分享一個ipa打包指令碼

weixin_33716557發表於2018-01-14
iOS指令碼

寫在前面

之前寫了一個很簡單的ipa打包指令碼，主要是用Xcode命令中的xcodebuild和xcrun命令來完成的，其中打包ipa的命令用了PackageApplication，本來用的好好的，升級了Xcode9之後，發現蘋果把PackageApplication這個東西給刪了，於是指令碼就跪了。。。
所以，這兩個月我用了一個很原始的方法來打ipa包。大家也可以試試（大家常用的直接用Xcode中的Product->Archive的方法我就懶得說了，大家都懂）：
1.自己在Xcode配置好專案的簽名
2.用Generic iOS Device來build工程
3.找到生成的.app包，然後新建一個名為Payload的資料夾，將.app包放到資料夾裡面
4.壓縮Payload資料夾，然後將壓縮包的字尾從.zip改成.ipa。
然後就可以將ipa包安裝到手機上測試了。


1818095-ec125a15c9f0a495.png
用Generic iOS Device來build工程

1818095-8e5d5dd5d4d07838.png
壓縮Payload資料夾，然後將壓縮包的字尾從.zip改成.ipa

為什麼需要一個ipa打包指令碼

嗯，因為想偷懶。
直接在Xcode上點選Product->Archive->此處省略n步選擇.......這種方式確實是挺方便的，估計很多人也是這麼幹的。但是，當你多次打包了之後你就發現，打包這事好無聊。每次都是同樣的配置，同樣的操作步驟，同樣的選擇，這麼簡單的操作我居然要重複N遍。。。而且有時候要等很久才能進行下一步。總之我覺得這種方式操作多了很是蛋疼。
我一直秉承一個理念：能用機器自動解決的問題儘量不用人工操作。
要是有一個東西，只要我配置好了一次之後，以後直接雙擊就能直接打包，是不是比之前的方式更好？
嗯，有挺多這種工具的，比如shenzhen，fastlane等等。
不過我是自己寫了一個簡單的shell指令碼來實現功能的，比較簡單，而且不會對專案有侵入性。藉此還可以順便學習下shell指令碼使用。

自動打包指令碼如何使用？

指令碼的github地址為:https://github.com/shixueqian/AutoPackageScript
使用方法：

  • 1.將指令碼複製到工程的根目錄
  • 2.用程式碼編輯軟體（比如Xcode）開啟指令碼，然後根據情況修改指令碼內的一些引數
  • 3.開啟終端，輸入 sh ${打包指令碼的全路徑}就可執行打包指令碼。
    比如我的專案工程在
    /Users/mac/Desktop/AutoPackageScriptDemo,
    那麼我的指令碼路徑應該是
    /Users/mac/Desktop/AutoPackageScriptDemo/AutoPackageScript.sh,
    所以我要執行的命令是
    sh /Users/mac/Desktop/AutoPackageScriptDemo/AutoPackageScript.sh

sh ${打包指令碼的全路徑}這行命令的作用是執行shell打包指令碼。
除了這樣執行，我們還可以直接雙擊指令碼檔案就執行指令碼，不過在這之前我們需要進行一些設定。
首先，將AutoPackageScript.sh檔案的副檔名去掉，變成AutoPackageScript
然後，開啟終端，執行命令 chmod +x ${打包指令碼的全路徑},這樣可以給指令碼加上可執行許可權，並且預設的開啟方式是終端。
例如：chmod +x /Users/mac/Desktop/AutoPackageScriptDemo/AutoPackageScript
以後，直接滑鼠雙擊就可以執行指令碼了

指令碼引數配置

看了指令碼的使用，其中有一個很關鍵的東西，指令碼引數配置。我對多種情況都有適配，所以指令碼引數會稍微有點複雜，以下我們慢慢道來。

專案的工程結構

我也不知道怎麼稱呼這個東西，簡單來講就是你的工程裡面是不是使用xcworkspace（工作空間）來管理你的工程。
我們在Xcode直接新建一個iOS工程，這個時候僅僅只有一個.xcodeproj檔案，是沒有.xcworkspace檔案的。
而很多的專案都採用了cocoapods來管理專案，這個時候是有.xcworkspace檔案的，cocoapods通過xcworkspace來管理了第三方庫。
這兩種結構的引數配置是不一樣的。（因為寫指令碼的時候有區別）

# 是否編譯工作空間 (例:若是用Cocopods管理的.xcworkspace專案,賦值true;用Xcode預設建立的.xcodeproj,賦值false)
is_workspace="false"

# .xcworkspace的名字，如果is_workspace為true，則必須填。否則可不填
workspace_name=""

# .xcodeproj的名字，如果is_workspace為false，則必須填。否則可不填
project_name="AutoPackageScriptDemo"

# 指定專案的scheme名稱（也就是工程的target名稱），必填
scheme_name="AutoPackageScriptDemo"

註釋其實已經寫得很清楚了。舉個例子，github上的workspace_demo是通過.xcworkspace來管理的：


1818095-012eb571e1d9b4da.png
通過.xcworkspace來管理

1818095-0d2ed031d60a830a.png
專案的scheme_name為AutoPackageScriptDemo

所以這幾個引數就是

is_workspace="true"
workspace_name="AutoPackageScriptDemo"
project_name=""
scheme_name="AutoPackageScriptDemo"

否則，像github上面的project_demo裡面的單工程結構就是

is_workspace="false"
workspace_name=""
project_name="AutoPackageScriptDemo"
scheme_name="AutoPackageScriptDemo"

method，打包的方式。

證書籤名的方式，是通過指令碼中的method變數控制的。
分別為 development, ad-hoc, app-store, enterprise 。看到這幾個引數估計都明白了吧？還不是不太瞭解的話建議看下蒲公英的這篇文件

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

profile檔案的管理方式

一般來說，證書管理方式，如今應該挺多人使用Xcode自動管理的。省心而且方便（老實說，由於工作原因，我平常比較少用自動管理，都是手動管理的，所以理解有誤的話請提出）。
在Xcode->Preferrence->Account裡面新增開發者賬號，然後在工程的General->勾選Automatically manage signing->選擇開發者賬號。就可以自動管理了。
另外一種就是古老的手動管理方式了。
在開發者後臺上面建立BundleID，然後建立mobileprovision檔案，安裝到Xcode上面選擇使用。
針對這兩種方式有不同的配置。

#  下面兩個引數只是在手動指定Pofile檔案的時候用到，如果使用Xcode自動管理Profile,直接留空就好
# (跟method對應的)mobileprovision檔名，需要先雙擊安裝.mobileprovision檔案.手動管理Profile時必填
mobileprovision_name=""

# 專案的bundleID，手動管理Profile時必填
bundle_identifier=""

註釋講得很清楚，使用Xcode自動管理profile的話直接留空就好了。
如果使用手動管理的話就需要填寫對應的引數了。

原始碼解析

指令碼程式碼其實很簡單的。主要講解一下關鍵程式碼。
先把原始碼放出來：

#!/bin/sh

# 使用方法:
# step1: 將該指令碼放在工程的根目錄下（跟.xcworkspace檔案or .xcodeproj檔案同目錄）
# step2: 根據情況修改下面的引數
# step3: 開啟終端，執行指令碼。（輸入sh ，然後將指令碼檔案拉到終端，會生成檔案路徑，然後enter就可）

# =============專案自定義部分(自定義好下列引數後再執行該指令碼)=================== #

# 是否編譯工作空間 (例:若是用Cocopods管理的.xcworkspace專案,賦值true;用Xcode預設建立的.xcodeproj,賦值false)
is_workspace="false"

# .xcworkspace的名字，如果is_workspace為true，則必須填。否則可不填
workspace_name=""

# .xcodeproj的名字，如果is_workspace為false，則必須填。否則可不填
project_name="AutoPackageScriptDemo"

# 指定專案的scheme名稱（也就是工程的target名稱），必填
scheme_name="AutoPackageScriptDemo"

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

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


#  下面兩個引數只是在手動指定Pofile檔案的時候用到，如果使用Xcode自動管理Profile,直接留空就好
# (跟method對應的)mobileprovision檔名，需要先雙擊安裝.mobileprovision檔案.手動管理Profile時必填
mobileprovision_name=""

# 專案的bundleID，手動管理Profile時必填
bundle_identifier=""


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"


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 "------------------------------------------------------"
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 :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"

exit 0

clean工程

以單工程專案為例(wordspace結構是相似的)，引數配置完成之後，clean下工程，用以清除快取，保證我們的專案是純淨的。
跟我們在Xcode中Product->Clean這個命令是一樣的功能。

xcodebuild clean -project ${project_name}.xcodeproj \
                 -scheme ${scheme_name} \
                 -configuration ${build_configuration}

project_name就是我們之前配置的工程的名稱，
scheme_name就是之前配置的工程的target名稱
build_configuration為之前配置的設定，Debug或者Release
以我們demo中的單工程為例，就是這樣的

xcodebuild clean -project  AutoPackageScriptDemo.xcodeproj -scheme AutoPackageScriptDemo -configuration Release

archive工程

build工程，然後archive到一個資料夾裡面。

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

其中， export_archive_path就是我們存放archive結果的資料夾。
這條命令執行以後，會在指定的位置生成.xcarchive檔案（其實這個是資料夾來的。裡面會有.app包和dSYM符號檔案等內容）
以我們的單工程demo為例：

export_archive_path=/Users/mac/Desktop/簡書/AutoPackageScript/project_demo/AutoPackageScriptDemo/Package/AutoPackageScriptDemo_20180108/AutoPackageScriptDemo.xcarchive
xcodebuild archive -project AutoPackageScriptDemo.xcodeproj -scheme AutoPackageScriptDemo -configuration Release -archivePath ${export_archive_path}
1818095-3d5d3ab49b2c86f6.png
命令執行成功會生成.xcarchive檔案

1818095-4a4169030e104603.png
.xcarchive檔案裡面的內容

exportArchive,從xcarchive中匯出ipa包

將剛才archive出來的.xcarchive檔案，匯出成一個ipa包。

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

export_archive_path就是剛才匯出.xcarchive檔案路徑
export_ipa_path是要匯出的ipa檔案的資料夾路徑
export_options_plist_path這是一個plist配置檔案路徑。這個plist配置檔案是必須的，不加的話會報錯的。經過我的測試發現，主要是需要配置method這個key。如果是手動管理的話，還需要配置bundleID和mobileprovision_name。其他的key是可以不配置的，如果不配置的話，會自動根據專案裡面的配置進行生成。另外，這個檔案我在指令碼中用PlistBuddy命令直接生成了，不需要使用者自己指定檔案。
-allowProvisioningUpdates主要目的是自動更新profile檔案，在Xcode自動管理profile的時候用。
以我們的單工程demo為例：

export_ipa_path=/Users/mac/Desktop/簡書/AutoPackageScript/project_demo/AutoPackageScriptDemo/Package/AutoPackageScriptDemo_20180108
export_options_plist_path=/Users/mac/Desktop/簡書/AutoPackageScript/project_demo/AutoPackageScriptDemo/ExportOptions.plist
xcodebuild  -exportArchive \
            -archivePath ${export_archive_path} \
            -exportPath ${export_ipa_path} \
            -exportOptionsPlist ${export_options_plist_path} \
            -allowProvisioningUpdates

其中，ExportOptions.plist配置檔案我只設定了method 。
1818095-655a6b514c49ee41.png
ExportOptions.plist配置檔案

命令執行成功之後會生成我們需要的ipa檔案和其他的幾個東西。
1818095-a9f021c608c3df54.png
exportArchive成功之後生成的檔案

其中，
ipa檔案就是我們需要的安裝包。
DistributionSummary.plist檔案是一些詳細的簽名資訊。
ExportOptions.plist檔案其實就是我們在exportArchive命令時要用的，但在exportArchive之後會自動生成一個完整的檔案。如果不知道該怎麼寫這個配置檔案的話，可以直接參考我demo中生成的這個plist檔案。
Packaging.log這個檔案就是打包的時候產生的log了，可以檢視日誌記錄。

參考

指令碼和demo都放到github上面去了。https://github.com/shixueqian/AutoPackageScript
本指令碼主要參考了自動打包ipa檔案並上傳fir.im託管平臺的shell指令碼

謙言忘語

嗯，一個很簡單的小東西，大家有時候可以嘗試使用一些小指令碼完成一些簡單重複的工作，說不定會讓生活變得更好。

相關文章