iOS使用Shell指令碼批量修改類名稱

aron1992發表於2019-04-04

背景

公司需要做一系列的殼版本,殼版本如果內容雷同提交到App Store會有被拒絕的風險,在之前的兩篇文章 iOS使用shell指令碼注入混淆內容iOS使用shell指令碼批量修改屬性 中介紹了兩種方式來繞過蘋果後臺的機器審查,這篇文章還是在這個業務場景中,介紹的是使用指令碼批量重新命名類名稱,加強殼版本。

結果

使用方法

  • 開啟測試工程

測試工程位於專案目錄下面的DevPods/InjectedContentKit/Example/目錄下,開啟InjectedContentKit.xcworkspace即可

  • 執行命令

在命令列中進入到專案目錄下面的DevPods/InjectedContentKit/Example/injectContentShell子目錄,在我的電腦對應的目錄為/Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/injectContentShell,然後執行./RenameClasses.sh指令碼檔案批量修改類名

➜  injectContentShell git:(master) pwd
/Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/injectContentShell
➜  injectContentShell git:(master) ./RenameClasses.sh 
目錄存在 /Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/injectContentShell/../injectedContentKit/Business
// .... 省略
new_file_path = /Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/injectContentShell/../InjectedContentKit/Business/Pay/XYZSSCatchPayMethodSchedulerABC.m
批量重新命名類名完成。
複製程式碼

下面是執行指令碼替換了類名的結果圖,指令碼把所有需要替換的類新增了XYZ字首和ABC字尾,執行專案還是可以正常的編譯執行的。如果遇到不正常、編譯不通過或者崩潰的情況,一般的把出現問題的類寫入到黑名單的配置檔案中,以備下一次執行的指令碼的時候把該問題的類排除。

本文的Demo程式碼YTTInjectedContentKit

類名稱修改結果
類名稱修改結果

修改之後的內容不要提交到版本管理系統,首先使用SVN或者GIT的discard功能丟棄修改,還需要執行DeleteClasses.sh指令碼刪除臨時檔案。

➜  injectContentShell git:(master) ✗ ./DeleteClasses.sh 
目錄存在 /Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/InjectedContentKit/Business
刪除檔案>>>/Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/InjectedContentKit/Business/Pay/XYZSSCatchPayMethodSchedulerABC.h
刪除檔案>>>/Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/InjectedContentKit/Business/Pay/XYZSSCatchPayMethodSchedulerABC.m
刪除檔案>>>/Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/InjectedContentKit/Business/XYZSSCatchInviteSchedulerABC.h
刪除檔案>>>/Users/aron/git-repo/YTTInjectedContentKit/DevPods/InjectedContentKit/Example/InjectedContentKit/Business/XYZSSCatchInviteSchedulerABC.m
複製程式碼

分析

原理分析

具體的原理分析可以檢視我的這篇文章 iOS使用shell指令碼批量修改屬性,本質上都是通過修改符號來繞過蘋果後臺的機器稽核

步驟分析

主要有以下幾個步驟,和 iOS使用shell指令碼批量修改屬性 文章中的步驟很類似,有些細節的地方會有些差別而已

  1. 尋找到需要替換的原始檔中的所有的類,處理之後儲存在配置檔案中
  2. 使用者自定義一個黑名單配置檔案
  3. 把需要替換的原始檔中的所有匹配的類名資訊做批量的替換
  4. 修改類原始檔的名稱

實現

單步實現

1. 尋找到需要替換的原始檔中的所有的類,處理之後儲存在配置檔案中

這一步的功能是客戶端指定一個需要處理的原始碼資料夾,遞迴遍歷該原始碼資料夾獲取所有原始碼檔案。把找到的類名稱暫時儲存到陣列中,最後經過黑名單過濾、去重過濾、其他過濾條件過濾,最終把待處理的類名儲存到客戶指定的輸出檔案中。

這部分功能的原始碼如下:
檔名: GetAndStoreClasses.sh

#!/bin/bash
########################
# 指令碼功能:生成重新命名的類的配置指令碼
# 輸入引數 -i 輸入的資料夾
# 輸入引數 -o 儲存的檔案
########################


####### 引數定義
param_input_dir=""
param_output_file=""


####### 引數解析
echo "引數>>${@}"
while getopts :i:o: opt
do
	case "$opt" in
		i) param_input_dir=$OPTARG
			echo "Found the -i option, with parameter value $OPTARG"
			;;
		o) param_output_file=$OPTARG
			echo "Found the -o option, with parameter value $OPTARG"
			;;
		*) echo "Unknown option: $opt";;
	esac
done
echo "param_input_dir = ${param_input_dir}"
echo "param_output_file = ${param_output_file}"


####### 配置

# 屬性黑名單配置檔案
blacklist_cfg_file="$(pwd)/DefaultClassesBlackListConfig.cfg"


####### 資料定義

# 定義儲存需要處理目標檔案的陣列
declare -a implement_source_file_array
declare -a implement_source_file_name_array
implement_source_file_count=0

# mark: p384
# 遞迴函式讀取目錄下的所有.m檔案
function read_implement_file_recursively {
	echo "read_implement_file_recursively"
	if [[ -d $1 ]]; then
		for item in $(ls $1); do
			itemPath="$1/${item}"
			if [[ -d $itemPath ]]; then
				# 目錄
				echo "處理目錄 ${itemPath}"
				read_implement_file_recursively $itemPath
				echo "處理目錄結束====="
			else 
				# 檔案
				echo "處理檔案 ${itemPath}"
				if [[ $(expr "$item" : '.*\.m') -gt 0 ]]; then
					echo ">>>>>>>>>>>>mmmmmmm"
					implement_source_file_array[$implement_source_file_count]=${itemPath}
					class_name=${item//".m"/""};
					implement_source_file_name_array[$implement_source_file_count]=${class_name}
					implement_source_file_count=$[ implement_source_file_count + 1 ];
				fi
				echo ""
			fi
		done
	else
		echo "err:不是一個目錄"
	fi
}

post_implement_file_handle() {
	local wirte_to_file=$1
	# 寫入檔案中
	echo "# 需要處理的類配置檔案" > ${wirte_to_file}
	for(( i=0;i<${#implement_source_file_name_array[@]};i++)) 
	do 
		class_file_name=${implement_source_file_name_array[i]}; 
		echo ${class_file_name} >> ${wirte_to_file}
	done;

	# 去重
	wirte_to_file_bak="${wirte_to_file}.bak"
	mv ${wirte_to_file} ${wirte_to_file_bak}
	sort ${wirte_to_file_bak} | uniq > ${wirte_to_file}

	# 過濾
	mv ${wirte_to_file} ${wirte_to_file_bak}
	echo "# Properties Configs Filtered" > ${wirte_to_file}
	IFS_OLD=$IFS
	IFS=$'\n'
	# 上一行的內容
	lastLine="";
	for line in $(cat ${wirte_to_file_bak} | sed 's/^[ \t]*//g')
	do
		grep_result=$(grep ${line} ${blacklist_cfg_file})
		category_judge_substring="\+"
		if [[ ${#line} -le 6 ]] || [[ $(expr "$line" : '^#.*') -gt 0 ]] || [[ -n ${grep_result} ]] || [[ ${line} =~ ${category_judge_substring} ]]; then
			# 長度小於等於6、註釋內容的行、在黑名單中的內容、分類檔案不處理
			echo "less then 6 char line or comment line"
		else
			if [[ -n ${lastLine} ]]; then
				# 上一行是非空白行
				# 比較上一行內容是否是當前行的一部分,不是新增上一行
				if [[ ${line} =~ ${lastLine} ]]; then
					echo "${line}${lastLine} 有交集"
				else
					echo ${lastLine} >> ${wirte_to_file}
				fi
			fi
			# 更新上一行
			lastLine=${line}
		fi	
	done
	IFS=${IFS_OLD}

	# 刪除臨時檔案
	rm -f ${wirte_to_file_bak}
}

read_implement_file_recursively ${param_input_dir}
post_implement_file_handle ${param_output_file}


複製程式碼

使用以上指令碼生成的配置檔案 RenameClasses.cfg 部分如下:

# Properties Configs Filtered
AppDelegate
CatchRecordViewController
SSCatchAboutUsScheduler
SSCatchAccountHandler
SSCatchActivityManager
SSCatchActivityScheduler
SSCatchAddressListOrganizer
SSCatchAddressListScheduler
複製程式碼

2. 使用者自定義一個黑名單配置檔案

在實踐的過程中,有些類檔案的歸屬不明確,比如屬於業務的類檔案有部分放到了技術分類的資料夾下,這樣對業務的類檔案是有依賴的,而重新命名類的時候不會對這部分類檔案進行操作,而他所依賴的業務類檔案發生了變化,就會出現編譯錯誤的情況。對於這類問題,一種方法是去調整類位置,或者還需要進行一些重構,比較麻煩;另一種簡單的方法是黑名單中配置一些預設的過濾專案,對於黑名單中的這些專案不處理即可,在我的業務場景下,黑名單檔案的配置如下:

檔名:DefaultClassesBlackListConfig.cfg

# DefaultClassesBlackListConfig.cfg
SSCatchRequest
SSCatchCouponSampler
SSCatchRoomRecordTiler
SSCatchColorFormatter
複製程式碼

3. 把需要替換的原始檔中的所有匹配的類名資訊做批量的替換

這一步在前面兩部的基礎上,查詢並替換原始碼目錄中在 RenameClasses.cfg 配置檔案中出現的類和類引用,查詢使用grep命令、替換使用了sed命令。指令碼程式碼如下

# 2、根據規則修改類名
function add_prefix_suffix_to_class {
	# 2.1、類新增字首和字尾
	for (( i = 0; i < ${#config_content_array[@]}; i++ )); do
		original_class_name=${config_content_array[i]};
		result_class_name="${class_prefix}${original_class_name}${class_suffix}"

		sed -i '{
			s/'"${original_class_name}"'/'"${result_class_name}"'/g
		}' `grep ${original_class_name} -rl ${pbxproj_dir}`
		sed -i '{
			s/'"${original_class_name}"'/'"${result_class_name}"'/g
		}' `grep ${original_class_name} -rl ${class_name_replace_dir}`

		sed -i '{
			s/'"${original_class_name}"'/'"${result_class_name}"'/g
		}' `grep ${original_class_name} -rl ${class_name_replace_support_dir}`

		echo "正在處理類 ${original_class_name}..."
	done
}
複製程式碼

4. 修改類原始檔的名稱

使用 mv 命令重新命名在 RenameClasses.cfg 配置檔案中出現的類

# 3、修改類的檔名稱
function rename_class_file {
	echo "class_name_replace_dir >> ${class_name_replace_dir}"
	for (( i = 0; i < ${#config_content_array[@]}; i++ )); do
		
		original_class_name=${config_content_array[i]};
		result_class_name="${class_prefix}${original_class_name}${class_suffix}"

		# .h 檔案
		pattern="${original_class_name}\.h"
		find_result=$(find ${class_name_replace_dir} -name ${pattern})
		new_file_path=${find_result/$original_class_name/$result_class_name}
		echo "find_result = ${find_result}"
		echo "new_file_path = ${new_file_path}"
		mv -f $find_result $new_file_path

		# .m 檔案
		pattern="${original_class_name}\.m"
		find_result=$(find ${class_name_replace_dir} -name ${pattern})
		new_file_path=${find_result/$original_class_name/$result_class_name}
		echo "find_result = ${find_result}"
		echo "new_file_path = ${new_file_path}"
		mv -f $find_result $new_file_path

	done
}

複製程式碼

完整重新命名類的指令碼

#!/bin/bash
########################
# 指令碼功能:類重新命名指令碼
# 輸入引數 -i 輸入的資料夾
# 輸入引數 -o 儲存的檔案
########################


####### 配置
# 定義需要替換的類的查詢目錄,作為引數傳遞給GenRenameClasses.sh指令碼使用,最終獲取到的類名稱儲存到配置檔案中,以給後續步驟使用
class_search_dir="$(pwd)/../injectedContentKit/Business000"
# class_search_dir="$(pwd)/../injectedContentKit/Business"
class_search_dir="/Users/aron/PuTaoWorkSpace/project/sscatch/sscatch/Classes/Business"
# 配置檔案
cfg_file="$(pwd)/RenameClasses.cfg"

# project.pbxproj檔案目錄,需要替換該配置檔案中的類的名稱配置
pbxproj_dir="$(pwd)/../InjectedContentKit.xcodeproj000"
# pbxproj_dir="$(pwd)/../InjectedContentKit.xcodeproj"
pbxproj_dir="/Users/aron/PuTaoWorkSpace/project/sscatch/sscatch.xcodeproj"

# 定義該目錄下的檔案需要進行批量替換處理
class_name_replace_dir="$(pwd)/../InjectedContentKit000"
# class_name_replace_dir="$(pwd)/../InjectedContentKit"
class_name_replace_dir="/Users/aron/PuTaoWorkSpace/project/sscatch/sscatch/Classes/Business"

# 定義該目錄下的檔案需要進行批量替換處理
class_name_replace_support_dir="$(pwd)/../InjectedContentKit000"
# class_name_replace_support_dir="$(pwd)/../InjectedContentKit"
class_name_replace_support_dir="/Users/aron/PuTaoWorkSpace/project/sscatch/sscatch/SupportingFiles"


# 類字首
class_prefix="XYZ"
# 類字尾
class_suffix="ABC"


####### 配置檢查處理

# 匯入工具指令碼
. ./FileUtil.sh

# 檢測 class_search_dir
checkDirCore $class_search_dir "指定類的查詢目錄不存在"
class_search_dir=${CheckInputDestDirRecursiveReturnValue} 

# 檢測 pbxproj_dir
checkDirCore $pbxproj_dir "指定專案配置目錄(pbxproj所在的目錄,一般是 xxx.xcodeproj)不存在"
pbxproj_dir=${CheckInputDestDirRecursiveReturnValue}

# 檢測 class_name_replace_dir
checkDirCore $class_name_replace_dir "指定類名稱修改的目錄不存在"
class_name_replace_dir=${CheckInputDestDirRecursiveReturnValue}

# 檢測 class_name_replace_support_dir
checkDirCore $class_name_replace_support_dir "指定類名稱修改的目錄不存在"
class_name_replace_support_dir=${CheckInputDestDirRecursiveReturnValue}


# 檢測或者建立配置檔案
checkOrCreateFile $cfg_file


####### 資料定義
# 定義儲存類名稱的陣列
declare -a config_content_array
cfg_line_count=0

# 1、讀取配置檔案內容儲存到陣列中
read_config_content_to_array() {
	# 讀取配置檔案
	echo "開始讀取配置檔案..."
	# mark: p291
	IFS_OLD=$IFS
	IFS=$'\n'
	# 刪除檔案行首的空白字元 http://www.jb51.net/article/57972.htm
	for line in $(cat $cfg_file | sed 's/^[ \t]*//g')
	do
		is_comment=$(expr "$line" : '^#.*')
		echo "line=${line} is_common=${is_comment}"
		if [[ ${#line} -eq 0 ]] || [[ $(expr "$line" : '^#.*') -gt 0 ]]; then
			echo "blank line or comment line"
		else
			config_content_array[$cfg_line_count]=$line
			cfg_line_count=$[ $cfg_line_count + 1 ]
			echo "line>>>>${line}"
		fi	
	done
	IFS=${IFS_OLD}

	for (( i = 0; i < ${#config_content_array[@]}; i++ )); do
		config_content=${config_content_array[i]};
		echo "config_content>>>>>>${config_content}"
	done
}


# 2、根據規則修改類名
function add_prefix_suffix_to_class {
	# 2.1、類新增字首和字尾
	for (( i = 0; i < ${#config_content_array[@]}; i++ )); do
		original_class_name=${config_content_array[i]};
		result_class_name="${class_prefix}${original_class_name}${class_suffix}"

		sed -i '{
			s/'"${original_class_name}"'/'"${result_class_name}"'/g
		}' `grep ${original_class_name} -rl ${pbxproj_dir}`
		sed -i '{
			s/'"${original_class_name}"'/'"${result_class_name}"'/g
		}' `grep ${original_class_name} -rl ${class_name_replace_dir}`

		sed -i '{
			s/'"${original_class_name}"'/'"${result_class_name}"'/g
		}' `grep ${original_class_name} -rl ${class_name_replace_support_dir}`

		echo "正在處理類 ${original_class_name}..."
	done
}

# 3、修改類的檔名稱
function rename_class_file {
	echo "class_name_replace_dir >> ${class_name_replace_dir}"
	for (( i = 0; i < ${#config_content_array[@]}; i++ )); do
		
		original_class_name=${config_content_array[i]};
		result_class_name="${class_prefix}${original_class_name}${class_suffix}"

		# .h 檔案
		pattern="${original_class_name}\.h"
		find_result=$(find ${class_name_replace_dir} -name ${pattern})
		new_file_path=${find_result/$original_class_name/$result_class_name}
		echo "find_result = ${find_result}"
		echo "new_file_path = ${new_file_path}"
		mv -f $find_result $new_file_path

		# .m 檔案
		pattern="${original_class_name}\.m"
		find_result=$(find ${class_name_replace_dir} -name ${pattern})
		new_file_path=${find_result/$original_class_name/$result_class_name}
		echo "find_result = ${find_result}"
		echo "new_file_path = ${new_file_path}"
		mv -f $find_result $new_file_path

	done
}

# 獲取需要重新命名的類名稱,儲存到配置檔案中
./GetAndStoreClasses.sh\
	-i ${class_search_dir}\
	-o ${cfg_file}

# 讀取配置檔案內容儲存到陣列中
read_config_content_to_array
# 類名以及引用新增字首和字尾
add_prefix_suffix_to_class
# 修改類檔名字
rename_class_file

echo "批量重新命名類名完成。"

複製程式碼

刪除重新命名後的類檔案

這裡有個需要注意的地方是不要把重新命名後的類提交到SVN或者Git,使用完了之後使用Revert功能回滾程式碼即可,因為提交了之後你的配置檔案會失效,需要重新整理。我們公司使用的是SVN,revert操作之後重新命名之後的檔案不會revert,所以有了這個指令碼,批量刪除重新命名之後的檔案。

#!/bin/bash
########################
# 指令碼功能:刪除類重新命名指令碼產生生成的類
########################

####### 配置
# 定義需要替換的類的查詢目錄,作為引數傳遞給GenRenameClasses.sh指令碼使用,最終獲取到的類名稱儲存到配置檔案中,以給後續步驟使用
class_search_dir="$(pwd)/../injectedContentKit/Business000"
class_search_dir="/Users/aron/PuTaoWorkSpace/project/sscatch/sscatch/Classes/Business"

# 類字首
class_prefix="XYZ"
# 類字尾
class_suffix="ABC"


####### 配置檢查處理
# 匯入工具指令碼
. ./FileUtil.sh

# 檢測 class_search_dir
checkDirCore $class_search_dir "指定類的查詢目錄不存在"
class_search_dir=${CheckInputDestDirRecursiveReturnValue} 

# 也可以使用$(grep -rl "XYZ.*ABC" ${class_search_dir})
for class_file_path in `grep -rl "XYZ.*ABC" ${class_search_dir}`; do
	echo "刪除檔案>>>${class_file_path}"
	rm -f ${class_file_path}
done

複製程式碼

總結

以上就是基於Shell指令碼,以殼版本為場景,把類的批量替換做了一個半自動化的實現步驟,如果不妥之處,還請不吝賜教。

相關文章