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的第三方依赖库


OCLint的基础使用_第1张图片
brew安装oclint报错,提示需要安装依赖库

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

brew tap oclint/formulae
brew install oclint

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


OCLint的基础使用_第2张图片
安装brew的依赖库

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


OCLint的基础使用_第3张图片
安装oclint

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

安装xcpretty遇到权限问题

第一次安装,权限报错,所以sudo一下:
OCLint的基础使用_第4张图片
安装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

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

你可能感兴趣的:(OCLint的基础使用)