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

Google：https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml

顺便说一下Google的java代码规范，可以默认用这个：

https://google.github.io/styleguide/javaguide.html

中文版本：http://www.hawstein.com/posts/google-java-style.html

需要说明的是google的checkstyle的tab缩进是两个空格，可以按需改成4个空格来使用。

Sun：https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/sun_checks.xml

HuaWei：https://gist.github.com/ownwell/c32878440216f1866842

3. 实战

打开一个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条规范

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

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
提升的资深开发者，这些资料都将为你打开新的学习之门**

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！