iOS 代码自动检查工具 - OCLint (记录下主要步骤)

第1步:安装 oclint

brew install oclint

第2步:构建 Xcode 工程

用命令行工具 xcodebuild
命令格式为 xcodebuild [options]
由于需要将输出的日志保存起来,所以需要运行如下命令:
xcodebuild [options] | tee xcodebuild.log
完整例子:Xcode 工程名为 OCLintDemo,构建命令如下:
xcodebuild build -scheme OCLintDemo | tee xcodebuild.log
日志会在终端中输出,同时会保存到 xcodebuild.log 文件中。

第3步:格式化日志

用 OCLint 的 oclint-xcodebuild 命令将第2步的日志文件 xcodebuild.log 格式化为 JSON 格式的文件, 运行 oclint-xcodebuild 后自动创建 compile_commands.json 文件。

NOTE:由于 oclint-xcodebuild 已经不再维护,推荐使用 xcpretty 程序,安装方式:
gem install xcpretty
这个后面再详说。

第4步:分析日志

这一步也即是分析代码。
运行 oclint-json-compilation-database 命令,即会输出分析的结果。包含的信息有不符合规范的个数、在文件中的位置,规范的类别等等。默认是在终端中输出,也可以指定参数按特定格式输出到文件中,如生成 HTML 文件:
oclint-json-compilation-database -- -report-type=html -o result.html
报告内容长这样:

代码分析报告.png

其他

规则文件目录
/usr/local/Cellar/oclint/0.13/lib/oclint/rules
这个目录下是一些.dylib文件,oclint 就是基于这些文件对代码进行规则检查的。如 libLongLineRule.dylib,是单行字符数限制规则。

以上步骤可以写到一个 shell 脚本文件中,在 Xcode 工程根目录中执行脚本就可以自动生成报告。脚本代码如下(工程名为 OCLintTest):

#/usr/bin/bash

# 先清除缓存
echo 'CLEANING DERIVED DATA...'
xcodebuild clean -scheme OCLintTest

# 第1步,构建Xcode工程,生成.log文件
echo 'BUILDING...'
xcodebuild_log_file_name=xcodebuild.log
xcodebuild build -scheme OCLintTest | tee $xcodebuild_log_file_name

# 第2步,将第1步的.log格式化为json
echo 'GENERATING JSON...'
oclint-xcodebuild
echo 'GENERATE SUCCEEDED'

# 第3步,分析日志,生成报告
echo 'ANALYZING...'
report_file_name=OCLintTest_report.html
oclint-json-compilation-database -- -report-type html -o $report_file_name
echo 'ANALYZE SUCCEEDED'
echo 'REUSLT FILE NAME : '$report_file_name

rm $xcodebuild_log_file_name # 删除中间文件
rm compile_commands.json

open $report_file_name

设置系统提供的规则阈值方法如下:

-rc <threshold_name>=<new_value>
-rc CYCLOMATIC_COMPLEXITY = 15 -rc LONG_LINE = 50```

系统提供的规则,可以设定阈值的如下:
名称 描述 默认阈值
CYCLOMATIC_COMPLEXITY 方法的循环复杂性(圈负责度) 10
LONG_CLASS C类或Objective-C接口,类别,协议和实现的行数 1000
LONG_LINE 一行代码的字符数 100
LONG_METHOD 方法或函数的行数 50
LONG_VARIABLE_NAME 变量名称的字符数 20
MAXIMUM_IF_LENGTH if希块的行数 15
MINIMUM_CASES_IN_SWITCH switch语句中的case数 3
NPATH_COMPLEXITY 方法的NPath复杂性 200
NCSS_METHOD 一个没有注释的方法语句数 30
NESTED_BLOCK_DEPTH 块或复合语句的深度 5
SHORT_VARIABLE_NAME 变量名称的字符数 3
TOO_MANY_FIELDS 类的字段数 20
TOO_MANY_METHODS 类的方法数 30
TOO_MANY_PARAMETERS 方法的参数数 10

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

推荐阅读更多精彩内容