阿里巴巴早在2017年就推出了《Java开发手册》,旨在规范Java开发人员在开发过程中的编码,这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。
为了让开发者更加方便、快速的将规范推动并实行起来,阿里巴巴基于手册内容,研发了一套自动化的IDE检测插件, 该插件在扫描代码后,将不符合手册规范的代码显示在界面中。我们可以在IDEA中选择 Preferences - Plugins - Browse repositories ,输入框中输入"alibaba",选择"Alibaba Java Coding Guidelines"进行安装,重启IDEA后即可使用。
Google也在2016年推出了《Java编程规范》,它是Google公司对Java编程风格规范的完整定义,主要内容包含编码格式是否美观的问题, 同时也讨论一些约定及编码标准。国内已经有人将其翻译为中文,具体请参考 Google《Java编程规范》中文版 ,另外如果需要PDF文档可以在 这里 去下载 。另外在Eclipse IDE和 IntelliJ IDE可以导入代码风格配置文件,可以方便使用该编码规范,请点击 传送门,具体方法是依次点击 Window -> Preferences -> Java -> Code Style -> Formatter -> Import,导入下载文件后即可使用。
本系列文章将结合两个《Java规范》进行总结,通过具体编码案例给出编码规范的原因,如果总结内容存在问题还望指出。
目录
本篇文章总结的内容是Java开发规范的命名规范,主要涉及Java的类、方法、变量和包名等命名规范,对应阿里巴巴的Java开发手册的第一章第一节命名风格和谷歌Java开发手册第五章命名,该规范只是作为建议,具体实施过程可以根据场景变动。
1. 类名开始和结尾
【阿里巴巴】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
【Google】标识符只能使用ASCII字母和数字,因此每个有效的标识符名称都能匹配正则表达式 \w+ 。
说明:虽然Java命名没有强制定义命名的字符,但是如果命名规范对后期代码阅读和维护有很大帮助。
反例:
【阿里巴巴】_name / __name /