IOS OClint 的安装使用与代码分析

前言

oclint 是对C、C++、Objective-C进行静态代码检查的工具 ,使用 oclint 对代码进行静态分析可以检查和提高项目代码质量、寻找潜在的问题........

OCLint 官网简介

oclint 的安装

1.通过 homebrew 安装非常方便、快速 

homebrew 安装方法

2.使用 xcode 代码分析需要安装 oclint和xcpretty,都可以在终端进行安装

打开终端 命令行 依次输入以下命令安装 oclint

brew tap oclint/formulae  

brew install oclint


用gem安装xcpretty

sudo gem install xcpretty


确认下是否成功安装 oclint

终端输入 oclint  如给出以下提示,代表成功安装 oclint

3.使用 oclint

oclint 详细使用方法

使用 oclint 对 xcode 项目进行静态代码分析首先需要项目配置,即添加 target

1.file-new-target


添加target

 next

添加脚本


2.在xcode项目目录下创建分析的Shell脚本文件analysis.sh


创建.sh

3.在.sh 文件中写入以下示例内容(compile_commands.json是生成的日志文件名)

# 移除原有的生成文件

xcodebuild clean | xcpretty

rm -r build

rm -r compile_commands.json

# Build和把日志写到目标文件

xcodebuild | xcpretty -r json-compilation-database --output compile_commands.json

4.使用终端打开项目目录

cd 项目路径 

打开.sh文件 sudo  ./analysis.sh

如果报错

使用sh ./analysis.sh打开即可,终端如以下即开始分析生成目标文件(compile_commands.json)



5.分析完之后打开 xcode,来输入可执行的脚本即可


接下来 command + b 编译 ,如果编译过程中报错 oclint: error: violations exceed threshold

错误原因是超过了issue 的阈值,在脚本末尾加上 -max-priority-1=9999 -max-priority-2=9999 -max-priority-3=9999 

过滤项目中的第三方警告

如果 pod 导入  添加脚本 oclint-json-compilation-database -e Pods

如果手动导入   添加脚本  oclint-json-compilation-database -e FMDB -e XMLReader -e Masonry -e MJRefresh   类似即可


编译成功后Xcode上会在不符合规则的代码上显示Warning


可以自己参考规则列表 来自定义个人需要的规则

关于 oclint 指令 oclint、oclint-json-compilation-database、oclint-xcodebuild

oclint 是核心指令 oclint [options]  -- [compiler flags] 

[options]为一些参数选项,可以是规则加载选项、报告形式选项等:

-R <路径> : 检测所用的规则的路径,默认路径$(/path/to/bin/oclint)/../lib/oclint/rules

-disable-rule <规则名>: 让相对应的规则失效。

-rc <参数>=<值> :修改阈值

-report-type <报告类型>,有"text"、“html”、“json”、“pmd”、“xcode”几个类型

-o <路径> 报告生成路径。

例:oclint  -R  /path/to/rules   -disable-rule ObjCAssignIvarOutsideAccessors -report-type xcode 是指忽略掉规则文件中指定规则

oclint-json-compilation-database 指令

oclint-json-compilation-database 指令有过滤文件选项

-i :包含进某些文件

-e : 过滤掉某些文件

xcpretty

用xcpretty生成OClint 解析用的json 文件

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

推荐阅读更多精彩内容