“二哥,Java 中的命名约定都有哪些呢?”三妹的脸上泛着甜甜的笑容,她开始对接下来要学习的内容充满期待了,这正是我感到欣慰的地方。
“对于我们中国人来说,名字也是有讲究的,比如说我叫沉默王二,你就叫沉默王三,哈哈。”我笑着对三妹说。
命名约定决定我们使用什么样的标识符来命名包、类、字段、方法等等,虽然这个规则不是强制的,可以遵守,也可以不遵守,但如果不遵守的话,就会带来很多不必要的麻烦。
起个好的名字,就好像穿一件得体的衣服,呈现给人的用户体验是完全不一样的。
好的命名可以让你的代码更易读,包括你自己和你的小伙伴,看一眼,不用想太多,就能明白代码是干嘛的。
拿我这个笔名“沉默王二”来举例吧,读起来我就觉得朗朗上口,读者看到这个笔名就知道我是一个什么样的人——对不熟的人保持沉默,对熟的人妙语连珠,哈哈。
包的命名应该遵守以下规则:
应该全部是小写字母
点分隔符之间有且仅有一个自然语义的英语单词
包名统一使用单数形式,比如说 com.itwanger.util
不能是 com.itwanger.utils
在最新的 Java 编程规范中,要求开发人员在自己定义的包名前加上唯一的前缀。由于互联网上的域名是不会重复的,所以多数开发人员采用自己公司(或者个人博客)在互联网上的域名称作为包的唯一前缀。比如我文章中出现的代码示例的包名就是 package com.itwanger
。
类的命名应该遵守以下规则:
必须以大写字母开头
最好是一个名词,比如说 System
类名使用 UpperCamelCase(驼峰式命名)风格
尽量不要省略成单词的首字母,但以下情形例外:DO/BO/DTO/VO/AO/ PO / UID 等
另外,如果是抽象类的话,使用 Abstract 或 Base 开头;如果是异常类的话,使用 Exception 结尾;如果是测试类的话,使用 Test 结尾。
接口的命名应该遵守以下规则:
必须以大写字母开头
最好是一个形容词,比如说 Runnable
尽量不要省略成单词的首字母
来看个例子:
interface Printable {}
接口和实现类之间也有一些规则:
实现类用 Impl 的后缀与接口区别,比如说 CacheServiceImpl 实现 CacheService 接口
或者,AbstractTranslator 实现 Translatable 接口
字段和变量的命名应该遵守以下规则:
必须以小写字母开头
可以包含多个单词,第一个单词的首字母小写,其他的单词首字母大写,比如说 firstName
最好不要使用单个字符,比如说 int a
,除非是局部变量
类型与中括号紧挨相连来表示数组,比如说 int[] arrayDemo
,main 方法中字符串数组参数不应该写成 String args[]
POJO 类中的任何布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误,我自己知道的有 fastjson
避免在子类和父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可理解性降低。子类、父类成员变量名相同,即使是 public 类型的变量也能够通过编译,另外,局部变量在同一方法内的不同代码块中同名也是合法的,这些情况都要避免。
反例:
public class ConfusingName {
public int stock;
// 非 setter/getter 的参数名称,不允许与本类成员变量同名
public void get(String alibaba) {
if (condition) {
final int money = 666;
// ...
}
for (int i = 0; i < 10; i++) {
// 在同一方法体中,不允许与其它代码块中的 money 命名相同 final int money = 15978;
// ...
}
}
}
class Son extends ConfusingName {
// 不允许与父类的成员变量名称相同 public int stock;
}
常量的命名应该遵守以下规则:
应该全部是大写字母
可以包含多个单词,单词之间使用“_”连接,比如说 MAX_PRIORITY
,力求语义表达完整清楚,不要嫌名字长
可以包含数字,但不能以数字开头
来看个例子:
static final int MIN_AGE = 18;
方法的命名应该遵守以下规则:
必须以小写字母开头
最好是一个动词,比如说 print()
可以包含多个单词,第一个单词的首字母小写,其他的单词首字母大写,比如说 actionPerformed()
来看个例子:
void writeBook(){}
Service/DAO 层的方法命名规约:
获取单个对象的方法用 get 做前缀
获取多个对象的方法用 list 做前缀,复数结尾,如:listObjects
获取统计值的方法用 count 做前缀
插入的方法用 save/insert 做前缀
删除的方法用 remove/delete 做前缀
修改的方法用 update 做前缀
除了以上这些规则以外,还有一些共同的规则需要遵守,比如说:
_name / __name / $name / name_ / name$ / name__
DaZhePromotion [打折] / getPingfenByName() [评分] / String fw[福娃] / int 某变量 = 3
RIBENGUIZI / Asan / blackList / whiteList / slave
startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
public class OrderFactory;public class LoginProxy;public class ResourceObserver;
枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_REASON
。《Java 程序员进阶之路》预计一个月左右会有一次内容更新和完善,大家在我的公众号 沉默王二 后台回复“03” 即可获取最新版!如果觉得内容不错的话,欢迎转发分享!
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。