Java开发编程规范-命名风格

标准命名规范风格(Fu++聚合支付收款云平台

1、代码中命名不能以下划线、特殊字符或美元符号开始或结束。
反例:_pay / +pay / $pay / pay+ / pay% 等;

2、代码中命名严禁使用英文和拼音混合的方式,切记,更不能直接以中文的方式进行命名,纯拼音的命名方式也要避免才用,标准的命名和语法可以让后续阅读者或开发者易于理解,避免歧义。
正例:getPaymentChannel【支付通道】,notifyUrl【通知地址】,returnUrl【返回地址】。
反例:getFeilvRate【费率】,TongDaoWay【通道】。

3、类名使用UpperCameCase风格,但以下情形例外:DO / BO / VO / AO / PO / DTO / UID 等;
正例:MemberDO / FuJaJaService / TcpUdpDeal。
反例:memberDo / fujajaService / TCPUDPDeal。

4、方法名、参数名、成员变量、局部变量都统一使用lowerCaseCase风格,必须遵循驼峰形式;
正例:getRate / payUrl / sendMessage ;

5、常量命名全部大写,单词间用下划线隔开,力求语义表达完整清除,不要嫌名字太长;
正例:MAX_STOCK_COUNT
反例:MAX_COUNT

6、POJO类中布尔类型的变量,定义不要以is为前缀,否则部分框架解析会引起序列化错误;
反例:定义为进本数据类型 Boolean isDeleted 的属性,他的方法也是 isDeleted, RPC框架在反解析的时候,误以为对应的属性是deleted,导致属性获取不到,进而抛出异常;

7、包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词,包名统一使用单数形式,但是雷鸣如果有复数含义,类名可以使用复数形式;
正例:com.fujaja.api / com.fujaja.util

8、枚举类名建议带上Enum后缀,枚举成员名称需要大写,单词间用下划线隔开。枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制私有。
正例:SUCCESS / UNKNOWN_REASON

9、对于Service和Dao类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl的后缀与接口的区别。
正例:CacheServiceImpl 实现 CacheService 接口。

猜你喜欢

转载自blog.csdn.net/fujaja/article/details/81508755