OCLint 代码静态分析

OCLint 代码静态分析

为了提高代码质量和代码走查的效率，软件开发过程中一般会使用静态代码分析工具来对程序正确性和稳定性进行检查。静态代码分析利用词法分析、语法分析、抽象语法树以及语义分析等手段检查代码中潜在的错误过程。该过程与动态分析相对应，不需要执行应用程序，直接通过对代码扫描发现隐含的程序问题，并给出一定的修改建议。

OCLint 是基于 Clang 的静态分析工具，支持对 C、C++ 和 Objective-C 代码进行静态分析，它基于 Clang 输出的抽象语法树对代码进行静态分析，支持与现有的 CI 集成，部署之后基本不需要维护，简单方便。

下面将从 OCLint 安装、与 Xcode 集成和与 CI 集成这三个方面来展开介绍。

OCLint 安装

OCLint 支持三种方式安装：

• 下载二进制包，将 bin 目录添加到 PATH 下（.bashrc 或 .bash_profile）

OCLINT_HOME=/path/to/oclint-release
export PATH=$OCLINT_HOME/bin:$PATH

• 拷贝 OCLint 至系统 PATH

直接将二进制拷贝到 PATH 路径下，比如拷贝到 /usr/local/bin，/usr/bin，/bin 目录。这里以 /usr/local/bin 目录为例：

1. `cp bin/oclint* /usr/local/bin/`
2. `cp -rp lib/* /usr/local/lib/`

同时需要将依赖的库放到相应的目录中，oclint 执行时会默认搜索如下目录 $(/path/to/bin/oclint)/../lib/clang, $(/path/to/bin/oclint)/../lib/oclint/rules 和 $(/path/to/bin/oclint)/../lib/oclint/reporters 来查找头文件和动态库。

• Homebrew 安装

安装 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

Xcode 集成

OCLint 支持与 Xcode 集成，集成后只需在 Xcode 中跑一遍脚本即可完成对代码的静态分析，并且在 Xcode 中定位到对应的行。

具体集成步骤如下：

• 添加 Target

在 Xcode 中新增 Aggregate Target：

Paste_Image.png

• 添加 Run Script

Paste_Image.png

• 填充脚本内容

Paste_Image.png

• 执行分析

选择新增的 Scheme，点击编辑或者 Command+B

Paste_Image.png

CI 集成

项目组目前使用 fastlane 进行持续集成，使用一段时间后发现确实大大的减少重复工作，把程序员从重复的工作中解放出来。fastlane 的具体安装使用篇幅较长，后面会另写一篇文章进行介绍，本章重点介绍如果将 fastlane 和 OCLint 集成，支持自动静态分析并上传至 FTP 服务器。

fastlane 初始化成功后会创建一个 fastlane 目录，目录中 Fastfile 文件包含当前 fastlane 所支持的所有任务。这里我们添加一个名叫 lint 的任务，该任务会分别调用静态分析脚本（oclint_ci.sh）和上传脚本（oclint_upload.sh）。

Paste_Image.png

这里重点分析 oclint_ci.sh 脚本：

echo "xcodebuild clean"
xcodebuild clean -workspace tztMobileApp_HTSC.xcworkspace \
-scheme tztHuaTaiZLMobile

执行静态分析前，执行 xcode clean 清除上一次编译生成的文件，这是因为静态分析依赖编译过程中的控制台输出，假如文件未做修改编译器默认会优化编译过程跳过该文件的编译，则该文件的编译过程中就不会产生输出无法进行静态分析。

echo "xcodebuild analyze | tee xcodebuild.log | xcpretty --report json-compilation-database"
xcodebuild -workspace XXXApp.xcworkspace \
-scheme XXXApp analyze | tee xcodebuild.log | \
xcpretty --report json-compilation-database

执行 xcodebuild analyze | tee xcodebuild.log 将 xcodebuild analyze 输出的内容保存到 xcodebuild.log 文件中，并使用 xcpretty 来格式化成 json 格式。

echo "xcodebuild analyze | tee xcodebuild.log | xcpretty --report json-compilation-database"
xcodebuild -workspace XXXApp.xcworkspace \
-scheme XXXApp analyze | tee xcodebuild.log | \
xcpretty --report json-compilation-database

需要注意的是，上一步生成的 json 文件在 build/reports 下，并且名字为compilation_db.json，和 oclint 默认生成的文件命名和路径均不同，因此需要移动至根目录并重命名为 compile_command.json。

echo "mv compilation_db.json compile_commands.json"
mv ./build/reports/compilation_db.json ./compile_commands.json

最后执行 oclint-json-compilation-database 生成静态分析报告，输出成 html 文档。

echo "oclint-json-compilation-database"
oclint-json-compilation-database \
-e Pods \
-- \
-stats \
-verbose \
-report-type=html -o=oclint.html \
-max-priority-1=99999 -max-priority-2=99999 -max-priority-3=99999 \
-rc LONG_LINE=200 \
-rc LONG_METHOD=100 \
-rc LONG_VARIABLE_NAME=40 \
-disable-rule=BrokenOddnessCheck \
-disable-rule=VerifyProhibitedCall \
-disable-rule=VerifyProtectedMethod \
-disable-rule=SubclassMustImplement \
-disable-rule=BaseClassDestructorShouldBeVirtualOrProtected \
-disable-rule=DestructorOfVirtualClass \
-disable-rule=ParameterReassignment \
-disable-rule=AvoidDefaultArgumentsOnVirtualMethods \
-disable-rule=AvoidPrivateStaticMembers \
-disable-rule=TooManyParameters

关于 oclint-json-compilation-database 命令相关参数说明可以参阅官方文档。

Reference:

1.Using OCLint in Xcode
2.OC静态代码检查及持续集成
3.OCLint 使用