没有合适的资源?快使用搜索试试~ 我知道了~
首页Java开发规范(通用)
资源详情
资源推荐
VC 电影开发规范手册
一、编程规范
(一)、命名规约
1、【强制】所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
反例: _name / __name / $Object / name_ / name$ / Object$
2、【强制】所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。
注意,即使纯拼音命名方式 也要避免采用。
反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3;
正例: 国际通用的中文拼音名称,可视为英文,如 beijing,shanghai。
3、【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,
但以下情形例外:(领域模型 的相关命名)DO / DTO / VO / DAO 等。
正例: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 isSuccess;的属性,它的方法也是 isSuccess(),RPC 框架在反向解析的
时候,“以为”对应的属性名称是 success,导致属性获取不到,进而抛出异常。
9、【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形
式,但是类名如果有复数含义,类名可以使用复数形式。
正例: 应用工具类包名为 cn.vcfilm.user.util、类名为 MessageUtils(此规则参考 spring 的框架结构)
10、【强制】杜绝完全不规范的缩写,避免望文不知义。
反例:<某业务代码>AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩
写严重降低了代码的可阅读性。
11、【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。 说明: 将设计模式体现在名字
中,有利于阅读者快速理解架构设计思想。
正例:public class OrderFactory; public class LoginProxy;
12、【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上
有效的 javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并
且是整个应用的基础常量。
正例:接口方法签名:void f(); 接口基础常量表示: String COMPANY = "vcfilm";
反例:接口方法定义: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) 获取多个对象的方法用 getList 做前缀。
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。
(二)、常量定义
1、【强制】不允许出现任何魔法值(即未经定义的常量)直接出现在代码中。
反例: String key="Id#vcfilm_"+tradeId;
cache.put(key, value);
2、【强制】long 或者 Long 初始赋值时,必须使用大写的 L,不能是小写的 l,小写容易跟数字 1 混
淆,造成误解。
说明:Long a = 2l; 写的是数字的 21,还是 Long 型的 2?
3、【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。
如:缓存相关的常量放在类:CacheConsts 下;系统配置相关的常量放在类:ConfigConsts 下。
说明:大而全的常量类,非得 ctrl+f 才定位到修改的常量,不利于理解,也不利于维护。
4、【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常
量、类内共享常量。
1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 const 目录下。 2) 应用内共享常量:放置在
一方库的 modules 中的 const 目录下。
反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分别定义了表示 “是”的变量:
类 A 中:public static final String YES = "yes";
类 B 中:public static final String YES = "y";
A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致产生线上问题。
3) 子工程内部共享常量:即在当前子工程的 const 目录下。
4) 包内共享常量:即在当前包下单独的 const 目录下。
5) 类内共享常量:直接在类内部 private static final 定义。
5、【推荐】如果变量值仅在一个范围内变化用 Enum 类。如果还带有名称之外的延伸属性,必须使用
Enum 类,下面正例中的数字就是延伸信息,表示星期几。
正例:public Enum{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5),
SATURDAY(6), SUNDAY(7);}
(三)、格式制约
1、【强制】单行字符数限制不超过 130 个,其他代码格式可使用 eclipse 默认的格式化功能;
2、【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不
要使用 windows 格式。
(四)、OOP 规约
1、【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直
接用类名来访问即可。
2、【强制】所有的覆写方法,必须加@Override 注解。
反例:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判断是
否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。
3、【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object。
说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)
正例: public User getUsers(String type, Integer... ids);
4、【强制】对外暴露的接口签名,原则上不允许修改方法签名,做到兼容性,避免对接口调用方产生影
响。
接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。
5、【强制】不能使用过时的类或方法。
说明:java.net.URLDecoder 中的方法 decode(String encodeStr)这个方法已经过时,应该使用双参数
decode(String source, String encode)。接口提供方既然明确是过时接口,那么有义务同时提供新的接口;作
为调用方来说,也有义务去考证过时方法的新实现是什么。
6、【强制】Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals
正例: "test".equals(object);
反例: object.equals("test");
说明:推荐使用 java.util.Objects#equals (JDK7 引入的工具类)
7、【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。 说明: 对于
Integer var=?在-128 至 127 之间的赋值,Integer 对象是在 IntegerCache.cache 产生 ,会复用已有对
象,这个区间内的 Integer 值可以直接使用==进行判断,但是这个区间之外 的所有数据,都会在堆上产
生,并不会复用已有对象,这是一个大坑,推荐使用 equals 方法进行判断。
8、【强制】关于基本数据类型与包装数据类型的使用标准如下:
1) 所有的 POJO 类属性必须使用包装数据类型。
2) RPC 方法的返回值和参数必须使用包装数据类型。
3) 所有的局部变量推荐使用基本数据类型。
说明:POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE 问题,或
者入库检查,都由使用者来保证。
正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例:某业务的交易报表上显示成交总额涨跌情况,即正负 x%,x 为基本数据类型,调用的 RPC 服务,
调用不成功时,返回的是默认值,页面显示:0%,这是不合理的,应该显示成中划线-。所以包装数据类型
的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。
9、【强制】定义 DO/DTO/VO 等 POJO 类时,不要设定任何属性默认值。
反例:某业务的 DO 的 gmtCreate 默认值为 new Date();但是这个属性在数据提取时并没有置 入具体值,
在更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。
10、【强制】序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果完全不兼
容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。
说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。
11、【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。
12、【强制】POJO 类必须写 toString 方法。使用工具类 source> generate toString 时,如果继 承了另
一个 POJO 类,注意在前面加一下 super.toString。
说明:在方法执行抛出异常时,可以直接调用 POJO 的 toString()方法打印其属性值,便于排查问题。
13、【推荐】使用索引访问用 String 的 split 方法得到的数组时,需做最后一个分隔符后有无内
容的检查,否则会有抛 IndexOutOfBoundsException 的风险。
说明:
String str = "a,b,c,,"; String[] ary = str.split(",");
//预期大于 3,结果是 3
System.out.println(ary.length);
14、【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便
于阅读。
15、【推荐】循环体内,字符串的联接方式,使用 StringBuilder 的 append 方法进行扩展。
反例:
String str = "start"; for(int i=0; i<100; i++){
剩余22页未读,继续阅读
那年的纯真年代
- 粉丝: 0
- 资源: 5
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- zigbee-cluster-library-specification
- JSBSim Reference Manual
- c++校园超市商品信息管理系统课程设计说明书(含源代码) (2).pdf
- 建筑供配电系统相关课件.pptx
- 企业管理规章制度及管理模式.doc
- vb打开摄像头.doc
- 云计算-可信计算中认证协议改进方案.pdf
- [详细完整版]单片机编程4.ppt
- c语言常用算法.pdf
- c++经典程序代码大全.pdf
- 单片机数字时钟资料.doc
- 11项目管理前沿1.0.pptx
- 基于ssm的“魅力”繁峙宣传网站的设计与实现论文.doc
- 智慧交通综合解决方案.pptx
- 建筑防潮设计-PowerPointPresentati.pptx
- SPC统计过程控制程序.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功