Android开发规范：代码规范(CheckStyle、Reformat Code)(1)

打开一个java文件，右键点击：check current file，结果如下：

修改后：

4. 自定义checkstyle

可以参考google的checkstyle文件，自行修改成为适合自己团队使用的代码规范文件。

checkstyle: gradle

============================================================================

我们配置gradle脚本可以让我们有两种方式去使用checkstyle：

可以直接运行命令执行checkstyle

可以在build app的时候，触发checkstyle任务，用来检测代码规范，如果不符合checkstyle规范，停止运行，并且提供html文件查看错误详情，直到完全符合我们定义的checkstyle规范才能继续运行。

我觉得第二种方式比较使用，使用强制性的方式保证团队成员提交的代码都是符合checkstyle规范的。

操作步骤：

新建一个checkstyle.gradle文件，内容如下：

allprojects {

project ->

// 代码规范检查

apply plugin: ‘checkstyle’

checkstyle {

configFile rootProject.file(‘config/quality/checkstyle/checkstyle.xml’)

toolVersion ‘8.2’

ignoreFailures false

showViolations true

}

task(‘checkstyle’, type: Checkstyle) {

source ‘src/main/java’

include ‘**/*.java’

exclude ‘/gen/’

classpath = files()

}

tasks.whenTaskAdded { task ->

boolean runCheckStyleOnLocalDev = “${enable_checkstyle}”.toBoolean()

boolean runCheckStyleTask = task.name == ‘prepareReleaseDependencies’ || (runCheckStyleOnLocalDev && task.name == ‘preBuild’)

if (runCheckStyleTask) { //prepareReleaseDependencies, preBuild

println(“checkstyle run task.name ：” + task.name)

task.dependsOn ‘checkstyle’

}

}

}

其中config/quality/checkstyle/checkstyle.xml是我们项目中checkstyle文件的路径。

然后在Project的build.gradle文件中加上

apply from: ‘./checkstyle.gradle’

运行：

直接在terminal里面输入：“gradlew checkstyle”，即可运行checkstyle任务，结果如下：

Ctrl+ B，运行build，查看结果如下：

红框内提供了一个检查报告结果的路径，我们可以打开这个html文件格式的report报表，查看详细的检查结果，然后对比修改成符合我们定义的checkstyle规范的标准的代码。

注意：

如果错误太多， 输出的消息不一定会打印出检查结果路径：

如果没输出，我们就到各个工程的build\reports\checkstyle路径下查看即可。

checkstyle: 155条规范

============================================================================

这个是checkstyle官网提供的检查标准，截至目前一共155条。

https://checkstyle.org/checks.html

我们在编写checkstyle的时候可以按照此规范来编写，点击进入有详细的属性介绍，如FileLength：

reformat code: 用快捷键格式化代码

==================================================================================

在编码完成后，我们要养成习惯将文件格式化，保证文件符合我们checkstyle定义的规范。

尾声

以薪资待遇为基础，以发展为最终目标，要在高薪资的地方，谋求最好的发展！

下面是有几位Android行业大佬对应上方技术点整理的一些进阶资料。

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
位Android行业大佬对应上方技术点整理的一些进阶资料。

[外链图片转存中…(img-TqYfmXuM-1714736212491)]

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！