在Android Studio或git/github中执行编码风格并在团队中进行警告和无线提示

Question

我想以一种方式设置我们的项目,以确保为签入强制执行编码风格和警告以及无棉花.我还想让开发人员非常容易地看到他们不合规的时候.

理想情况下,当您编辑文件或运行构建时,这将在Android Studio中显示(我们所有的开发人员都在使用相同的IDE).此外,当开发人员克隆回购时,将此强制执行"正常工作",而不是需要任何其他手动设置,这将是很好的.

最干净的方法是什么？

Answer 1

Checkstyle,FindBugs和PMD等静态代码分析器可以为您提供帮助.
它们可以配置为在这些脚本的帮助下与Gradle和Android Studio一起使用 .如果根据分析器的配置错误的某些事情会失败.

由于这些scrips与Gradle集成在一起,因此可以提交repo并在开发人员克隆它时工作.

遗憾的是,生成的报告未与Android Studio集成,因此使用gradle包装器从控制台构建和运行检查的更好方法.静态分析器的任务配置为依赖于check任务,因此./gradlew check命令将全部运行它们.

报告位于$project.buildDir/reports目录中,但也可以更改.

Checkstyle配置非常灵活.它们可以配置为您喜欢的任何代码样式.例如,Google Java Code Checkstyle配置.

PMD具有对您的代码运行检查的规则集.它也有android规则.以下是如何为PMD制定规则集配置的指南.

FindBugs可以帮助您找到Java代码中的常见错误.例如,它使用+并检测使用StringBuilder来检测多个字符串串联.它可以配置过滤器文件.

也不要像这样完全关闭lint检查:

lintOptions {
    abortOnError false
}

如果您不喜欢它们,更好的方法是禁用特定检查,例如:

lintOptions {
    disable 'InvalidPackage'
}