Java——命名风格
**1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。**
```text
反例:_name / __name / $Object / name_ / name$ / Object$
```
----
**2. 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。**
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式
也要避免采用。```text
正例:alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。**
反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
```
----
**3. 【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO / BO /
DTO / VO / AO**```text
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
```
----
**4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从
驼峰形式。**```text
正例: localValue / getHttpMessage() / inputUserId
```
----
**5. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。**
```text
正例:MAX_STOCK_COUNT
反例:MAX_COUNT
```
----**6. 【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类
命名以它要测试的类的名称开始,以 Test 结尾。**----**7. 【强制】中括号是数组类型的一部分,数组定义如下:String[] args;**
```text
反例:使用 String args[]的方式来定义。
```
----**8. 【强制】POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。**
```text
反例:定义为基本数据类型 Boolean isDeleted;的属性,它的方法也是 isDeleted(),RPC
框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异
常。
```
----
**9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数形式,但是类名如果有复数含义,类名可以使用复数形式。**
```text
正例: 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils(此规则参考
spring 的框架结构)
```
----
**10. 【强制】杜绝完全不规范的缩写,避免望文不知义。**
```text
反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随
意缩写严重降低了代码的可阅读性。
```
----
**11. 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词
组合来表达其意。**
```text
正例:从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。
反例:变量 int a; 的随意命名方式。
```
----
**12. 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。**
```text
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例:public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
```
----
**13. 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁
性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是
与接口方法相关,并且是整个应用的基础常量。**
```text
正例:接口方法签名:void f();接口基础常量表示:String COMPANY = "alibaba";
反例:接口方法定义:public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默
认实现。
```
----
**14. 接口和实现类的命名有两套规则:**
```text
1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部
的实现类用 Impl 的后缀与接口区别。
正例:CacheServiceImpl 实现 CacheService 接口。
2)【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。
正例:AbstractTranslator 实现 Translatable。
```
----
**15. 【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。**
```text
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKOWN_REASON。
```
----
**16. 【参考】各层命名规约:**
```text
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。
```
Java——命名风格相关推荐
- c语言语系的命名风格和java系命名风格
c语言系的命名风格:单词之间使用下划线分隔.如上图. java语言是另外一个系,javascript属于java语系(当年就是想借助java的名气所以命名javascript).java语系是驼峰式命 ...
- 阿里巴巴对Java编程【命名风格】的规约
转载自 阿里巴巴对Java编程[命名风格]的规约 命名风格 1. [强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $Obje ...
- Java命名规范和代码风格
Java命名规范和代码风格 基本命名规范 包命名 包名按照域名的范围从大到小逐步列出,恰好和Internet上的域名命名规则相反. 由一组以"."连接的标识符构成,通常第一个标识符 ...
- Java 编码规范1(编程规约-命名风格)
编程规约-命名风格 其它相关文章 Java 编码规范1(编程规约-命名风格) Java 编码规范2(编程规约-常量定义) Java 编码规范3(编程规约-代码格式) Java 编码规范4(编程规约-O ...
- 阿里Java编程规约(命名风格、常量定义、代码格式)
命名风格 1.[强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例:_name / __name / $name / name_ / name$ / name__ 2 ...
- 谷歌 Java 编程风格指南
点击上方蓝色"程序猿DD",选择"设为星标" 回复"资源"获取独家整理的学习资料! 来源 | http://hawstein.com/201 ...
- Google JAVA编程风格
目录 前言 源文件基础 源文件结构 格式 命名约定 编程实践 Javadoc 后记 前言 这份文档是Google Java编程风格规范的完整定义.当且仅当一个Java源文件符合此文档中的规则, 我们才 ...
- 深度解析Google Java 编程风格指南
这份文档是Google Java编程风格规范的完整定义.当且仅当一个Java源文件符合此文档中的规则, 我们才认为它符合Google的Java编程风格. 与其它的编程风格指南一样,这里所讨论的不仅仅是 ...
- Google Java编程风格指南中文版
作者:Hawstein 出处:http://hawstein.com/posts/google-java-style.html 声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|C ...
最新文章
- iOS 根据数组中的字典的value值进行排序
- python循环语句-python基础-循环语句(5)
- matlab gui七种参数传递方式和范围
- 仿写strncmp函数
- Cpp 对象模型探索 / 虚函数的调用方式
- java nio socket长连接_netty学习实战—实现websocket长连接和socket之间进程通信
- 如何以及何时使用例外
- linux命令中选项分为,Linux 考试试题
- 【Flink】FLink SQL 如何使用嵌套格式的Schema
- 社区发现算法——Louvain 算法
- 第三章 概念模型设计(一)
- 【IoT】产品设计:如何挖掘产品需求
- 利用cookie实现登陆知网与抽屉网 基于session自动登录抽屉网 cookie与session区别
- 计算机系统的位的描述性定义,计算机系统中,“位”的描述性定义是________。
- KMP(字符串匹配)+字符串哈希
- mean IOU是什么意思
- 【全栈软件测试】软件测试学习路线介绍
- Python中的self用法
- 软件项目开发流程及人员职责
- linux网卡驱动源码分析
热门文章
- 【电商宝scrm分享】3C类目商家如何玩转社群营销
- 非一般的原因:Unable instantiate application xxx.MyApplication: java.lang.ClassNotFoundException
- 在c#使用IOCP(完成端口)的简单示例
- IE10/11不支持条件性注释的3个解决方法
- oracle 改颜色,AE怎么调整、改变图像的一部分颜色?
- python z3库学习
- [game]暴雪游戏中的多样性日常系统
- 服务器主板BIOS位置,服务器主板bios设置
- vscode 配置C#步骤
- 炒股入门初学者基础知识讲解,如何掌握新手炒股入门基础知识