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

**

文章目录

• checkstyle: plugin

• checkstyle: gradle

• checkstyle: 155条规范

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

开发APP的过程中，每个团队都会约定自己的代码规范。但是往往在实践过程中，要么由于开发周期紧张，大家没有按照规范进行，而是按照自己的编程习惯来开发；要么是新入职的员工，或者从别的项目组借调过来的员工，不熟悉我们的开发规范。所以有必要用一些强制手段来规范我们设定的代码规范。

因此我们引入checkstyle来约束代码规范。

checkstyle有两种使用方式，一种是安装plugin插件，还有一种是通过gradle配置。

checkstyle: plugin

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

1. 安装插件

这个因此很简单，搜索插件，安装，然后选择一个checkstyle文件。

2. checkstyle文件

这里介绍一下常用的checkstyle文件。

官网：

https://github.com/checkstyle/checkstyle

各种checkstyle文件参考：

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’)

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

深知大多数Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

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

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

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

如果你觉得这些内容对你有帮助，可以添加V获取：vip204888 （备注Android）

Android高级架构师

由于篇幅问题，我呢也将自己当前所在技术领域的各项知识点、工具、框架等汇总成一份技术路线图，还有一些架构进阶视频、全套学习PDF文件、面试文档、源码笔记。

• 330页PDF Android学习核心笔记（内含上面8大板块）

• Android学习的系统对应视频

• Android进阶的系统对应学习资料

• Android BAT部分大厂面试题（有解析）

好了，以上便是今天的分享，希望为各位朋友后续的学习提供方便。觉得内容不错，也欢迎多多分享给身边的朋友哈。

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

，也欢迎多多分享给身边的朋友哈。

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
[外链图片转存中…(img-cK0d8vEc-1712692975219)]