编程规约-命名风格

其它相关文章
Java 编码规范1(编程规约-命名风格)
Java 编码规范2(编程规约-常量定义)
Java 编码规范3(编程规约-代码格式)
Java 编码规范4(编程规约-OOP规约)
Java 编码规范5(编程规约-集合处理)
Java 编码规范6(编程规约-并发处理)
Java 编码规范7(编程规约-控制语句)
Java 编码规范8(编程规约-注释规约与其它)
Java 编码规范9(异常日志)
Java 编码规范10(单元测试)
Java 编码规范11(安全规约)
Java 编码规范12(MySQL-建表规约)
Java 编码规范13(MySQL-索引规约)
Java 编码规范14(MySQL-SQL语句与ORM映射)
Java 编码规范15(工程结构)

[强制] 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
- 反例: _name /__name / $name / name_ / name$ / name__
[强制] 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
- 建议: 使用正确的英语拼写和语法，尽量不要使用纯拼音命名。
- 正例: alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
- 反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
[强制] 类名使用UpperCamelCase风格，但以下情形例外：DO / BO / DTO / VO / AO / PO等。
- 正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
- 反例: macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
[强制] 方法名、参数名、成员变量、局部变量 统一使用lowerCamelCase风格，必须遵从驼峰形式。
- 正例: localValue / getHttpMessage() / inputUserId
[强制] 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
- 正例: MAX_STOCK_COUNT
- 反例: MAX_COUNT // 意义不完整
[强制] 抽象类 命名使用Abstract或Base开头；异常类 命名使用Exception结尾；测试类命名以它要测试的类名开始，以Test结尾。
[强制] 抽象类 类型与中括号紧挨相连来定义数组。
- 正例: int[] arrayDemo;
- 反例: String args[];
[强制] POJO类中布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。
- 反例: 定义为基本数据类型Boolean isDeleted;的属性，它的方法也是isDeleted()，RPC 框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。
[强制] 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
- 正例: 应用工具类包名为com.alibaba.ai.util、类名为MessageUtils（此规则参考spring的框架结构）
[强制] 杜绝完全不规范的缩写，避免望文不知义。
- 反例: AbstractClass“缩写”命名成AbsClass；condition “缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
[推荐] 为了达到代码自解释的目标，任何定义编程元素在命名时使用尽量完整单词组合来表达其意。
- 正例: 从远程仓库拉取代码的类命名为 PullCodeFromPullCodeFrom。
- 变量 int a; 的随意命名方式。
- 不怕长，就怕说不清楚、不知所云。
[推荐] 如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。
- 说明: 将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
- 正例:
```
public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
```
[推荐] 接口类中的方法和属性 不要加任何修饰符号（public也不要加），保持代码的简洁性，并加上有效的Javadoc注释。
- 尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
- 正例: 接口方法签名void f();，接口基础常量String COMPANY = "alibaba";
- 反例: 接口方法定义public abstract void f();
- 说明: JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
接口和实现类的命名有两套规则：
1. [强制] 对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
  - 正例: CacheServiceImpl实现CacheService接口。
2. [推荐] 如果是形容能力的接口名称，取对应的形容词为接口名(通常是–able的形式)
  - 正例: AbstractTranslator实现 Translatable。
[参考] 枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
- 说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
- 正例：枚举名字为ProcessStatusEnum的成员名称：SUCCESS / UNKNOWN_REASON。
[推荐] 各层命名规约：
- Service/DAO层方法命名规约:
  - 获取单个对象的方法用get作前缀。
  - 获取多个对象的方法用list作前缀。
  - 获取统计值的方法用count作前缀。
  - 插入的方法用save/insert作前缀。
  - 删除的方法用remove/delete作前缀。
  - 修改的方法用update作前缀。
- 领域模型命名规约
  - 数据对象：xxxDO，xxx即为数据表名。
  - 数据传输对象：xxxDTO，xxx为业务领域相关的名称。
  - 展示对象：xxxVO，xxx一般为网页名称。
  - POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

Java 编码规范1(编程规约-命名风格)相关推荐

Java开发代码规范之编程规约---命名风格
前言一个软件生命周期中,从可行性研究分析.计划到需求分析,再到软件设计.编码实现.测试,最后交付使用,运行维护过程中,维护过程占据了很大的比例,一个软件的生命周期中,很难保证自始至终都由最初的开发人 ...
java标识命名服务_阿里巴巴Java开发规约第一章编程规约-命名风格篇
1.[强制] 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name /__name / $name / name_ / name$ / name__ 老四附言: ...
Google 出品的 Java 编码规范和编程指南！
这份文档是Google Java编程风格规范的完整定义.当且仅当一个Java源文件符合此文档中的规则, 我们才认为它符合Google的Java编程风格. 与其它的编程风格指南一样,这里所讨论的不仅仅是 ...
Java 编码规范15(工程结构)
工程结构其它相关文章 Java 编码规范1(编程规约-命名风格) Java 编码规范2(编程规约-常量定义) Java 编码规范3(编程规约-代码格式) Java 编码规范4(编程规约-OOP规约) ...
公司让我编写一套自己的【Java 编码规范】作为员工季度考核标准？！参照Alibaba
目录一.编码规范 (一)命名风格 (二)常量定义 (三)代码格式 (四)OOP规范 (五)集合处理 (六)并发处理 (七)控制语句 (八)注释规范 (九)其它二.SVN操作规范三.异常日志 (一 ...
阿里巴巴对Java编程【命名风格】的规约
转载自阿里巴巴对Java编程[命名风格]的规约命名风格 1. [强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $Obje ...
Java基础学习总结（92）——Java编码规范之排版、注释及命名
为使开发人员养成良好的开发习惯,编写可读性强.易维护的程序,结合以往资料,现整理Java编码规范,将之作为开发人员的参照依据. 一.排版 1.相对独立的程序块之间必须加空行
《阿里巴巴JAVA编码规范》阅读理解
https://github.com/alibaba/p3c/ https://github.com/singgel?tab=repositories 前言 2017 年阿里云栖大会,阿里发布了针对 ...
java编码规范文档下载_软件项目实训及课程设计指导——制定待开发项目中各种文档的规范...
软件项目实训及课程设计指导--制定待开发项目中各种形式文档的规范 1.制定对课程设计项目开发过程中的规范性要求 (1)从"形式"到"内容"两个方面控制和要求开发 ...

Java 编码规范1(编程规约-命名风格)

编程规约-命名风格

Java 编码规范1(编程规约-命名风格)相关推荐

最新文章

热门文章