iOS代码静态分析平台搭建（三）之Infer集成

关于Infer

“Infer 是一个用于 Java、C 和 Objective-C 的静态程序分析器，用 OCaml编写。Infer 部署在 Facebook 内部，并且持续运行，以验证Android 和 iOS 的主要 Facebook 应用程序、Facebook Messenger、Instagram 和其他应用程序。它也可以用于其他代码：Infer 还可以分析 C 代码和非 Android 的 Java 代码。 Infer 可以跟踪空指针引用以及资源和内存泄漏引起的问题，这些问题会导致移动设备上的一些更重要的问题。”

以上是Infer的官方介绍，之前使用OCLint进行代码分析可以看出，OCLint更偏重于代码规范，这一篇所介绍的Infer则更偏重于功能性的分析，它可以捕获工程中的循环引用，资源泄漏，空指针访问等很危险的问题，因此如果想搭建一个代码静态分析的平台仅仅检测代码规范是完全不够的。

Infer集成

如果你的电脑是Inter的芯片，那么直接使用homebrew安装即可：

 brew install infer

如果你的电脑是M1的芯片就不能通过homebrew来安装了，会报错：Error: infer has been disabled because it does not build!
因此就要去Infer的github官网进行下载。终端cd到你想要放置Infer的目录下，比如我习惯放在Document目录的Tools下面，执行git clone https://github.com/facebook/infer.git。

下载成功之后进入到Infer目录，依次执行以下命令：

# Compile Infer 这一句命令的执行时间可能会有些长
./build-infer.sh clang
# install Infer system-wide...
sudo make install

大概需要二十多分钟后流程结束，输入infer --version查看是否安装成功。

imac0823@BrandoniMac Infer % infer --version
Infer version v1.1.0-14f4ae59c4
Copyright 2009 - present Facebook. All Rights Reserved.

Infer代码扫描

集成成功之后就可以进行代码扫描操作，之前的文章中我们在项目下生成了compile_commands.json文件，可以使用Infer直接对此文件进行检测，在compile_commands.json相同目录下执行以下命令：

//--skip-analysis-in-path 用于忽略文件目录
infer run --skip-analysis-in-path Pods --keep-going --compilation-database compile_commands.json

Infer的检测时间会比较久，耐心等待一会会输出一个项目问题的总览：

问题名称	具体含义	备注
Multiple WeakSelf Use	Objective-C Block多次使用weakSelf。这可能会导致意外的情况出现。即使weakSelf在第一次使用时不为nil，在接下来的使用中也可能为nil，因为weakSelf指向的对象可以随时被释放。应首先将其分配给强指针，然后在块中使用它。
Dead Store	分配给变量的值从未被使用，比如int i= 1;但是这个i却没有使用
Null dereference	空指针引用，一般来说，向 nil 传递消息不会导致崩溃并返回 nil，但直接引用空指针确实会导致崩溃，比如向字典里面添加nil
Mixed Self WeakSelf	Objective-C block同时捕获 self 和weakSelf，可能开发人员打算仅捕获weakSelf以避免循环引用，但犯了一个拼写错误并在块中使用了self，在这种情况下，这可能会导致循环引用。
Parameter Not Null Checked	参数没有进行空判断，如果这个参数为空被引用可能会造成意想不到的后果
Captured strongSelf	block捕获到了strong类型的self
StrongSelf Not Checked	出于某些原因我们可能需要将弱指针赋值给强指针，但是赋值前没有检查指针是否为空，因为weak类型随时都会被置空
Weak Self In No Escape Block	某些使用block作为参数的方法无需使用weak来修饰self
Biabduction Retain Cycle	循环引用

脚本更新

由于新增了Infer检测，因此之前的脚本也要稍稍的进行一些改动

#!/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

    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
    
    echo -e $COLOR_SUCC'🚀🚀🚀🚀🚀Infer代码分析开始🚀🚀🚀🚀🚀'$COLOR_SUCC
    # --skip-analysis-in-path 是忽略扫描目录
    infer run --skip-analysis-in-path Pods --keep-going --compilation-database compile_commands.json

    if [ -f ./infer-out/report.json ]; then
    echo -e $COLOR_SUCC'🚀🚀🚀🚀🚀Infer分析数据生成完毕🚀🚀🚀🚀🚀'$COLOR_SUCC
    else
    echo -e $COLOR_ERR'❌❌❌Infer分析数据生成失败❌❌❌'$COLOR_ERR
    return -1
    fi
  
}

oclintForProject $1

Infer报告查看

执行完扫描命令后项目目录下会多出一个Infer-out文件夹，里面就是具体的扫描结果，有txt，json格式的报告可供查看，还会具体到对应的类以及对应的代码。

无论是Infer还是OCLint的报告查看起来都不算特别直观，因此需要一个平台，可以更加直观具体的看到我们的代码问题，可以借助sonarqube这个平台来分析我们的代码报告，这个平台的集成有非常多的大坑，我已经一一踩过，留到下一篇去记录。