iOS代码静态分析工具选择

本文对比iOS常用的几种静态分析工具，分析优缺点，并从中选出适合当前工程的工具，本文的应用系统为macOS。

clang

xcode目前已经集成了clang了，可以直接用Xcode-》Product-》Analyze对代码进行静态分析。也可以用如下命令行实现

 cd Test
 xcodebuild analyze -project Test.xcodeproj -scheme Test -sdk iphonesimulator -configuration Debug CLANG_ANALYZER_OUTPUT=html CLANG_ANALYZER_OUTPUT_DIR="$(pwd)/clang"

clang会分析对应工程的代码，并将结果输出到clang文件夹下。
--html 生成分析结果的html文件。

• clang的优点：
  跟xcode的集成度比较高，也支持命令行，使用方便，解析速度较快。
• 缺点：
  检查规则较少，这个在下文会有详细介绍。

oclint

oclint也是iOS常用的代码静态分析工具，基于clang。目前包含70个规则文件，基本涵盖了clang的检验规则，并在此基础上添加了较多代码规范性规则。可以在这里：http://docs.oclint.org/en/stable/rules/index.html查看具体规则。

• 安装

  brew tap oclint/formulae
  brew install oclint

或者直接到官网https://github.com/oclint/oclint/releases/tag/v20.11下载最新release版本解压即可。

  #设置环境变量
  cd oclint-20.11
  export PATH=$pwd/oclint/bin:$PATH
  source ~/.bash_profile

• 分析代码

  cd Test
  xcodebuild -project Test.xcodeproj -scheme Test -configuration Debug -sdk iphonesimulator clean
  xcodebuild -project Test.xcodeproj -scheme Test -configuration Debug -sdk iphonesimulator | xcpretty -r json-compilation-database -o compile_commands.json 
  oclint-json-compilation-database -- -report-type html -o oclintReport.html

主要流程是通过xcodebuild编译工程，之后用xcpretty输出标准格式的json文件，最后oclint-json-compilation-database分析json文件，并以html格式输出结果。

• oclint的优点：
  输出结果的文件整洁好看，支持自定义规则。
• 缺点：
  解析较慢，规则太多太杂，很多都是代码硬性规范。

infer

infer是Facebook开源的代码静态分析工具，同样是基于clang，可以分析c、objC和java代码。

• 安装

  brew install infer

或者通过源码安装，可以从https://github.com/facebook/infer/blob/master/INSTALL.md了解源码安装的详细步骤。
首先更新依赖库

  brew install autoconf automake cmake opam pkg-config sqlite gmp mpfr
  brew cask install adoptopenjdk8

之后下载infer并build，这个过程可能需要1个多小时

  # Checkout Infer
  git clone https://github.com/facebook/infer.git
  cd infer
  # Compile Infer
  ./build-infer.sh clang
  # install Infer system-wide...
  sudo make install
  # ...or, alternatively, install Infer into your PATH
  export PATH=`pwd`/infer/bin:$PATH

• 分析代码
  infer分析代码需要区分两种情况，第一种没有使用pods、carthage等代码依赖管理工具的工程，可以直接跑下面的命令进行分析

  cd Test
  infer run -- xcodebuild -target Test -configuration Debug -sdk iphonesimulator

对于使用了pods、carthage等代码依赖管理工具的工程，直接跑infer run命令会报错，需要先利用xcodebuild和xcpretty去生成标准格式的json文件，再用infer去分析它并输出结果。

  cd Test
  xcodebuild -project Test.xcodeproj -scheme Test -configuration Debug -sdk iphonesimulator clean
  xcodebuild -project Test.xcodeproj -scheme Test -configuration Debug -sdk iphonesimulator | xcpretty -r json-compilation-database -o compile_commands.json
  infer run --keep-going --compilation-database-escaped compile_commands.json
  infer explore --html

• 分析过程中可能遇到的问题

1. clang-9: error: unknown argument: '-index-store-path'
   这是因为xcode多了一个-index-store-path构建命令，而infer跟oclint都不支持这个构建命令，我们可以通过修改工程build setting中Enable index-While-Building Functionality设置为NO来避免这个问题。
   当然如果不想对工程配置做出修改，那么只需要在xcodebuild的时候设置对应参数即可。
   xcodebuild -showBuildSettings查找'-index-store-path'对应key值为COMPILER_INDEX_STORE_ENABLE，xcodebuild的时候，将其置于NO，这样对工程就不会有任何影响了。

  xcodebuild -project Test.xcodeproj -scheme Test -configuration Debug -sdk iphonesimulator COMPILER_INDEX_STORE_ENABLE=NO

2. infer生成中间文件，开始扫描时报错
   需要注意的是，infer在一些环境下解析到最后一步会报错，并且输出如下图。这个问题在infer的github上也有多人上报，但目前并未解决。但是庆幸的是，此时iner分析所需要的中间代码文件已经生成，所以只要在跑一次infer命令，即可生成最终结果。
   
   image.png

• infer的优点：
  规则相对较完善，容易暴露开发工程中可能引起问题的代码。
• 缺点：
  解析速度慢，且与oclint一样有大量代码硬性规范造成的误报。

验证Demo

为了更直观地对比几种工具的分析结果，笔者做了一个小demo列举了一些开发中常出现的不规范代码，并分别用3种方式分析对比其结果。

截屏2020-12-03 下午10.33.45.png

通过clang扫描可以扫出 未使用变量、字典或者数组插入空值、参数类型不匹配等几种情况。
通过oclint扫描可以扫出 未使用变量、参数类型不匹配以及一些命名规范类的提示。
通过infer扫描可以扫出 可选方法不安全调用、strong声明为weak、传参类型不匹配、未验空、字典或者数组插入空值等几种情况。

对比可以看出，infer在检验规则较多、定位也较为准确。所以目前笔者采用的是infer作为静态分析工具。

小记：
静态分析工具只是辅助，目前开发中大量的代码问题没法通过静态分析定位。诸如监听未移除、timer未停止、野指针、应用场景中导致的循环引用等都无法准确定位。所以开发中还是需要养成良好的开发习惯和代码规范。