开发命名风格规范

本文详细阐述了Java编程中的命名规范,包括类名、方法名、变量名、常量名等的约定,强调了使用完整单词组合和遵循特定风格的重要性。此外,还介绍了包名、接口、枚举、Service和DAO层的命名规则,以及领域模型的命名约定,旨在提高代码可读性和维护性。
摘要由CSDN通过智能技术生成

1.代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
2.所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
3.类名使用 UpperCamelCase 风格
4.方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。
5.常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
6.抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类
命名以它要测试的类的名称开始,以 Test 结尾。
7.类型与中括号紧挨相连来表示数组
8.POJO 类中的任何布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列
化错误。
9.包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数形式,但是类名如果有复数含义,类名可以使用复数形式。
10.避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,
使可读性降低。
11.杜绝完全不规范的缩写,避免望文不知义。
12.为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组
合来表达,一看就明白这个变量的意思。
13.在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度
14.如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式,在后面加上使用的设计模式。
15.接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁
性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,确定
与接口方法相关,并且是整个应用的基础常量。
接口方法签名 void commit();
接口基础常量 String COMPANY = “alibaba”;
JDK8中有默认实现,直接写就行。
16.对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用
Impl 的后缀与接口区别。
正例:CacheServiceImpl 实现 CacheService 接口。
17.如果是形容能力的接口名称,取对应的形容词为接口名
正例:AbstractTranslator 实现 Translatable 接口。
18.枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_REASON。
19.Service/DAO 层方法命名规约
获取单个对象的方法用 get 做前缀。
获取多个对象的方法用 list 做前缀,封装到一个集合或者数组里面,复数结尾,如:listObjects。
获取统计值的方法用 count 做前缀。
插入的方法用 insert 做前缀。
删除的方法用 delete 做前缀。
修改的方法用 update 做前缀。
20.领域模型命名规约
数据对象:xxxDO,xxx 即为数据表名。
数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
展示对象:xxxVO,xxx 一般为网页名称。
POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

诸葛博仌

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值