电信客户分析项目编码规范.docx

《电信客户分析项目编码规范.docx》由会员分享，可在线阅读，更多相关《电信客户分析项目编码规范.docx（29页珍藏版）》请在优知文库上搜索。

1、电信客户分析项目码规范XX科技股份有限公司编制目录一、编程规约3（一）命名风格3（二）常量定义7（三）代码格式8（四）OoP规约12（五）集合处理18（六）并发处理23（七）控制语句28（八）注释规约32（九）其它34二、异常日志35（一）异常处理35（二）日志规约38三、单元测试40四、安全规约42五、MySQ1.数据库43（一）建表规约43（一）索引规约46（三）SQ1.语句47（四）ORM映射49六、工程结构50（一）应用分层50（二）二方库依赖52（三）服务器53七、设计规约54附1：专有名词解释58一、编程规约(一)命名风格1 .【强制】代码中的命名均不能以下划线或美元符号开始，也不

2、能以下划线或美元符号结束。反例：_name/name/Sname/name_/name$/name2 .【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。E例:renminbi/a1.ibaba/taobao/youku/hangzhou等国际通用的名称,可视同英文。及例:DaZheBroniotion打折/getPIngfenByNameO评分/int某变量=3【强制】类名使用UpperCame1.Case风格，但以下情形例外：DO/BO/DTO/VO/0PO/UID等。I

3、E例：JavaServer1.essP1.atform/UserDO/Xm1.Service/TcpUdpDea1./TaPromotion反例:Javaserver1.essp1.atform/UserDo/XM1.Service/TCPUDPDea1./TAPromotion4 .【强制】方法名、参数名、成员变量、局部变量都统一使用IowerCame1.Case风格，必须遵从驼峰形式。壬例:Ioca1.Va1.ue/getHItpMessage()/inputUser1.d5 .【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。壬例：MAX_STOCK_CO

4、UNT/CACHE一EXPIREDJHME反例：MAX_COUNT/EXPIREDjnME6 .【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。7 .【强制】类型与中括号紧挨相连来表示数组。正例：定义整形数组intarrayDemo；反例:在main参数中，使用StringargS口来定义。8 .【强制】POJO类中布尔类型变量都不要加is前缀，否则部分框架解析会引起序列化错误。说明：在本文MySQ1.规约中的建表约定第一条，表达是与否的值采用isXXX的命名方式，所以，需要在resu1.tMap设

5、置从is_xxx到xxx的映射关系。反例：定义为基本数据类型Boo1.eanisDe1.etcd的属性，它的方法也是isDe1.eted(),RPC框架在反向解析的时候，“误以为”对应的属性名称是de1.eted,导致属性获取不到，进而抛出异常。9 .【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。:E例：应用工具类包名为com.a1.ibaba.ai.uti1.,类名为MessageUti1.s(此规则参考spring的框架结构)10 .【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采

6、用完全相同的命名，便可读性降低。说明：子类、父类成员变量名相同，即使是PUb1.iC类型的变量也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非setter/getter的参数名称也要避免与成员变量名称相同。反例：pubiicc1.assConfusingNamepb1.icintage：/非setter/getter的参数名称，不允许与本类成员变量同名pub1.icvoidgetData(Stringa1.ibabaii!conditionfina1.intmoney=531：fortinti0；i10：i+*)/在同一方法体中，不允许与其它代码块中

7、的money命名相同fina1.intmoney615；c1.assSonextendsConfusingName/不允许与父类的成员变量名称相同pub1.icintage；11 .【强制】杜绝完全不规范的缩写，避免望文不知义。反例：AbStraCtCIaSS缩写命名成AbsC1.ass;condition缩写”命名成condi,此类随意缩写严重降低了代码的可阅读性。12 .为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。王例：在JDK中，表达原子更新的类名为：AtoniicReferenceFie1.dUpdatero反例：inta的随意命名方式。13

8、 .1在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。IE例：StartTime/WorkQueue/name1.ist/TERMINATEDJHREAD工OINT反例:StartedAt/QueueOfWork/1iStName/COUNTTERMINATEDTHREAD14 .如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念F例：pub1.icc1.assOrderFactory;pub1.icc1.ass1.oginProxy;pub1.icc1.assResourceObserver;15 .：

9、】接口类中的方法和属性不要加任何修饰符号（PUb1.iC也不要加），保持代码的简洁性，并加上有效的JaVadOC注释。尽量不要在接口里定义变量,如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。E例：接口方法签名voidcommit（）；接口基础常量StringCOMPANY=a1.ibaba；反例:接口方法定义pub1.icabstractvoidfO；说明:JDK8中接口允许有默认实现，那么这个defau1.t方法，是对所有实现类都有价值的默认实现。16 .接口和实现类的命名有两套规则：1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，

10、内部的实现类用ImP1.的后缀与接口区别。正例:CacheserviceIinp1.实现CaCheSerViCe接口。2）【）如果是形容能力的接口名称，取对应的形容词为接口名（通常是一ab1.e的形容词）。正例:AbstractTransIator实现Trans1.atab1.e接口。17 .【参考】枚举类名带上EnUm后缀，枚举成员名称需要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。正例:枚举名字为ProcessStatusEnuin的成员名称:SUCCESS/UNKNOWN_REASON18 .【参考】各层命名规约：ServiceDO

11、层方法命名规约1） 获取单个对象的方法用get做前缀。2）获取多个对象的方法用IiSt做前缀，复数形式结尾如：IiStobjects。3) 获取统计值的方法用count做前缀。4) 插入的方法用save/insert做前缀。5) 删除的方法用remove/de1.ete做前缀。6) 修改的方法用update做前缓。B)领域模型命名规约1) 数据对象：xxxD0,XXX即为数据表名。2) 数据传输对象：xxxDT0,XXX为业务领域相关的名称。3) 展示对象：XXXV0,XXX一般为网页名称。4) POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO(二)常量定义1 .【强制】不允

12、许任何魔法值(即未经预先定义的常量)直接出现在代码中。反例：Stringkey=Id#taobao_+tradeId；cache,put(key.va1.ue)；/缓存get时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题2 .【强制】在1.ong或者1.ong赋值时，数值后使用大写的1.,不能是小写的1,小写容易跟数字1混淆，造成误解。说明：1.Onga=21；写的是数字的21,还是1.ong型的2。3 .不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类CaCh

13、eCOnStS下；系统配置相关常量放在类ConfigConsts下。4 ,常量的复用层次有五层：跨应用共享常量.应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1)跨应用共享常量：放置在二方库中，通常是c1.ient,jar中的constant目录下。2)应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：类A中：pub1.icstaticfina1.StringYES=yes；类B中：pub1.icstaticfina1.StringYES=y;.A.YES.equa

14、1.s(B.YES),预期是true,但实际返回为fa1.se,导致线上问题。3) 子工程内部共享常量：即在当前子工程的constant目录下。4) 包内共享常量：即在当前包下单独的constant目录下。5) 类内共享常量：直接在类内部privatestaticfina1.定义。5. I如果变量值仅在一个固定范围内变化用enum类型来定义。说明：如果存在名称之外的延伸属性应使用enum类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。正例:pub1.iccnu11SeasonEnumSPRING(I),SUMMER(2),AUTUMN(3),WINTER(4);privateint

15、seq；SeasonEnum(intSeq)this.Seqseq：pub1.icintgetSeq()returnseq：(三)代码格式1 .【强制】如果是大括号内为空，则简洁地写成。即可，大括号中间无需换行和空格；如果是非空代码块则：1)左大括号前不换行。2)左大括号后换行。3)右大括号前换行。4) 右大括号后还有e1.se等代码则不换行；表示终止的右大括号后必须换行。2 .【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格：而左大括号前需要空格。详见第5条下方正例提示。反例：if(空格a=b空格)3 .【强制】if/for/whi1.e/switch/do等保留字与括号之间都必须加空格。4 .【强制】任何二目、三目运算符的左右两边都需要加一个空格。说明：运算符包括赋值运算符=、逻辑运算符&、加减乘除符号等。5 .【强制】采用4个空