iOS代码静态分析工具—Facebook Infer的安装及使用

随着公司业务的发展，完全依赖人工保证工程质量也变得越来越不牢靠。所以，静态分析，这种可以帮助我们在编写代码的阶段就能及时发现代码错误，从而在根儿上保证工程质量的技术，就成为了 iOS 开发者最常用的代码调试技术。

Infer的介绍

下面，我就跟大家介绍一款在iOS开发中常用的静态分析工具-Infer:
Infer 是 Facebook 开源的、使用 OCaml(https://ocaml.org/)写成的，可以对 Java、C 和 Objective-C 程序进行分析。
Infer 最早部署在 Facebook 内部，用于发布移动应用之前对每一行代码进行分析，目前 Facebook 使用此工具分析所开发的 Android、iOS 应用,包括 Facebook Messenger、Instagram 和其他一些应用。 Infer 不仅仅用于移动应用程序的分析，还可以分析 C、Java 等不是 Android 系统的代码。 目前 Infer 着重于发现一些诸如空指针的访问、资源和内存的泄露等导致手机程序崩溃或性能严重下降的问题。

Infer的安装：

Infer的安装分为两种方式：
如果电脑没有安装homebrew的话先安装一下，Homebrew是一款Mac OS平台下的软件包管理工具，拥有安装、卸载、更新、查看、搜索等很多实用的功能。Homebrew的安装如下命令：

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

为MacOSX安装Infer需要的依赖，这些工具在后面编译时会用到，命令行指令如下：

brew install autoconf automake cmake opam pkg-config sqlite gmp mpfr
brew cask install java
从源码安装
# Checkout Infer
git clone https://github.com/facebook/infer.git
cd infer
# 编译 Infer
./build-infer.sh clang
# 配置环境变量
#使用下面这句,这句话是要在你下载的infer目录下执行
echo "export PATH=\"\$PATH:`pwd`/infer/bin\"" \ >> ~/.bash_profile 
#下面句表示立即生效
source ~/.bash_profile
#检查看有没有配置好：
echo $PATH
直接安装 binary releases
brew install infer

infer就安装好了。

Infer的使用

接下来通过事例，给大家分享下如何使用Infer:
首先，使用Xcode创建一个OC项目比如：名字叫InferTest。

分析单个文件

项目中创建一个类InferTest并且编写一段代码，代码如下：
.h文件：

#import <Foundation/Foundation.h>

@interface InferTest : NSObject

@end

.m文件：

#import "InferTest.h"
@interface InferTest ()
@property NSMutableDictionary *dict;
@end

@implementation InferTest

- (instancetype)init
{
    self = [super init];
    if (self) {
        NSString *nsmeStr = nil;
        [self.dict setObject:nsmeStr forKey:@"name"];
    }
    return self;
}

@end

在终端输入：

cd InferTest.m所在的目录
infer -- clang -c InferTest.m

结果如下：

Found 3 issues

InferTest.m:21: error: NULL_DEREFERENCE
  pointer `nsmeStr` last assigned on line 20 could be null and is dereferenced by call to `setObject:forKey:` at line 21, column 9.
  19.       if (self) {
  20.           NSString *nsmeStr = nil;
  21. >         [self.dict setObject:nsmeStr forKey:@"name"];
  22.       }
  23.       return self;

InferTest.m:11: warning: ASSIGN_POINTER_WARNING
  Property `dict` is a pointer type marked with the `assign` attribute at line 11, column 1. Use a different attribute like `strong` or `weak`.
  9.   #import "InferTest.h"
  10.   @interface InferTest ()
  11. > @property NSMutableDictionary *dict;
  12.   @end
  13.   

InferTest.m:11: warning: ASSIGN_POINTER_WARNING
  Property `dict` is a pointer type marked with the `assign` attribute at line 11, column 1. Use a different attribute like `strong` or `weak`.
  9.   #import "InferTest.h"
  10.   @interface InferTest ()
  11. > @property NSMutableDictionary *dict;
  12.   @end
  13.   


Summary of the reports

  ASSIGN_POINTER_WARNING: 2
        NULL_DEREFERENCE: 1

一个错误两个警告：
一个错误是:

pointer `nsmeStr` last assigned on line 20 could be null and is dereferenced by call to `setObject:forKey:` at line 21, column 9.
  19.       if (self) {
  20.           NSString *nsmeStr = nil;
  21. >         [self.dict setObject:nsmeStr forKey:@"name"];
  22.       }
  23.       return self;

意思就是第20行的nsmeStr为空，被第21行setObject: forKey:所引用。
我们都知道可变字典setObject: forKey:赋值，object不能为nil，否则程序会崩溃错误。
然后我们给nameStr赋上非空值：

NSString *nsmeStr = @"张三";

重新运行分析编译命令：

infer -- clang -c InferTest.m

发现就只有两个警告了，如下：

Found 2 issues

InferTest.m:11: warning: ASSIGN_POINTER_WARNING
  Property `dict` is a pointer type marked with the `assign` attribute at line 11, column 1. Use a different attribute like `strong` or `weak`.
  9.   #import "InferTest.h"
  10.   @interface InferTest ()
  11. > @property NSMutableDictionary *dict;
  12.   @end
  13.   

InferTest.m:11: warning: ASSIGN_POINTER_WARNING
  Property `dict` is a pointer type marked with the `assign` attribute at line 11, column 1. Use a different attribute like `strong` or `weak`.
  9.   #import "InferTest.h"
  10.   @interface InferTest ()
  11. > @property NSMutableDictionary *dict;
  12.   @end
  13.   


Summary of the reports

  ASSIGN_POINTER_WARNING: 2

意思就是属性dict应该用strong或者weak来修饰。接下来我们把dict的修饰属性加上：

@property (nonatomic,strong)NSMutableDictionary *dict;

重新运行分析编译命令：

infer -- clang -c InferTest.m

结果发现就没有问题了：

  No issues found
分析整个项目

命令行如下：

cd 到项目所在的目录
infer -- xcodebuild -target InferTest -configuration Debug -sdk iphonesimulator

分析结果如下：

Found 1 issue

InferTest/InferTest.m:21: error: NULL_DEREFERENCE
  pointer `nsmeStr` last assigned on line 20 could be null and is dereferenced by call to `setObject:forKey:` at line 21, column 9.
  19.       if (self) {
  20.           NSString *nsmeStr = nil;
  21. >         [self.dict setObject:nsmeStr forKey:@"name"];
  22.       }
  23.       return self;


Summary of the reports

  NULL_DEREFERENCE: 1

发现了空值的问题，但是没有报告可变字典属性修饰的警告，跟单个文件编译略有差异。

分析带cocoapods的项目

命令行如下：

cd 到项目所在目录
//***代表项目名或者scheme名
infer --  xcodebuild -workspace ./***.xcworkspace -configuration Debug -scheme ***

分析结果和正常项目一样，分析结果在：项目目录->infer-out->bugs.txt

Found 1 issue

InferTest/InferTest.m:21: error: NULL_DEREFERENCE
  pointer `nsmeStr` last assigned on line 20 could be null and is dereferenced by call to `setObject:forKey:` at line 21, column 9.
  19.       if (self) {
  20.           NSString *nsmeStr = nil;
  21. >         [self.dict setObject:nsmeStr forKey:@"name"];
  22.       }
  23.       return self;


Summary of the reports

  NULL_DEREFERENCE: 1
过滤掉我们引入的第三库等不想做分析的文件

方法一：
而当我们在项目中使用了很多第三方的时候，其实我们只想让Infer分析我们的代码，而不想分析第三方的代码，不然分析报告中会有很多第三方的issue，看着混乱，这时我们可以用命令行过滤掉关于不想分析的文件。比如用到cocoapods的项目，我们想过滤掉Pods引入的第三方库，命令行如下：

INFER_ARGS="--skip-clang-analysis-in-path^[\"Pods\"]" infer -- xcodebuild -workspace ./***.xcworkspace -configuration Debug -scheme ***

in-path后面跟的是一个忽略文件或者文件夹的路径数组。
方法二：
在项目的根目录创建一个.inferconfig类型的配置文件（我以这种方式过滤Pods引入的第三方库没有成功，如果有简友过滤成功还望不吝告知一下😄）

How to include project folders or exclude dependency folders during analysis of iOS project? I
Yes, there is a way to exclude certain directories. I'll illustrate it by example let me know if it works for you.
If your use case is different/more complex let me know as well.

Let's say I have a project with following directory structure.

<ROOT>
  - <Lib> // libraries that your project depends on.
    - <ExternalDeps> // you want to skip analyzing those
    - <InternalLibs> // you want to analyze those
  - <Src> // implementation of your project 
  - <Headers> // headers of your project
  - <Docs> // irrelevant
We have a way of providing extra information to guide the analyzer by .inferconfig file (it's in json format)

Step 1:
Create .inferconfig file (name is important) in <ROOT> directory

Step 2:
Add entry for skip-clang-analysis-in-path with list of all paths relative to <ROOT>.
.inferconfig file should look like this:

{
    "skip-clang-analysis-in-path": [
        "Lib/ExternalDeps"
    ]
}
Step 3:
Run infer from <ROOT> directory (it's important for infer to find .inferconfig file there). If you have to run infer from different directory, you have pass --project-root flag to your infer invocation. And that's all.
Infer工作流程

Infer 工作的流程：

  • 第一个阶段是转化阶段，将源代码转成 Infer 内部的中间语言。类 C 语言使用 Clang 进行编译，Java 语言使用javac 进行编译，编译的同时转成中间语言，输出到 infer-out目录。

  • 第二个阶段是分析阶段，分析 infer-out 目录下的文件，分析每个方法，如果出现错误的话会继续分析下一个方法，不会被中断，但是会记录下出错的位置，最后将所有出错的地方进行汇总输出。默认情况下，每次运行 infer 命令都会删除之前的 infer-out文件，你可以通过 --incremental 参数使用增量模式。增量模式下，运行 infer 命令不会删除 infer-out文件，但是会利用这个文件夹进行 diff，减少分析量。
    Infer 的工作流程图如下：


    Infer 的工作流程图

Infer使用过程中遇到的一些问题：

  1. 分析某一个文件报错（fatal error: 'UIKit/UIKit.h' file not found）
    解决方案：
//在命令中加 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk
infer -- clang -c -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk ViewController.m
  1. 分析带ARC特有的修饰(如weak或者__weak)或者其他的情况:
//命令行中加-fobjc-arc
infer -- clang -c -fobjc-arc InferTest.m
  1. 如果infer分析编译报错，忽略错误继续分析
infer --keep-going
  1. 有时候发现编译分析结果不全，此时可以先清理一下，然后再编译：
//工程清理命令
xcodebuild -target InferTest -configuration Debug -sdk iphonesimulator clean
//或者带cocoapods的项目清理命令
xcodebuild -workspace ./InferTest.xcworkspace -configuration Debug -scheme InferTest clean

然后再运行Infer分析的命令

  1. 遇到更多的问题请到github上Facebook Infer的仓库issues中去找，绝大多数的问题都能找到你想要的答案，传送门：https://github.com/facebook/infer/issues

参考文献：
戴铭的Clang、Infer 和 OCLint ，我们应该使用谁来做静态分析

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,039评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,223评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 161,916评论 0赞 351
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,009评论 1赞 291
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,030评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,011评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,934评论 3赞 416
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,754评论 0赞 271
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,202评论 1赞 309
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,433评论 2赞 331
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,590评论 1赞 346
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,321评论 5赞 342
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,917评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,568评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,738评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,583评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,482评论 2赞 352