寫在前面
之前寫了一個很簡單的ipa打包腳本,主要是用Xcode命令中的xcodebuild和xcrun命令來完成的,其中打包ipa的命令用了PackageApplication,本來用的好好的,升級了Xcode9之后,發(fā)現(xiàn)蘋果把PackageApplication這個東西給刪了,于是腳本就跪了。。。
所以,這兩個月我用了一個很原始的方法來打ipa包。大家也可以試試(大家常用的直接用Xcode中的Product->Archive的方法我就懶得說了,大家都懂):
1.自己在Xcode配置好項目的簽名
2.用Generic iOS Device來build工程
3.找到生成的.app包,然后新建一個名為Payload的文件夾,將.app包放到文件夾里面
4.壓縮Payload文件夾,然后將壓縮包的后綴從.zip改成.ipa。
然后就可以將ipa包安裝到手機上測試了。
為什么需要一個ipa打包腳本
嗯,因為想偷懶。
直接在Xcode上點擊Product->Archive->此處省略n步選擇.......這種方式確實是挺方便的,估計很多人也是這么干的。但是,當(dāng)你多次打包了之后你就發(fā)現(xiàn),打包這事好無聊。每次都是同樣的配置,同樣的操作步驟,同樣的選擇,這么簡單的操作我居然要重復(fù)N遍。。。而且有時候要等很久才能進行下一步。總之我覺得這種方式操作多了很是蛋疼。
我一直秉承一個理念:能用機器自動解決的問題盡量不用人工操作。
要是有一個東西,只要我配置好了一次之后,以后直接雙擊就能直接打包,是不是比之前的方式更好?
嗯,有挺多這種工具的,比如shenzhen,fastlane等等。
不過我是自己寫了一個簡單的shell腳本來實現(xiàn)功能的,比較簡單,而且不會對項目有侵入性。借此還可以順便學(xué)習(xí)下shell腳本使用。
自動打包腳本如何使用?
腳本的github地址為:https://github.com/shixueqian/AutoPackageScript
使用方法:
- 1.將腳本復(fù)制到工程的根目錄
- 2.用代碼編輯軟件(比如Xcode)打開腳本,然后根據(jù)情況修改腳本內(nèi)的一些參數(shù)
- 3.打開終端,輸入
sh ${打包腳本的全路徑}
就可執(zhí)行打包腳本。
比如我的項目工程在
/Users/mac/Desktop/AutoPackageScriptDemo
,
那么我的腳本路徑應(yīng)該是
/Users/mac/Desktop/AutoPackageScriptDemo/AutoPackageScript.sh
,
所以我要執(zhí)行的命令是
sh /Users/mac/Desktop/AutoPackageScriptDemo/AutoPackageScript.sh
sh ${打包腳本的全路徑}
這行命令的作用是執(zhí)行shell打包腳本。
除了這樣執(zhí)行,我們還可以直接雙擊腳本文件就執(zhí)行腳本,不過在這之前我們需要進行一些設(shè)置。
首先,將AutoPackageScript.sh文件的擴展名去掉,變成AutoPackageScript
然后,打開終端,執(zhí)行命令chmod +x ${打包腳本的全路徑}
,這樣可以給腳本加上可執(zhí)行權(quán)限,并且默認的打開方式是終端。
例如:chmod +x /Users/mac/Desktop/AutoPackageScriptDemo/AutoPackageScript
以后,直接鼠標雙擊就可以執(zhí)行腳本了
腳本參數(shù)配置
看了腳本的使用,其中有一個很關(guān)鍵的東西,腳本參數(shù)配置。我對多種情況都有適配,所以腳本參數(shù)會稍微有點復(fù)雜,以下我們慢慢道來。
項目的工程結(jié)構(gòu)
我也不知道怎么稱呼這個東西,簡單來講就是你的工程里面是不是使用xcworkspace(工作空間)來管理你的工程。
我們在Xcode直接新建一個iOS工程,這個時候僅僅只有一個.xcodeproj文件,是沒有.xcworkspace文件的。
而很多的項目都采用了cocoapods來管理項目,這個時候是有.xcworkspace文件的,cocoapods通過xcworkspace來管理了第三方庫。
這兩種結(jié)構(gòu)的參數(shù)配置是不一樣的。(因為寫腳本的時候有區(qū)別)
# 是否編譯工作空間 (例:若是用Cocopods管理的.xcworkspace項目,賦值true;用Xcode默認創(chuàng)建的.xcodeproj,賦值false)
is_workspace="false"
# .xcworkspace的名字,如果is_workspace為true,則必須填。否則可不填
workspace_name=""
# .xcodeproj的名字,如果is_workspace為false,則必須填。否則可不填
project_name="AutoPackageScriptDemo"
# 指定項目的scheme名稱(也就是工程的target名稱),必填
scheme_name="AutoPackageScriptDemo"
注釋其實已經(jīng)寫得很清楚了。舉個例子,github上的workspace_demo是通過.xcworkspace來管理的:
所以這幾個參數(shù)就是
is_workspace="true"
workspace_name="AutoPackageScriptDemo"
project_name=""
scheme_name="AutoPackageScriptDemo"
否則,像github上面的project_demo里面的單工程結(jié)構(gòu)就是
is_workspace="false"
workspace_name=""
project_name="AutoPackageScriptDemo"
scheme_name="AutoPackageScriptDemo"
method,打包的方式。
證書簽名的方式,是通過腳本中的method變量控制的。
分別為 development, ad-hoc, app-store, enterprise 。看到這幾個參數(shù)估計都明白了吧?還不是不太了解的話建議看下蒲公英的這篇文檔
# method,打包的方式。方式分別為 development, ad-hoc, app-store, enterprise 。必填
method="development"
profile文件的管理方式
一般來說,證書管理方式,如今應(yīng)該挺多人使用Xcode自動管理的。省心而且方便(老實說,由于工作原因,我平常比較少用自動管理,都是手動管理的,所以理解有誤的話請?zhí)岢觯?br>
在Xcode->Preferrence->Account里面添加開發(fā)者賬號,然后在工程的General->勾選Automatically manage signing->選擇開發(fā)者賬號。就可以自動管理了。
另外一種就是古老的手動管理方式了。
在開發(fā)者后臺上面創(chuàng)建BundleID,然后創(chuàng)建mobileprovision文件,安裝到Xcode上面選擇使用。
針對這兩種方式有不同的配置。
# 下面兩個參數(shù)只是在手動指定Pofile文件的時候用到,如果使用Xcode自動管理Profile,直接留空就好
# (跟method對應(yīng)的)mobileprovision文件名,需要先雙擊安裝.mobileprovision文件.手動管理Profile時必填
mobileprovision_name=""
# 項目的bundleID,手動管理Profile時必填
bundle_identifier=""
注釋講得很清楚,使用Xcode自動管理profile的話直接留空就好了。
如果使用手動管理的話就需要填寫對應(yīng)的參數(shù)了。
源碼解析
腳本代碼其實很簡單的。主要講解一下關(guān)鍵代碼。
先把源碼放出來:
#!/bin/sh
# 使用方法:
# step1: 將該腳本放在工程的根目錄下(跟.xcworkspace文件or .xcodeproj文件同目錄)
# step2: 根據(jù)情況修改下面的參數(shù)
# step3: 打開終端,執(zhí)行腳本。(輸入sh ,然后將腳本文件拉到終端,會生成文件路徑,然后enter就可)
# =============項目自定義部分(自定義好下列參數(shù)后再執(zhí)行該腳本)=================== #
# 是否編譯工作空間 (例:若是用Cocopods管理的.xcworkspace項目,賦值true;用Xcode默認創(chuàng)建的.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"
# 下面兩個參數(shù)只是在手動指定Pofile文件的時候用到,如果使用Xcode自動管理Profile,直接留空就好
# (跟method對應(yīng)的)mobileprovision文件名,需要先雙擊安裝.mobileprovision文件.手動管理Profile時必填
mobileprovision_name=""
# 項目的bundleID,手動管理Profile時必填
bundle_identifier=""
echo "--------------------腳本配置參數(shù)檢查--------------------"
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"
# =======================腳本的一些固定參數(shù)定義(無特殊情況不用修改)====================== #
# 獲取當(dāng)前腳本所在目錄
script_dir="$( cd "$( dirname "$0" )" && pwd )"
# 工程根目錄
project_dir=$script_dir
# 時間
DATE=`date '+%Y%m%d_%H%M%S'`
# 指定輸出導(dǎo)出文件夾路徑
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}"
# 指定導(dǎo)出ipa包需要用到的plist配置文件的路徑
export_options_plist_path="$project_dir/ExportOptions.plist"
echo "--------------------腳本固定參數(shù)檢查--------------------"
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開始構(gòu)建項目 \033[0m"
# 進入項目工程目錄
cd ${project_dir}
# 指定輸出文件目錄不存在則創(chuàng)建
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
# 檢查是否構(gòu)建成功
# xcarchive 實際是一個文件夾不是一個文件所以使用 -d 判斷
if [ -d "$export_archive_path" ] ; then
echo "\033[32;1m項目構(gòu)建成功 ?? ?? ?? \033[0m"
else
echo "\033[31;1m項目構(gòu)建失敗 ?? ?? ?? \033[0m"
exit 1
fi
echo "------------------------------------------------------"
echo "\033[32m開始導(dǎo)出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
# 根據(jù)參數(shù)生成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導(dǎo)出 ${ipa_name}.ipa 包成功 ?? ?? ?? \033[0m"
open $export_path
else
echo "\033[31;1m導(dǎo)出 ${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結(jié)構(gòu)是相似的),參數(shù)配置完成之后,clean下工程,用以清除緩存,保證我們的項目是純凈的。
跟我們在Xcode中Product->Clean這個命令是一樣的功能。
xcodebuild clean -project ${project_name}.xcodeproj \
-scheme ${scheme_name} \
-configuration ${build_configuration}
project_name
就是我們之前配置的工程的名稱,
scheme_name
就是之前配置的工程的target名稱
build_configuration
為之前配置的設(shè)置,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結(jié)果的文件夾。
這條命令執(zhí)行以后,會在指定的位置生成.xcarchive文件(其實這個是文件夾來的。里面會有.app包和dSYM符號文件等內(nèi)容)
以我們的單工程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}
exportArchive,從xcarchive中導(dǎo)出ipa包
將剛才archive出來的.xcarchive文件,導(dǎo)出成一個ipa包。
xcodebuild -exportArchive \
-archivePath ${export_archive_path} \
-exportPath ${export_ipa_path} \
-exportOptionsPlist ${export_options_plist_path} \
-allowProvisioningUpdates
export_archive_path
就是剛才導(dǎo)出.xcarchive文件路徑
export_ipa_path
是要導(dǎo)出的ipa文件的文件夾路徑
export_options_plist_path
這是一個plist配置文件路徑。這個plist配置文件是必須的,不加的話會報錯的。經(jīng)過我的測試發(fā)現(xiàn),主要是需要配置method這個key。如果是手動管理的話,還需要配置bundleID和mobileprovision_name。其他的key是可以不配置的,如果不配置的話,會自動根據(jù)項目里面的配置進行生成。另外,這個文件我在腳本中用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配置文件我只設(shè)置了method 。其中,
ipa文件就是我們需要的安裝包。
DistributionSummary.plist文件是一些詳細的簽名信息。
ExportOptions.plist文件其實就是我們在exportArchive命令時要用的,但在exportArchive之后會自動生成一個完整的文件。如果不知道該怎么寫這個配置文件的話,可以直接參考我demo中生成的這個plist文件。
Packaging.log這個文件就是打包的時候產(chǎn)生的log了,可以查看日志記錄。
參考
腳本和demo都放到github上面去了。https://github.com/shixueqian/AutoPackageScript
本腳本主要參考了自動打包ipa文件并上傳fir.im托管平臺的shell腳本
謙言忘語
嗯,一個很簡單的小東西,大家有時候可以嘗試使用一些小腳本完成一些簡單重復(fù)的工作,說不定會讓生活變得更好。