OCLint的基础使用

  在ios开发过程中,我们使用Clang这个前端编译工具,将OC代码输出为抽象语法树,然后编译成LLVM的bitcode,最后再编译成machine code。OCLint就是基于Clang实现的通过检查C,C++和Objective-C代码来提高代码质量、降低错误率的静态代码分析工具,代码通过OCLint检测后,可以发现一些潜在的问题。OCLint检测依赖源代码的抽象语法树来保证精准度和效率,尽可能减少误报,同时动态加载规则到系统中进行检测。当然了,OCLint支持用户根据需求定制化检查规则,使得iOS的静态代码检查更符合某个移动应用的自我需求。

OCLint官方文档

OCLint检查内容

  OCLint是一个通过检查C,C++或Objective-C代码来提高代码质量、降低错误率的静态代码分析工具,代码通过OCLint检测后,可以发现一些潜在的问题,如:

    * 可能的bug:if/else/try/catch/finally 空语句空变量
    * 代码无用:并未使用的本地变量和参数
    * 代码过于复杂:高复杂度的循环、判断
    * 代码冗余:冗余的if判断和多余的括号
    * 代码异味:长的方法和长参数列表
    * 不好的尝试:反向逻辑、参数重复赋值

OCLint的特点

  静态代码分析是一个很重要的技术发现编译器中那些不可视的缺点,OCLint自动完成这些检测需要依赖以下特点:

    * 依赖源代码的抽象语法树来保证精准度和效率,尽可能减少误报,避免有用的结果被跳过;
    * 动态加载规则到系统中(甚至是运行期间加载规则);
    * 灵活可扩展的配置保证用户可以定制化静态代码检查工具;
    * 为了技术问题尽早的被修复,降低维护成本,使用命令行运行命令,在代码开发过程中,对代码进行持续集成和检测;

OCLint的获取与安装

  OCLint是一个可以运行在Linux和Mac OS X系统上的独立的工具。安装的时候,可以通过源码安装,需要注意的是,使用源码安装需要配置路径;也可以使用官网给出的Release包进行安装;不过对于Mac系统来说,直接用brew安装要更方便一些。
  使用brew安装:

brew install oclint

执行命令后报错:原因是需要安装brew的第三方依赖库


brew安装oclint报错,提示需要安装依赖库

所以执行brew命令安装第三方依赖库-oclint/formulae:

brew tap oclint/formulae
brew install oclint

安装正常完成,即证明OCLint安装成功。


安装brew的依赖库

  安装完依赖库,再次安装OCLint,安装成功:


安装oclint

安装xcpretty
  xcpretty是什么?现在去网上查看一些教程,会发现,很多教程提到使用oclint-xcodebuild分析日志,但是因为oclint后续不支持oclint-xcodebuild的xctool了,所以推荐安装xcpretty:

安装xcpretty遇到权限问题

第一次安装,权限报错,所以sudo一下:
安装xcpretty

  上面的步骤完成了,就可以使用OCLint进行代码检查了~

PS:作为一个不是经常更新homebrew的人,安装之前,需要先更新一下……这里建议大家定期更新,在使用命令的时候也会比较方便(给一篇homebrew的帖子:你应该定期更新 Homebrew

OCLint的使用

  OCLint如何使用呢?一般来说,静态代码检查的工具都可以直接接入IDE使用,当然也可以直接在终端使用命令实现。下面给出的是OCLInt在命令行中的使用,虽然本文没有提及,但是OCLint在IDE中运行也很方便的,大家可以尝试一下。

  在使用OCLint之前需要先知道OCLint的三个部分(可查看链接):
  oclint
  oclint-json-compilation-database
  oclint-xcodebuild
  这三个命令结合,完成从编译到报告产出的一系列操作。

  将OCLint检查的命令输入终端,即可开始进行代码检查:

# 需要注意的是,有时候会使用xcodebuild -workspace name.xcworkspace clean命令,如果使用了clean命令,会清理编译缓存,本次操作需重新进行编译
# 然后使用xcpretty将编译结果输出成后面需要的.json文件
xcodebuild -workspace WSname.xcworkspace \
-scheme SCname \
-configuration Debug \
build | xcpretty -r json-compilation-database -o compile_commands.json
# 输出.json文件后,将编译结果输出到oclintresult.html中
oclint-json-compilation-database -e Pods -- \
-report-type html -o oclintresult.html \
# 这里添加一个检查规则:最长行数边界为9999,小于两千才可以通过检测
-rc LONG_LINE=9999 \
-max-priority-1=9999 \
-max-priority-2=9999 \
-max-priority-3=9999; \

报错
1、multiple jobs问题:
  基本出现在初次运行oclint或者使用了clean命令,清除了编译缓存之后,会出现下面的错误:

oclint: error: one compiler command contains multiple jobs:xxxx

  找到了一种解决方式:
  oclint: error: one compiler command contains multiple jobs解决方式
2、build成功,但是oclint命令运行不成功:

Build Succeeded
oclint: Not enough positional command line arguments specified!
Must specify at least 1 positional argument: See: /usr/local/bin/oclint -help
done

恩……这个问题莫名的好了……如果发现原因,后续更新~~

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

推荐阅读更多精彩内容

  • 写在前面 刚入职的时候,博哥交代给我一个任务,让我调研一款叫SonarQube的静态代码分析工具,我当时跪在了Ce...
    雨润听潮阅读 2,264评论 0 5
  • 专业考题类型管理运行工作负责人一般作业考题内容选项A选项B选项C选项D选项E选项F正确答案 变电单选GYSZ本规程...
    小白兔去钓鱼阅读 8,983评论 0 13
  • 今天不说知识点,分析一下h5 HTML5现在的情况是: 1 大部分开发者处在正在学习、刚刚入门和准备学习HTML5...
    sakatayui酱阅读 1,040评论 0 0
  • 临摹/小诗 情义这东西,一见如故容易,难的是来日方长。 真正的朋友,分别十年,见了面就像昨天刚刚分手似的。 ...
    爱折腾的诗儿阅读 455评论 3 6
  • 十里黄花斗骄阳。山金黄,水金黄。连天接地,无处放鞋芒。 纵使烂漫一季短。兴不减,意尤长。 本是农家平民色,报春晖,...
    修凡悟真阅读 183评论 0 0