Code Review
代码评审，代码静态检查，Objective-C代码静态检查工具——OCLint
Github: https://github.com/bobwongs/BWCodeReview
Contents
- Overview
- OCLint
- 给Xcode项目集成OCLint
- 1、安装
- 2、配置
- 3、静态代码分析
- OCLint已有规则的自定义
- 给Xcode项目集成OCLint
- Summary
- Next
- Reference
- Follow Me
Overview
- 编写符合项目团队规范的代码
- 检查和提高项目代码质量
- 提高项目的可维护性
- 弥补由Xcode原本的代码检查所不能检查到的问题代码的不足，让代码保持更高质量
OCLint
对C、C++、Objective-C进行静态代码检查的工具
给Xcode项目集成OCLint
1、安装
必要的工具：OCLint、xcpretty（美化xcodebuild的命令行输出日志工具）
选择性安装：Homebrew（The missing package manager for macOS，Mac OS的包管理器，可以便捷地安装很多常用的工具）
资源下载地址
OCLint：https://github.com/oclint/oclint/releases，选择最新的版本进行下载
xcpretty：https://github.com/supermarin/xcpretty，安装命令：gem install xcpretty，首先要安装有gem
Homebrew：https://brew.sh/，安装命令：/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
OCLint的安装
Reference：http://docs.oclint.org/en/stable/intro/installation.html
1、解压OCLint安装包，打开终端，切换到解压出来的OCLint安装包目录
code_review_install_resource
code_review_execute_cp_command
2、执行脚本
OCLINT_HOME=/path/to/oclint-release
export PATH=$OCLINT_HOME/bin:$PATH
cp bin/oclint* /usr/local/bin/
cp -rp lib/* /usr/local/lib/
3、安装结果的验证，终端输入oclint，输出如下结果为安装成功
$ oclint
oclint: Not enough positional command line arguments specified!
Must specify at least 1 positional arguments: See: oclint -help
另外，也可以用Homebrew进行安装和更新
安装
brew tap oclint/formulae
brew install oclint
更新
brew update
brew upgrade oclint
2、配置
在项目根目录下创建用于分析的Shell脚本文件analysis.sh
code_review_project_directory_analysis
以下为analysis.sh文件内的脚本
# 移除原有的生成文件
xcodebuild clean | xcpretty
rm -r build
rm -r compile_commands.json
# Build和把日志写到目标文件
xcodebuild | xcpretty -r json-compilation-database --output compile_commands.json
Reference
http://docs.oclint.org/en/stable/guide/xcode.html
https://gist.github.com/ryuichis/755e6297aec13c900cdf
Xcode -> Build Phases -> New Run Script Phase -> Run Script，配置生成代码不规范相关警告的Shell脚本
code_review_run_script
oclint-json-compilation-database -- -report-type xcode
说明：如果要在项目源码中进行代码检查，那么在检查的时候才开启上述Xcode里面配置的脚本，不需要进行检查，打包测试，提交到Git上的时候记得把检查脚本注释掉，不然在Build之前都会先执行分析脚本，看具体情况对这段代码进行注释或者开启
3、静态代码分析
在命令行切换到项目根目录，运行analysis.sh，生成build目录和用于生成警告的compile_commands.json文件
code_review_execute_analysis_shell
code_review_execute_analysis_shell_result_file
如果项目中有.xcworkspace，则在使用xcodebuild命令，没有指定相应的参数时是会失败的，但是没关系，只要能确保命令行的输出里面看到有compile的字眼就OK，因为OCLint的原理就是从compile的源文件中去检查的
如下图所示，即使是Build Failed，也是没问题的，也同样能生成供OCLint进行静态代码检查的文件
code_review_execute_analysis_shell_workspace
对Xcode项目进行Command+B操作，等oclint命令对compile_commands.json文件分析完成，就能查看到由于编码不规范生成的警告
code_review_analysis_result_warning
OCLint已有规则的自定义
Reference
OCLint查看帮助命令：oclint -help
OCLint代码静态检查规则的查看命令：oclint rt -list-enabled-rules
OCLint configuration file：http://docs.oclint.org/en/stable/howto/rcfile.html
Project Configuration File
仅针对单个项目的已有规则的自定义，在项目根目录下创建.oclint文件，可以使用Shell命令快速创建
code_review_oclint_file_location
touch .oclint # 创建.oclint文件
.oclint文件自定义已有规则
示例一
关闭已有的一些检查规则
查看已有检查规则的命令：oclint rt -list-enabled-rules
disable-rules:
- LongLine
- LongVariableName
- UnusedMethodParameter
示例二
自定义已有规则的限值，例如单行字数的上限
Reference：http://docs.oclint.org/en/stable/howto/thresholds.html
disable-rules:
- LongLine
rulePaths:
- /etc/rules
rule-configurations:
- key: CYCLOMATIC_COMPLEXITY
value: 15
- key: LONG_LINE
value: 200
output: oclint.xml
report-type: xml
max-priority-1: 20
max-priority-2: 40
max-priority-3: 60
enable-clang-static-analyzer: false
Summary
- 对项目代码质量进行周期性检查
- 及时修改不符合规范的代码
- 让项目问题杜绝在代码编写的层面
Next
- 自定义OCLint的检查规则
- Code Review的规范
- Objective-C编码规范
- Swift编码规范
Reference
OCLint
- http://oclint.org/
- http://docs.oclint.org/en/stable/
- http://docs.oclint.org/en/stable/guide/xcode.html
Follow Me
Github: https://github.com/bobwongs
Sina: http://weibo.com/bobwongs
欢迎打赏！
网友评论