开发APP的过程中,每个团队都会约定自己的代码规范。但是往往在实践过程中,要么由于开发周期紧张,大家没有按照规范进行,而是按照自己的编程习惯来开发;要么是新入职的员工,或者从别的项目组借调过来的员工,不熟悉我们的开发规范。所以有必要用一些强制手段来规范我们设定的代码规范。
因此我们引入checkstyle来约束代码规范。
checkstyle有两种使用方式,一种是安装plugin插件,还有一种是通过gradle配置。
============================================================================
- 安装插件
这个因此很简单,搜索插件,安装,然后选择一个checkstyle文件。
- 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
- 实战
打开一个java文件,右键点击:check current file,结果如下:
修改后:
- 自定义checkstyle
可以参考google的checkstyle文件,自行修改成为适合自己团队使用的代码规范文件。
============================================================================
我们配置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/’
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录大纲截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且后续会持续更新
如果你觉得这些内容对你有帮助,可以添加V获取:vip204888 (备注Android)
最后
在此为大家准备了四节优质的Android高级进阶视频:
架构师项目实战——全球首批Android开发者对Android架构的见解
附相关架构及资料
往期Android高级架构资料、源码、笔记、视频。高级UI、性能优化、架构师课程、NDK、混合式开发(ReactNative+Weex)微信小程序、Flutter全方面的Android进阶实践技术,群内还有技术大牛一起讨论交流解决问题。
一个人可以走的很快,但一群人才能走的更远。如果你从事以下工作或对以下感兴趣,欢迎戳这里加入程序员的圈子,让我们一起学习成长!
AI人工智能、Android移动开发、AIGC大模型、C C#、Go语言、Java、Linux运维、云计算、MySQL、PMP、网络安全、Python爬虫、UE5、UI设计、Unity3D、Web前端开发、产品经理、车载开发、大数据、鸿蒙、计算机网络、嵌入式物联网、软件测试、数据结构与算法、音视频开发、Flutter、IOS开发、PHP开发、.NET、安卓逆向、云计算
C#、Go语言、Java、Linux运维、云计算、MySQL、PMP、网络安全、Python爬虫、UE5、UI设计、Unity3D、Web前端开发、产品经理、车载开发、大数据、鸿蒙、计算机网络、嵌入式物联网、软件测试、数据结构与算法、音视频开发、Flutter、IOS开发、PHP开发、.NET、安卓逆向、云计算**