OCLint内置了72条检测规则，如果对这些规则不加以自定义的话很可能会出现上万条不规范的内容，代码是为了实现功能，规范也一定要注意，但是不能本末倒置，我找了一个比较老的工程进行了测试，输出的报告如下：

这个工程的代码量其实还算不上很大，已经出现了这么多不符合规则的内容，粗略整理了一下，大概有三十多条检测规则是代码中比较常用的。

OCLint常见规则

定义具体检测规则

上面所列出来的规则是可以根据我们的项目需要进行自定义的，比如设置每行代码最多200个字符。

-rc=LONG_LINE=200

设置变量名称最长40个字符

-rc=LONG_VARIABLE_NAME=40

忽略某些检测规则

-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 

生成报告

可以选择输出html格式的报告，直接使用浏览器就可以查看结果。

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

脚本文件

每次都使用命令行进行代码的扫描，其实是很费劲的一件事情，可以直接使用脚本文件进行检测。

#!/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"     #颜色结束符



# 寻找项目的 ProjectName
function searchProjectName () {
    # maxdepth 查找文件夹的深度
    find . -maxdepth 1 -name "*.xcodeproj"
}

function oclintForProject () {
    # 预先检测所需的安装包是否存在
    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}
    # 字符串替换函数。//表示全局替换 /表示匹配到的第一个结果替换。
    path=${path//.\//}  # ./BridgeLabiPhone.xcodeproj -> BridgeLabiPhone.xcodeproj
    path=${path//.xcodeproj/} # BridgeLabiPhone.xcodeproj -> BridgeLabiPhone
    
    myworkspace=$path".xcworkspace" # workspace名字
    myscheme=$path  # scheme名字
    
    # 清除上次编译数据
    DIR=~/Library/Developer/Xcode/DerivedData/
    echo -e $COLOR_SUCC'🚀🚀🚀🚀🚀清除上次编译数据🚀🚀🚀🚀🚀'$COLOR_SUCC
    rm -r -- "$DIR"*

     # # 生成编译数据
    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编译数据生成完毕🚀🚀🚀🚀🚀'$COLOR_SUCC
    else
    echo -e $COLOR_ERR'❌❌❌xcpretty编译数据生成失败❌❌❌'$COLOR_ERR
    return -1
    fi

    if [ -f ./compile_commands.json ]; then
    echo -e $COLOR_SUCC'🚀🚀🚀🚀🚀xcpretty编译数据生成完毕🚀🚀🚀🚀🚀'$COLOR_SUCC
    else
    echo -e $COLOR_ERR'❌❌❌xcpretty编译数据生成失败❌❌❌'$COLOR_ERR
    return -1
    fi

    echo -e $COLOR_SUCC'🚀🚀🚀🚀🚀OCLint代码分析开始🚀🚀🚀🚀🚀'$COLOR_SUCC
    # 生成报表
    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分析数据生成完毕🚀🚀🚀🚀🚀'$COLOR_SUCC
    else
    echo -e $COLOR_ERR'❌❌❌oclint分析数据生成失败❌❌❌'$COLOR_ERR
    return -1
    fi
  
}

oclintForProject $1

OCLint的不足之处

OCLint可以检测出来许许多多代码不规范的地方，这些不规范会影响代码的可读性问题，不易于维护，时间长了会造成很多技术债，但是更深层次的问题比如资源泄漏，内存泄漏这类问题OCLint是无法检测出来的，需要借助其他工具，比如Facebook的Infer，这个放到下一篇再去分享。