Java这门编程语言已经盛行了20年之久了,越来越多的开发者开始青睐这门语言,他们用着一行行代码书写着Java传奇。随着时代以及业务的变化,Java开发者们在日常的开发工作中逐渐的形成了一种开发习惯,但是不同的开发者开发习惯肯定会有所不同。那么,有没有一套合理的Java开发规范来帮助我们更好的进行开发呢?答案肯定是有的,国内的阿里巴巴就此同全球Java社区开发者开发出来了一套Java开发规范。
目前我所使用的也是最新版的阿里巴巴Java开发手册,并且最新版本阿里巴巴Java开发手册(嵩山版)已面向全球Java开发者开放下载,具体下载地址见文末。
阿里巴巴Java开发手册上面规定了很多常见的Java开发规范,在这里呢,我也就不一一说明了,我只对前几个进行一个简单的介绍即可,毕竟这个手册上的内容基本上都可以看懂,还有正反例可供参考。
这个是阿里巴巴Java开发手册发布的最新版本,里面首次提出了前后端的开发规范,适合Java开发者们反复品尝。
本手册以 Java 开发者为中心视角,划分为编程规约
、异常日志
、单元测试
、安全规约
、MySQL 数据库
、工程结构
、设计规约
七个维度,再根据内容特征,细分成若干二级子目录。另外,依据约束力强弱及故障敏感性,规约依次分为【强制】、【推荐】、【参考】三大类。在延伸信息中,“说明”对规约做了适当扩展和解释;“正例”提倡什么样的编码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案例。
下面我就来简单介绍几条日常开发中的Java编码规范,这个还是很有必要学习一下的,毕竟连规范都不怎么遵循的程序员是很容易遭到同事的鄙视的,哈哈哈。
第二条中严禁使用拼音与英文的方式,这个还是得强制一下的吧,毕竟有句老话说的好,编码五分钟,命名半小时,哈哈哈,这是个梗,说的就是程序员对变量进行命名时尽量要做到大众化,见名知意,要不以后别人来阅读你的代码时,连命名都看不太明白,岂不是很尴尬的一件事情。
第四条就是常见的类名首字母大写,这基本上已经形成了一种规范了,至少我所见到的代码基本上都是类名首字母大写的,不过也有几个例外类名纯小写的,这不能说是错误的,只能说是习惯而已,不过大部分Java开发类名还是使用类名首字母大写。
第九条在我还没有看过阿里巴巴的这个Java开发规范的时候我也是曾经犯过这样的问题的,就比如我当时好像是在一个POJO中定义了一个 isOpen 这个属性用来规定状态是否开启,后来看过这个开发手册感觉这上面说的还是很有道理的,毕竟有的框架确实底层是这个例子上的这种,虽然说我定义的那个也不太影响,但是为了以后的开发习惯,我还是遵守了这个开发规范。
代码格式第五条中规定采用4个空格缩进,而我在 IDEA 中因为设置的有4个空格的缩进,所以这个就很正常的了,除了4个缩进之外,在开发 Vue 前端的时候它们确实建议的使用2个缩进,所以说,如果就是在 WebStorm 中,可能一个 Tab 键就是两个空格的缩进了。Java 开发中,除非你设置好了一个 Tab 键缩进4个空格,要不就是直接四下空格就搞定了。
本次版本也是首次加入了前后端的一些规约,就像第一条中规定了前后端交互的API中需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体等信息,这些在前后端交互的时候都是利于开发人员更快速高效开发的一些规范。
这次新增的规范中关于翻页场景的情况做了一些说明,如果用户输入的页码参数小于第一页,则前端把第一页返回给后端请求分页数据;如果后端发现前端用户传过来的页码参数大于总页数,则会返回最后一页的分页数据给前端处理。
这个开发手册还有很多相关的规定,我就不一一介绍了,总之,还是建议大家好好把这个阿里巴巴的Java开发手册阅读一下,提高一下自己的代码规范,既提高自己,又轻松他人。
下方阅读全文可直达阿里云官网下载地址,不过就是需要有阿里云账号。或者关注公众号,后台回复开发【开发手册】获取直链下载。
- END -