OCLint 与 xcodebuild 的使用

其实在iOS日常开发当中，我们习惯用xcodebuild analyze命令来对项目来进行代码静态检查，而且我们Xcode本身就支持了这个命令，使用起来也很方便，在我们编写代码的时候，xcodebuild analyze就会给出警告或者错误提示。

xcodebuild analyze：

image.png

Xcode 的操作方式

xcodebuild analyze在代码编写过程中给出的提示

image.png

其他的提示还有类似于

1.某段代码永远不会被执行
2.某段代码可能会引起死循环或者内存泄露
3.某个属性的修饰符不匹配
等等问题 xcodebuild analyze都会给出相应的警告。而OCLint我看了许多的文章，也自己去写过几个demo看了一下其输出的可视化报告，我觉得其更多的是对代码规范的一种弥补和帮助QA对代码质量进行监督的一种方式方法。

简单对比一下OCLint 和 xcodebuild analyze的区别吧，也好对症下药，有什么样的需求就用什么

xcodebuild analyze

最大的好处就是方便，只要你下载好了Xcode就可以使用，它会在你写代码的过程中提示你的代码出现了什么问题，或者在你编译完，在其左侧会有一个警告和报错列表，你可以点击其中一个就能跳转到对应的代码所在的地方。当然，OCLint也可以和Xcode结合使用，实现一样的功能。
xcodebuild analyze常用的命令行和指令：
xcodebuild analyze
xcodebuild clean
xcodebuild build
但是对于QA来说，需要定期执行静态代码检查，势必要加入到持续集成系统中，最好是可以通过命令行执行；并且我们需要的是一个分类统计的结果，逐条列出便于跳转的结果方便开发自查，但不方便QA对代码质量进行把控。所以考虑引入OCLint。

OCLint的安装：
我习惯用homebrew 进行安装
1.安装homebrew（不了解的请自行百度一下）

brew tap oclint/formulae
brew install oclint

3.运行oclint确认是否安装成功，看到如下信息说明安装成功。

$ oclint
oclint: Not enough positional command line arguments specified!
Must specify at least 1 positional arguments: See: oclint -help

安装成功之后我们就可以开始使用了。

xcodebuild 与 oclint结合

1.生成可视化文档
1.1.
xcodebuild analyze | tee xcodebuild.log
将xcodebuild analyze的输出信息记录在xcodebuild.log中。
1.2.
oclint-xcodebuild xcodebuild.log对log进行解析，生成compile_command.json。进行到这一步后命令行提示:

image.png

生成compile_command.json文件

image.png

Please consider using xcpretty (https://github.com/supermarin/xcpretty) instead!终端提示需要安装xcpretty格式化报告

安装xcpretty(遇到问题可能是你的gem source的问题)

gem install xcpretty

重新执行一遍命令：

xcodebuild analyze | tee xcodebuild.log | xcpretty --report json-compilation-database

image.png

最后一步生成html或pmd文件

oclint-json-compilation-database -- -report-type pmd -o report.html

or

oclint-json-compilation-database -- -report-type pmd -o report.pmd

image.png

打开report文件：

image.png

可以看到上面显示的信息有哪个文件哪一行有什么问题都有很清晰的说明。
demo地址希望对您有所帮助