1.【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
反例: _name / __name / $Object / name_ / name$ / Object$

2.【强制】 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式
也要避免采用。

正例: alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。

反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

3.【强制】类名使用 UpperCamelCase风格,必须遵从驼峰形式,但以下情形例外:(领域模型
的相关命名)DO / BO / DTO / VO等。
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase风格,必须遵从
驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

5.【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例: MAX_STOCK_COUNT
反例: MAX_COUNT

6.【强制】抽象类命名使用 Abstract或 Base开头;异常类命名使用 Exception结尾;测试类
命名以它要测试的类的名称开始,以 Test结尾。

7.【强制】中括号是数组类型的一部分,数组定义如下:String[] args;
反例:使用 String args[]的方式来定义。

8.【强制】POJO类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。
反例:定义为基本数据类型 Boolean isDeleted;的属性,它的方法也是 isDeleted(),RPC
框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异
常。

9.【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例: 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils(此规则参考
spring的框架结构)

10.【强制】杜绝完全不规范的缩写,避免望文不知义。
反例: AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类
随意缩写严重降低了代码的可阅读性。

11.【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。
正例:public class OrderFactory;
   public class LoginProxy;
   public class ResourceObserver;

12.【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁
性,并加上有效的 Javadoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是
与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名:void f();
     接口基础常量表示:String COMPANY = "alibaba";
反例:接口方法定义:public abstract void f();
说明:JDK8中接口允许有默认实现,那么这个 default方法,是对所有实现类都有价值的默
认实现。

13.接口和实现类的命名有两套规则:
1)【强制】对于 Service和 DAO类,基于 SOA的理念,暴露出来的服务一定是接口,内部
的实现类用 Impl的后缀与接口区别。

正例:CacheServiceImpl实现 CacheService接口。

2)【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able的形式)。
正例:AbstractTranslator实现 Translatable。

14.【参考】枚举类名建议带上 Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字:DealStatusEnum,成员名称:SUCCESS / UNKOWN_REASON。

15.【参考】各层命名规约:
A) Service/DAO层方法命名规约
1) 获取单个对象的方法用 get做前缀。
2) 获取多个对象的方法用 list做前缀。
3) 获取统计值的方法用 count做前缀。
4) 插入的方法用 save(推荐)或 insert做前缀。
5) 删除的方法用 remove(推荐)或 delete做前缀。
6) 修改的方法用 update做前缀。

B) 领域模型命名规约
1) 数据对象:xxxDO,xxx即为数据表名。
2) 数据传输对象:xxxDTO,xxx为业务领域相关的名称。
3) 展示对象:xxxVO,xxx一般为网页名称。
4) POJO是 DO/DTO/BO/VO的统称,禁止命名成 xxxPOJO。

转载于:https://www.cnblogs.com/yusute/p/7002698.html

JAVA编程规范-命名规范相关推荐

  1. java类的命名规范_浅谈Java中的命名规范

    现代软件架构的复杂性需要协同开发完成,如何高效地协同呢? 答案是:制定一整套统一的规范. 无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没 ...

  2. java实体类命名规范_java实现周易起名-java实体类起名规范

    Java中类的命名规范? java命名规范? Camel-Case(Camel-Case)是编写计算机程序时的一组命名规则(惯例). 程序员能够更轻松地与同行交流自己的代码,因此最好采用具有更好可读性 ...

  3. 阿里巴巴对Java编程【命名风格】的规约

    转载自 阿里巴巴对Java编程[命名风格]的规约 命名风格 1. [强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $Obje ...

  4. java语言中的标识符_Java语言基本语法(一)————关键字标识符(Java语言标识符命名规范Java语言的包名、类名、接口名、变量名、函数名、常量名命名规则 )...

    一.关键字 关键字的定义和特点 定义:被Java语言赋予特殊含义,用做专门用途的字符串(单词). 特点:关键字中所有字母均为小写 下面列举一些常用的关键字. 用于定义数据类型的关键字:byte.sho ...

  5. Java 项目的命名规范

    做开发的都知道,一个好的项目规范可以提高开发效率以及后期的维护.自己手上有个项目,里面规范很乱,自己在对它进行二次开发的时候很蛋疼,它没有相应的文档,公司给我的就只有一个项目源码,其中的关系还要自己去 ...

  6. java中定义变量名时大写_,【Java】变量命名规范

    Java是一种区分字母的大小写的语言,所以我们在定义变量名的时候应该注意区分大小写的使用和一些规范,接下来我们简单的来讲讲Java语言中包.类.变量等的命名规范. (一)Package(包)的命名 P ...

  7. java包名命名规范

    做开发的都知道,一个好的项目规范可以提高开发效率以及后期的维护.自己手上有个项目,里面规范很乱,自己在对它进行二次开发的时候很蛋疼,它没有相应的文档,公司给我的就只有一个项目源码,其中的关系还要自己去 ...

  8. JAVA基础(三)——服务器操作系统、Java开发环境、Java技术架构、定义Java类及其命名规范、Java注释方式

    1. 服务器操作系统 当前主流的服务器操作系统则主要分为:Windowsserver.UNIX.Linux.NetWare这四大阵容. (1)Windowsserver作为推广的最好,用户群体最大的服 ...

  9. java的变量命名规则_【Java】变量命名规范

    Java是一种区分字母的大小写的语言,所以我们在定义变量名的时候应该注意区分大小写的使用和一些规范,接下来我们简单的来讲讲Java语言中包.类.变量等的命名规范. (一)Package(包)的命名 P ...

  10. Java变量的命名规范

    变量的命名规范: 1.所有变量,方法,类名:见名知意: 2.类成员变量(除了常量以外的所有变量):首字母小写和驼峰原则:eg:lastName 3.局部变量:首字母小写和驼峰原则 4.常量:大写字母和 ...

最新文章

  1. R-FCN+ResNet-50用自己的数据集训练模型(python版本)
  2. 万字好文 | 数字化转型之道——数据治理体系能力提升
  3. DNF包管理命令在CentOS 8和RHEL 8上的使用
  4. static关键字-1
  5. mysql begin rollback_事务控制语句,begin,rollback,savepoint,隐式提交的SQL语句
  6. Embarcadero官方出品Delphi入门教程学习视频:2小时轻松掌握Delphi快速开发跨平台应用程序APP软件菜鸟教程
  7. 浏览器模式电子海图快速显示的研究
  8. Word里仅修改字母和数字的字体,不改变标点符号字体
  9. 为什么要研发vin码识别?
  10. win10python安装配置selenium
  11. RTP(实时传输协议)
  12. 浅谈OSI七层模型及ICP/IP四层模型
  13. “威胁”员工全来上班后,马斯克“尴尬”了:车没地停、工位不够坐、Wi-Fi 还太差
  14. 大数据交易研究_学术著作 | 基于电商平台大数据的特征价格指数研究——统计研究...
  15. SQL语句中having与where的区别
  16. 9V转3.3V的DC-DC降压芯片
  17. QT error: No rule to make target ‘xxx.cpp‘, needed by ‘debug/xxx.o‘. Stop.解决方案
  18. HashMap扩容为什么为2的次方幂
  19. 关于亚信安全防毒墙网络版客户端的退出与卸载(2020年亲测有效,经验分享)
  20. 拼多多怎么通过流量提高排名|成都盛天海

热门文章

  1. zabbix登陆拒绝报没有权限
  2. 《编写有效用例》阅读笔记05
  3. 微信无法连接到服务器怎么诊断网络【微信高级教程3】
  4. windows下的wxWidgets环境配置
  5. shell中的特殊符号
  6. No WebApplicationContext found: no ContextLoaderListener registered?
  7. vue keep-alive
  8. 多线程同步工具——volatile变量
  9. 请不要重复犯我在学习Python和Linux系统上的错误
  10. 网站性能测试工具--MS Web Application Stress Tool