Java开发

Java开发 一、编程规约 （一）命名风格 1.（强制）代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例： _name / name / / name 2.（强制）代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用 正例：alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文 反例：DaZhePromotion [ 打折 ] / getPingfenByName() [ 评分 ] / int 某变量 = 3 3.（强制）类名使用UpperCamelCase风格，但以下情形例外： DO / BO / DTO / VO / AO / PO / UID 等 正例：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.（强制）类型与中括号紧挨相连来表示数组 正例：定义整形数组int[] arrayDemo; 反例：在main参数中，使用String args[]来定义 8.（强制）POJO类中布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型Boolean isDeleted的属性，它的方法也是isDeleted()，RPC框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常 9.（强制）包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词，包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式 正例：应用工具类包名为 com . alibaba . ai . util 、类名为 MessageUtils（ 此规则参考 spring的框架结构 ） 10.（强制）杜绝完全不规范的缩写，避免望文不知义。 反例：AbstractClass缩写命名成AbsClass；condition缩写命名成condi，此类随意缩写严重降低了代码的可阅读性 11.（推荐）为了达到代码自解释的目的，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意 正例：在JDK中，代表原子更新的类名为：AtomicReferenceFieldUpdater 反例：变量int a的随意命名方式 12.（推荐）如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念 正例：public class OrderFactory; public class LoginProxy; 13.（推荐）接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要再接口里定义变量，如何一定要定义变量，肯定是与接口方法有关，并且是整个应用的基础变量。 正例：接口方法签名void commit(); 接口基础变量String COMPANY = “baidu”; 反例：接口方法定义public abstract void f(); 说明：JDB8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现 14.接口和实现类的命名有两套规则： 1）（强制）对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口,内部的实现类用Ｉｍｐｌ的后缀和接口区别 正例：CacheServiceImpl实现CacheService接口 2）（推荐）如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able的形式） 正例：AbstractTranslator实现Translatable接口 15.（参考）枚举类名建议带上Enum后缀 二、异常日志 三、单元测试 四、安全规约 五、MySQL数据库 六、工程结构 七、设计规约