OCLint代码扫描工具详解

官方文档:http://oclint.org/
OCLint的官方文档写的非常细致,如果有问题,可以去上面查找!!!(这是读过一遍的感受)

OCLint简介

OCLint是一个基于clang的静态扫描工具,支持C,C++,Objective-C等语言问题查找,主要包含以下几大类问题:
可能的Bug - 空的 if / else / try / catch / finally 语句
未使用的代码 - 未使用的局部变量和参数
复杂的代码 - 高圈复杂度, NPath复杂, 高NCSS
冗余代码 - 多余的if语句和无用的括号
坏味道的代码 - 过长的方法和过长的参数列表
不好的使用 - 倒逻辑和入参重新赋值

OCLint特点

优点:有更多的检查规则和定制,和很多工具集成,接入持续集成相对简单。
缺点: 使用复杂,检测速度慢,致命类问题检测较少
针对语言:针对C,C++和Objective-C

OCLint安装

可以看官方文档推荐的安装方式:http://docs.oclint.org/en/stable/intro/installation.html
如果你用的是mac,已经安装了Homebrew,那么你可以使用一下命令安装:

$ brew tap oclint/formulae
$ brew install oclint

更新:

$ brew update
$ brew upgrade oclint

OCLint命令详解

使用命令:http://docs.oclint.org/en/stable/guide/xcodebuild.html
xcodebuild -target DemoProject -configuration Debug -scheme DemoProject | xcpretty -r json-compilation-database -o compile_commands.json

oclint-json-compilation-database -e DemoProject -- -report-type html -rc=LONG_LINE=200 -rc=NCSS_METHOD=100 -o=report.html

命令详解:
USAGE: oclint [subcommand] [options] <source0> [... <sourceN>]

OPTIONS:
OCLint options:

-R=<directory> - Add directory to rule loading path
添加目录到规则加载路径

-allow-duplicated-violations - Allow duplicated violations in the OCLint report
允许在报告中重复出现违规行为

-disable-rule=<rule name> - Disable rules
不允许的规则

-enable-clang-static-analyzer - Enable Clang Static Analyzer, and integrate results into OCLint report
使用clang的静态分析并将结果添加到报告中

-enable-global-analysis - Compile every source, and analyze across global contexts (depends on number of source files, could results in high memory load)
编译每个源文件,并跨全局上下文进行分析(取决于源文件的数量,可能导致高内存负载)

-extra-arg=<string> - Additional argument to append to the compiler command line
编译器命令行后面添加的参数

-extra-arg-before=<string> - Additional argument to prepend to the compiler command line
编译器命令行前面添加的参数

-list-enabled-rules - List enabled rules
启用规则列表

-max-priority-1=<threshold> - The max allowed number of priority 1 violations
优先级1的最大允许违规次数

-max-priority-2=<threshold> - The max allowed number of priority 2 violations
优先级2的最大允许违规次数

-max-priority-3=<threshold> - The max allowed number of priority 3 violations
优先级3的最大允许违规次数

-no-analytics - Disable the anonymous analytics
禁用匿名分析

-o=<path> - Write output to <path>
输出报告路径

-p=<string> - Build path
构建路径

-rc=<parameter>=<value> - Override the default behavior of rules
重载默认规则

-report-type=<name> - Change output report type
改变输出报告类型

-rule=<rule name> - Explicitly pick rules
选择规则

-p <build-path> is used to read a compile command database.
用于读取编译命令数据库

<source0> ... specify the paths of source files.
指定源文件的路径

OCLint规则汇总

Thresholds

Name Description Default
CYCLOMATIC_COMPLEXITY Cyclomatic complexity of a method 10
LONG_CLASS Number of lines for a C class or Objective-C interface, category, protocol, and implementation 1000
LONG_LINE Number of characters for one line of code 100
LONG_METHOD Number of lines for a method or function 50
LONG_VARIABLE_NAME Number of characters for a variable name 20
MAXIMUM_IF_LENGTH Number of lines for the if block that would prefer an early exists 15
MINIMUM_CASES_IN_SWITCH Count of case statements in a switch statement 3
NPATH_COMPLEXITY NPath complexity of a method 200
NCSS_METHOD Number of non-commenting source statements of a method 30
NESTED_BLOCK_DEPTH Depth of a block or compound statement 5
SHORT_VARIABLE_NAME Number of characters for a variable name 3
TOO_MANY_FIELDS Number of fields of a class 20
TOO_MANY_METHODS Number of methods of a class 30
TOO_MANY_PARAMETERS Number of parameters of a method 10

OCLint使用感悟:

OCLint检查的规则非常多,也可以定制检查规则,但是OCLint扫描的问题中,更多的是偏向于代码规范,可读性等代码写的好不好的问题,而不是对不对,比如:方法行数、类文件函数,变量命名等,对于代码中存在的致命bug的检查,效果不是很好,所以想要扫描出一些致命问题,需要自己定制检查规则,使用成本较高,infer相对于OCLint,在致命问题扫描中,比较有优势,所以可以根据项目现状,可以挑选具体使用的工具。

参考资料:
http://oclint.org/
https://www.jianshu.com/p/b81a9f5bcf34

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容