OCLint是什么宣增？
OCLint是一個靜態(tài)代碼分析工具，通過檢查C烤黍，C ++和Objective-C代碼并尋找潛在問題來提高質(zhì)量和減少缺陷：
- 如果/ else / try / catch / finally語句為空
- 未使用的局部變量和參數(shù)
- 高圈復(fù)雜度魂爪，NPath復(fù)雜度和高NCSS
- 冗余if語句和無用的括號
- 長方法和長參數(shù)列表
- 倒置邏輯和參數(shù)重新分配
...
總結(jié):OCLint實現(xiàn)自動化審查代碼規(guī)范蝌数，提升代碼質(zhì)量，幫助廣大開發(fā)者節(jié)省CodeReview的人力~
安裝OClint工具
1贷祈、Homebrew Tap
重點講述下Homebrew安裝OCLint,不為什么趋急，因為這個方法最快速簡單~
安裝OCLint方法:
$ brew tap oclint/formulae
$ brew install oclint
更新OClint方法:
$ brew update
$ brew upgrade oclint
驗證OClint成功安裝
$ oclint
oclint: Not enough positional command line arguments specified!
Must specify at least 1 positional arguments: See: oclint -help
2、安裝包安裝
- 進入oclint release下載頁付燥，下載最新版本安裝包
Source code(tar.gz)宣谈。 - 解壓下載文件得到
oclint-0.14文件，將文件放在某個目錄下键科，如/User/XXX/OCLint闻丑。 - 打開終端編輯
.bash_profile文件(先輸入cd~,然后輸入open -e .bash_profile,這時./bash_profile就會打開)漩怎，將oclint添加到環(huán)境變量中，如下：
OCLint_HOME=/User/XXX/OCLint/oclint-0.14
export PATH=$OCLINT_HOME/bin:$PATH
- 保存文件嗦嗡，關(guān)閉
.bash_profile文件 - 更新剛配置的環(huán)境變量：輸入
source .bash_profile,重啟終端就可以執(zhí)行oclint命令啦~
3勋锤、編譯源碼安裝
這個就不詳細多說了，大家可以看oclint官網(wǎng)說明
xcobuild的安裝
這個只要下載Xcode工具侥祭，即可安裝~
xcpretty 的安裝
sudo gem install -n /usr/local/bin xcpretty
這里說下我遇到的Error問題：
gem install xcpretty
ERROR: While executing gem ... (Gem::FilePermissionError)
You don't have write permissions for the /Library/Ruby/Gems/2.3.0 directory.
所以我換了sudo gem install -n /usr/local/bin xcpretty命令行叁执，就解決了~
OCLint + Xcode結(jié)合使用
1、在工程中矮冬，創(chuàng)建一個新的Target,命令為OCLintTest~
0CDCE218EA7B7376C50AD9DE9B826E31.png
2谈宛、在OCLintTest上添加Run Script,如圖：
D5AB956BD47F4BB5D641674D06874332.png
Xcode上Shell腳本,沒有Pods的腳本編寫代碼：
source ~/.bash_profile
cd ${SRCROOT}
xcodebuild clean
xcodebuild build | tee xcodebuild.log | xcpretty -r json-compilation-database -o compile_commands.json
oclint-json-compilation-database -- -report-type Xcode
編譯后的Xcode警告截圖：
DFB37F40C41B35476D75CA27E5AA6BDE.png
OCLint+shell腳本結(jié)合使用
#!/bin/bash
# 指定編碼
export LANG="zh_CN.UTF-8"
export LC_COLLATE="zh_CN.UTF-8"
export LC_CTYPE="zh_CN.UTF-8"
export LC_MESSAGES="zh_CN.UTF-8"
export LC_MONETARY="zh_CN.UTF-8"
export LC_NUMERIC="zh_CN.UTF-8"
export LC_TIME="zh_CN.UTF-8"
function checkDepend () {
command -v xcpretty >/dev/null 2>&1 || {
echo >&2 "I require xcpretty but it's not installed. Install：gem install xcpretty";
exit
}
command -v oclint-json-compilation-database >/dev/null 2>&1 || {
echo >&2 "I require oclint-json-compilation-database but it's not installed. Install：brew install oclint";
exit
}
}
function oclintForProject () {
# 檢測依賴
checkDepend
projectName=$1
scheme=$2
reportType=$3
REPORT_PMD="pmd"
REPORT_XCODE="Xcode"
myworkspace=${projectName}
myscheme=${scheme}
echo "myworkspace是：${myworkspace}"
echo "myscheme是：${myscheme}"
echo "reportType為：${reportType}"
# 清除上次編譯數(shù)據(jù)
if [ -d ./build/derivedData ]; then
echo '-----清除上次編譯數(shù)據(jù)derivedData-----'
rm -rf ./build/derivedData
fi
# xcodebuild -workspace $myworkspace -scheme $myscheme clean
xcodebuild clean
echo '-----開始編譯-----'
# 生成編譯數(shù)據(jù)
xcodebuild -workspace ${myworkspace} -scheme ${myscheme} -UseModernBuildSystem=NO -derivedDataPath ./build/derivedData -configuration Debug COMPILER_INDEX_STORE_ENABLE=NO | xcpretty -r json-compilation-database -o compile_commands.json
if [ -f ./compile_commands.json ]
then
echo '-----編譯數(shù)據(jù)生成完畢-----'
else
echo "-----生成編譯數(shù)據(jù)失敗-----"
return -1
fi
echo '-----分析中-----'
# 自定義排除警告的目錄，將目錄字符串加到數(shù)組里面
# 轉(zhuǎn)化為：-e Debug.m -e Port.m -e Test
exclude_files=("Pods")
exclude=""
for i in ${exclude_files[@]}; do
exclude=${exclude}"-e "${i}" "
done
echo "排除目錄：${exclude}"
# 分析reportType =~判斷子字符串包含關(guān)系
if [[ ${reportType} =~ ${REPORT_PMD} ]]
then
nowReportType="-report-type html -o pmd.html"
else
nowReportType="-report-type Xcode"
fi
# 自定義report 如：
# nowReportType="-report-type html -o oclint_result.html"
echo "**************${nowReportType}"
# 生成報表
oclint-json-compilation-database ${exclude} -- \
${nowReportType} \
-rc=LONG_CLASS=1500 \
-rc=NESTED_BLOCK_DEPTH=5 \
-rc=LONG_VARIABLE_NAME=80 \
-rc=LONG_METHOD=200 \
-rc=LONG_LINE=300 \
-disable-rule ShortVariableName \
-disable-rule ObjCAssignIvarOutsideAccessors \
-disable-rule AssignIvarOutsideAccessors \
-max-priority-1=100000 \
-max-priority-2=100000 \
-max-priority-3=100000
#rm compile_commands.json
if [[ ${reportType} =~ ${REPORT_PMD} ]] && [ ! -f ./pmd.html ]
then
echo "-----分析失敗-----"
return -1
else
echo '-----分析完畢-----'
return 0
fi
}
# 替換workspace的名字
myworkspace="OCLint.xcworkspace"
# 替換scheme的名字
myscheme="OCLint"
# 輸出方式 Xcode/pmd
reportType="pmd"
oclintForProject ${myworkspace} ${myscheme} ${reportType}
以上就是完整的shell腳本胎署，oclint.sh下載地址,用法：下載oclint.sh文件吆录，拖到Xcode工程目錄下,如圖：
5965A58FB5EE8844DF72D7333C01048D.png
終端進入工程目錄，執(zhí)行命令行,就可以自動審查代碼規(guī)范啦~
./oclint.sh
執(zhí)行后生成的html文件琼牧，打開界面如圖：
oclint report.png
OCLint + Jenkins實現(xiàn)自動化審查代碼規(guī)范
一恢筝、在Jenkins的插件管理里面，下載PMD插件并安裝
二巨坊、Jenkins新建自由任務(wù)撬槽，如圖：
F80B7C4D8AD60FA74CCF68F6D0691A3F.png
三、工程相關(guān)配置
1趾撵、General
這里我選的是github上我的一個項目侄柔，參數(shù)化構(gòu)建過程我添加了Git Parameter的分支參數(shù)，用于選擇構(gòu)建的一個分支鼓寺，如圖：
屏幕快照 2019-07-11 下午4.46.47.png
2勋拟、源碼管理
這里我設(shè)置了git倉庫地址以及自己的用戶賬號和密碼勋磕，還有分支參數(shù)妈候，如圖所示：
FDA6444B-6A5A-40E3-BD39-70CD27252243.png
3、構(gòu)建觸發(fā)器
我選的是定時構(gòu)建~
4挂滓、構(gòu)建
選擇執(zhí)行shell,shell里面代碼與oclint.sh不同的地方就是：
#這里是將xcpretty的安裝路徑導(dǎo)入到j(luò)enkins苦银，為了解決xcpretty命令找不到的錯誤
export PATH=$PATH:/usr/local/bin
#拉取git工程
git clean -df
git fetch
git reset --hard $GIT_BRANCH
#代碼修改為pmd格式的，因為展示在pmd插件上
nowReportType="-report-type pmd -o pmd.html"
#還有修改赶站，查找文件路徑地方也要做相應(yīng)的修改
project_path=$(pwd)
cd "${project_path}/BaSiBuDeJie"
echo "pwd === $(pwd)"
# 替換workspace的名字
myworkspace="BaSiBuDeJie.xcworkspace"
# 替換scheme的名字
myscheme="BaSiBuDeJie"
# 輸出方式 Xcode/pmd
reportType="pmd"
5幔虏、構(gòu)建后操作
構(gòu)建后操作需要選上PMD的插件了，如圖所示：
6B0A4D8841569B2BB8410F11E96AA297.png
6贝椿、Jenkins + OCLint結(jié)合操作后的效果圖
PMD Warning.png
