OCLint內(nèi)置了72條檢測規(guī)則，如果對這些規(guī)則不加以自定義的話很可能會出現(xiàn)上萬條不規(guī)范的內(nèi)容，代碼是為了實(shí)現(xiàn)功能，規(guī)范也一定要注意，但是不能本末倒置，我找了一個比較老的工程進(jìn)行了測試，輸出的報(bào)告如下：

這個工程的代碼量其實(shí)還算不上很大，已經(jīng)出現(xiàn)了這么多不符合規(guī)則的內(nèi)容，粗略整理了一下，大概有三十多條檢測規(guī)則是代碼中比較常用的。

OCLint常見規(guī)則

定義具體檢測規(guī)則

上面所列出來的規(guī)則是可以根據(jù)我們的項(xiàng)目需要進(jìn)行自定義的，比如設(shè)置每行代碼最多200個字符。

-rc=LONG_LINE=200

設(shè)置變量名稱最長40個字符

-rc=LONG_VARIABLE_NAME=40

忽略某些檢測規(guī)則

-disable-rule ShortVariableName 
-disable-rule UseContainerLiteral
-disable-rule ParameterReassignment 
-disable-rule UseObjectSubscripting 

完整的檢測語句如下：

oclint-json-compilation-database -e Pods -e Applications -- -extra-arg=-Wno-everything -report-type html -o oclintReport.html \-rc=LONG_LINE=200 \-rc=LONG_VARIABLE_NAME=40 \-disable-rule ShortVariableName \-disable-rule UseContainerLiteral \-disable-rule ParameterReassignment \-disable-rule UseObjectSubscripting 

生成報(bào)告

可以選擇輸出html格式的報(bào)告，直接使用瀏覽器就可以查看結(jié)果。

xcodebuild clean build -scheme <your_scheme> -workspace <your_workspace>.xcworkspace -configuration Debug GCC_PRECOMPILE_PREFIX_HEADER=YES COMPILER_INDEX_STORE_ENABLE=NO -sdk iphoneos16.2 | xcpretty -r json-compilation-database -o compile_commands.json

腳本文件

每次都使用命令行進(jìn)行代碼的掃描，其實(shí)是很費(fèi)勁的一件事情，可以直接使用腳本文件進(jìn)行檢測。

#!/bin/bash

COLOR_ERR="\033[1;31m"    #出錯提示
COLOR_SUCC="\033[0;32m"  #成功提示
COLOR_QS="\033[1;37m"  #問題顏色
COLOR_AW="\033[0;37m"  #答案提示
COLOR_END="\033[1;34m"     #顏色結(jié)束符



# 尋找項(xiàng)目的 ProjectName
function searchProjectName () {
    # maxdepth 查找文件夾的深度
    find . -maxdepth 1 -name "*.xcodeproj"
}

function oclintForProject () {
    # 預(yù)先檢測所需的安裝包是否存在
    if which xcodebuild 2>/dev/null; then
    echo 'xcodebuild exist'
    else
    echo 'xcodebuild 未安裝，請安裝Xcode'
    fi
    
    if which oclint 2>/dev/null; then
    echo 'oclint exist'
    else
    export PATH="/Users/imac0823/Documents/Tools/oclint/bin:$PATH"
    source ~/.zshrc
    fi
    if which xcpretty 2>/dev/null; then
    echo 'xcpretty exist'
    else
    echo 'xcpretty 未安裝，請安裝xcpretty'
    fi
    
    
    # 指定編碼
    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"
    export xcpretty=/usr/local/bin/xcpretty # xcpretty 的安裝位置可以在終端用 which xcpretty找到
    
    searchFunctionName=`searchProjectName`
    path=${searchFunctionName}
    # 字符串替換函數(shù)。//表示全局替換 /表示匹配到的第一個結(jié)果替換。
    path=${path//.\//}  # ./BridgeLabiPhone.xcodeproj -> BridgeLabiPhone.xcodeproj
    path=${path//.xcodeproj/} # BridgeLabiPhone.xcodeproj -> BridgeLabiPhone
    
    myworkspace=$path".xcworkspace" # workspace名字
    myscheme=$path  # scheme名字
    
    # 清除上次編譯數(shù)據(jù)
    DIR=~/Library/Developer/Xcode/DerivedData/
    echo -e $COLOR_SUCC'??????????清除上次編譯數(shù)據(jù)??????????'$COLOR_SUCC
    rm -r -- "$DIR"*

     # # 生成編譯數(shù)據(jù)
    xcodebuild GCC_PRECOMPILE_PREFIX_HEADER=YES COMPILER_INDEX_STORE_ENABLE=NO OTHER_CFLAGS="-DNS_FORMAT_ARGUMENT(A)= -D_Nullable_result=_Nullable" clean build -scheme $myscheme -workspace $myworkspace -configuration Debug -sdk iphoneos16.2 |tee xcodebuild.log|xcpretty -r json-compilation-database -o compile_commands.json

    if [ -f ./compile_commands.json ]; then
    echo -e $COLOR_SUCC'??????????xcpretty編譯數(shù)據(jù)生成完畢??????????'$COLOR_SUCC
    else
    echo -e $COLOR_ERR'???xcpretty編譯數(shù)據(jù)生成失敗???'$COLOR_ERR
    return -1
    fi

    if [ -f ./compile_commands.json ]; then
    echo -e $COLOR_SUCC'??????????xcpretty編譯數(shù)據(jù)生成完畢??????????'$COLOR_SUCC
    else
    echo -e $COLOR_ERR'???xcpretty編譯數(shù)據(jù)生成失敗???'$COLOR_ERR
    return -1
    fi

    echo -e $COLOR_SUCC'??????????OCLint代碼分析開始??????????'$COLOR_SUCC
    # 生成報(bào)表
    oclint-json-compilation-database -e Pods -e Applications -- -extra-arg=-Wno-everything -report-type html -o oclintReport.html \-rc=LONG_LINE=200 \-rc=LONG_VARIABLE_NAME=40 \-disable-rule ShortVariableName \-disable-rule UseContainerLiteral \-disable-rule ParameterReassignment \-disable-rule UseObjectSubscripting \-disable-rule AssignIvarOutsideAccessors \-disable-rule UnusedMethodParameter
    
    if [ -f ./oclintReport.html ]; then
    echo -e $COLOR_SUCC'??????????oclint分析數(shù)據(jù)生成完畢??????????'$COLOR_SUCC
    else
    echo -e $COLOR_ERR'???oclint分析數(shù)據(jù)生成失敗???'$COLOR_ERR
    return -1
    fi
  
}

oclintForProject $1

OCLint的不足之處

OCLint可以檢測出來許許多多代碼不規(guī)范的地方，這些不規(guī)范會影響代碼的可讀性問題，不易于維護(hù)，時間長了會造成很多技術(shù)債，但是更深層次的問題比如資源泄漏，內(nèi)存泄漏這類問題OCLint是無法檢測出來的，需要借助其他工具，比如Facebook的Infer，這個放到下一篇再去分享。