网站开发外键,做 爱 网站小视频,源码商城系统,做网站项目主要技术命名风格
1、【强制】代码中的命名均不能以下划线或美元符号开始#xff0c;也不能以下划线或美元符号结束。
反例#xff1a;_name / __name / $name / name_ / name$ / name__
2、【强制】代码中的命名严禁使用拼音与英文混合的方式#xff0c;更不允许直接使用中文的方…命名风格
1、【强制】代码中的命名均不能以下划线或美元符号开始也不能以下划线或美元符号结束。
反例_name / __name / $name / name_ / name$ / name__
2、【强制】代码中的命名严禁使用拼音与英文混合的方式更不允许直接使用中文的方式。
说明正确的英文拼写和语法可以让阅读者易于理解避免歧义。注意纯拼音命名方式更要避免采用。
正例renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称可视同英文。
反例DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 3
3、【强制】类名使用 UpperCamelCase 风格但以下情形例外DO / BO / DTO / VO / AO
/ PO / UID 等。
正例JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例javaserverlessplatform / UserDo / XMLService / TCPUDPDeal / TAPromotion
4、【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格必须遵
从驼峰形式。
正例 localValue / getHttpMessage() / inputUserId
5、【强制】常量命名全部大写单词间用下划线隔开力求语义表达完整清楚不要嫌名字
长。
正例MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例MAX_COUNT / EXPIRED_TIME
6、【强制】抽象类命名使用 Abstract 或 Base 开头异常类命名使用 Exception 结尾测试类
命名以它要测试的类的名称开始以 Test 结尾。
7、【强制】类型与中括号紧挨相连来表示数组。
正例定义整形数组 int[] arrayDemo;
反例在 main 参数中使用 String args[]来定义。
8、【强制】POJO 类中布尔类型变量都不要加 is 前缀否则部分框架解析会引起序列化错误。
说明在本文 MySQL 规约中的建表约定第一条表达是与否的值采用 is_xxx的命名方式所以需要在
resultMap设置从 is_xxx 到 xxx 的映射关系。
反例定义为基本数据类型 Boolean isDeleted 的属性它的方法也是 isDeleted()RPC 框架在反向解
析的时候“误以为”对应的属性名称是 deleted导致属性获取不到进而抛出异常。
9、【强制】包名统一使用小写点分隔符之间有且仅有一个自然语义的英语单词。包名统一使
用单数形式但是类名如果有复数含义类名可以使用复数形式。
正例应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils此规则参考 spring 的框架结构
10、【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命
名使可读性降低。
说明子类、父类成员变量名相同即使是 public 类型的变量也是能够通过编译而局部变量在同一方法
内的不同代码块中同名也是合法的但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员
变量名称相同。
反例
public class ConfusingName {public int age;// 非 setter/getter 的参数名称不允许与本类成员变量同名 public void getData(String alibaba) {if(condition) {final int money 531;// ...}for (int i 0; i 10; i) {// 在同一方法体中不允许与其它代码块中的 money 命名相同final int money 615;// ...} }}class Son extends ConfusingName {// 不允许与父类的成员变量名称相同 public int age;}
11、【强制】杜绝完全不规范的缩写避免望文不知义。
反例AbstractClass“缩写”命名成 AbsClasscondition“缩写”命名成 condi此类随意缩写严重
降低了代码的可阅读性。
12、【推荐】为了达到代码自解释的目标任何自定义编程元素在命名时使用尽量完整的单词
组合来表达其意。
正例在 JDK 中表达原子更新的类名为AtomicReferenceFieldUpdater。
反例int a 的随意命名方式。
13、【推荐】在常量与变量的命名时表示类型的名词放在词尾以提升辨识度。
正例startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
14、【推荐】如果模块、接口、类、方法使用了设计模式在命名时需体现出具体模式。
说明将设计模式体现在名字中有利于阅读者快速理解架构设计理念。
正例 public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
15、【推荐】接口类中的方法和属性不要加任何修饰符号public 也不要加保持代码的简洁
性并加上有效的 Javadoc 注释。尽量不要在接口里定义变量如果一定要定义变量肯定
是与接口方法相关并且是整个应用的基础常量。
正例接口方法签名 void commit();
接口基础常量 String COMPANY alibaba;
反例接口方法定义 public abstract void f();
说明JDK8 中接口允许有默认实现那么这个 default 方法是对所有实现类都有价值的默认实现。
16、接口和实现类的命名有两套规则
1【强制】对于 Service 和 DAO 类基于 SOA 的理念暴露出来的服务一定是接口内部的实现类用
Impl 的后缀与接口区别。
正例CacheServiceImpl 实现 CacheService 接口。
2 【推荐】如果是形容能力的接口名称取对应的形容词为接口名通常是–able 的形容词。
正例AbstractTranslator 实现 Translatable 接口。
17、【参考】枚举类名带上 Enum 后缀枚举成员名称需要全大写单词间用下划线隔开。
说明枚举其实就是特殊的类域成员均为常量且构造方法被默认强制是私有。
正例枚举名字为 ProcessStatusEnum 的成员名称SUCCESS / UNKNOWN_REASON。
18、【参考】各层命名规约
A) Service/DAO 层方法命名规约
1 获取单个对象的方法用 get 做前缀。
2 获取多个对象的方法用 list 做前缀复数形式结尾如listObjects。
3 获取统计值的方法用 count 做前缀。
4 插入的方法用 save/insert 做前缀。
5 删除的方法用 remove/delete 做前缀。
6 修改的方法用 update 做前缀。
B) 领域模型命名规约
1 数据对象xxxDOxxx 即为数据表名。
2 数据传输对象xxxDTOxxx 为业务领域相关的名称。
3 展示对象xxxVOxxx 一般为网页名称。
4 POJO 是 DO/DTO/BO/VO 的统称禁止命名成 xxxPOJO。
常量定义
1、【强制】不允许任何魔法值即未经预先定义的常量直接出现在代码中。
反例String key Id#taobao_ tradeId;
cache.put(key, value);
// 缓存 get 时由于在代码复制时漏掉下划线导致缓存击穿而出现问题
2、【强制】在 long 或者 Long 赋值时数值后使用大写的 L不能是小写的 l小写容易跟数
字 1 混淆造成误解。
说明Long a 2l; 写的是数字的 21还是 Long 型的 2。
3、【推荐】不要使用一个常量类维护所有常量要按常量功能进行归类分开维护。
说明大而全的常量类杂乱无章使用查找功能才能定位到修改的常量不利于理解和维护。
正例缓存相关常量放在类 CacheConsts 下系统配置相关常量放在类 ConfigConsts 下。
4、【推荐】常量的复用层次有五层跨应用共享常量、应用内共享常量、子工程内共享常量、
包内共享常量、类内共享常量。
1 跨应用共享常量放置在二方库中通常是 client.jar 中的 constant 目录下。
2 应用内共享常量放置在一方库中通常是子模块中的 constant 目录下。
反例易懂变量也要统一定义成应用内共享常量两位工程师在两个类中分别定义了“YES”的变量
类 A 中public static final String YES yes;
类 B 中public static final String YES y;
A.YES.equals(B.YES)预期是 true但实际返回为 false导致线上问题。
3 子工程内部共享常量即在当前子工程的 constant 目录下。
4 包内共享常量即在当前包下单独的 constant 目录下。
5 类内共享常量直接在类内部 private static final 定义。
5【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。
说明如果存在名称之外的延伸属性应使用 enum 类型下面正例中的数字就是延伸信息表示一年中的
第几个季节。
正例
public enum SeasonEnum {SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);private int seq; SeasonEnum(int seq) {this.seq seq;}public int getSeq() {return seq;}} 代码格式
1、【强制】如果是大括号内为空则简洁地写成{}即可大括号中间无需换行和空格如果是非
空代码块则
1 左大括号前不换行。
2 左大括号后换行。
3 右大括号前换行。
4 右大括号后还有 else 等代码则不换行表示终止的右大括号后必须换行。
2、左小括号和字符之间不出现空格同样右小括号和字符之间也不出现空格而左
大括号前需要空格。详见第 5 条下方正例提示。
反例if (空格 a b 空格)
3、【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
4、【强制】任何二目、三目运算符的左右两边都需要加一个空格。
说明运算符包括赋值运算符、逻辑运算符、加减乘除符号等。
5、【强制】采用 4 个空格缩进禁止使用 tab 字符。
说明如果使用 tab 缩进必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时请勿勾选 Use
tab character而在 eclipse 中必须勾选 insert spaces for tabs。
正例 涉及 1-5 点
public static void main(String[] args) {
// 缩进 4 个空格 String say hello;
// 运算符的左右必须有一个空格 int flag 0;
// 关键词 if 与括号之间必须有一个空格括号内的 f 与左括号0 与右括号不需要空格 if (flag 0) {
System.out.println(say); }
// 左大括号前加空格且不换行左大括号后换行 if (flag 1) { System.out.println(world);
// 右大括号前换行右大括号后有 else不用换行
} else {
System.out.println(ok);
// 在右大括号后直接结束则必须换行 }
}
6、【强制】注释的双斜线与注释内容之间有且仅有一个空格。
正例
// 这是示例注释请注意在双斜线之后有一个空格 String param new String();
