注意userId 中的id不能全大写,Udp、Xml、Tcp等等也不能全用大写
常量的命名方式比较特殊,字母全部大写,单词之间用下画线连接。力求语义表达完整清楚,不要嫌名字长,比如,把最大库存数量命名为MAX_STOCK_COUNT
枚举类名带上Enum后缀,枚举成员名称需要全大写,单词间用下画线隔开(好处是使用 IDEA可以 ShiftShift搜索很快,所有的枚举类都知道了)
望文知义是在不需要额外解释的情况下 仅从名称上就能够理解某个词旬的确切含义。命名做到望文知义、自解释是每个开发工程师的基本素质之一。不要为了缩减长度而取不完整的字符,IDEA有自动生成的功能。
杜绝完全不规范的缩写,避免望文不知义。反例:AbstractClass“缩写”命名成AbsClass;condition“缩写”命名成condi,此类随意缩写严重降低了代码的可阅读性
接口类中的方法和属性不要加任何修饰符号(public也不要加),保持代码的简洁性,并加上有效的Javadoc注释。
尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量
接口和实现类的命名:对于Service和DAO类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl的后缀与接口区别。正例:CacheServiceImpl实现CacheService接口。
Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀。
3) 获取统计值的方法用 count 做前缀。
4) 插入的方法用 save(推荐)或 insert 做前缀。
5) 删除的方法用 remove(推荐)或 delete 做前缀。
6) 修改的方法用 update 做前缀。