旅游大数据编码规范.docx
《旅游大数据编码规范.docx》由会员分享,可在线阅读,更多相关《旅游大数据编码规范.docx(24页珍藏版)》请在优知文库上搜索。
1、编码规范目录一、编程规约4(一)命名风格4(二)常量定义8(Z)代码格式9(X)P规约13(五)集合处理19(六)并发处理24(七)控制语句29(八)注释帼33(九)其它35二、异常日志36(一)异常处理36O日志规约39三、单元测试41四、安全帼44五、MySQ1.数据库45(一)建表三)45(二)索引贩47(三)SQ1.语句49(四)ORM蝴50六、工程结构51(一)应用分层51(二二方库依赖53(=)服务器55七、设计三55附1:专有名词蝌59一、编程规约(一)命名风格1 .【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反例:_name/name/Sna
2、me/name_/nameS/name2 .【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,纯拼音命名方式更要避免采用。工例:renminbi/a1.ibaba/taobao/youku/hangzhou等国际通用的名称,可视同英文。反例:DaZhePromotion打折/getPingfenByName()评分/int某变量=3【强制】类名使用UPPerCameICaSe风格,但以下情形例外:DO/BO/DTo/VO/A0Po/UID等。E例:JavaServer1.essP1.atform/Use
3、r(X)/Xm1.Service/TcpUdpDea1./TaPromotion反例:javaserverIessp1.atform/UserDo/XM1.Service/TCPUDPDea1./TAPromotion4 .【强制】方法名、参数名、成员变量、局部变量都统一使用IowerCanie1.Case风格,必须遵从驼峰形式。IE例:Ioca1.Va1.ue/getHttpMessage()/inputUser1.d5 .【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。正例:MAX_STOCK_COUNT/CACHE_EXP1RED_TIME反例:MAXC
4、OUNT/EXPIREDTIME6 .【强制】抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。7 .【强制】类型与中括号紧挨相连来表示数组。F例:定义整形数组intarrayDemo;反例:在main参数中,使用StringargS口来定义。8 .【强制】POJO类中布尔类型变量都不要加is前缀,否则部分框架解析会引起序列化错误。说明:在本文MySQ1.规约中的建表约定第一条,表达是与否的值采用is_xxx的命名方式,所以,需要在resu1.tNap设置从is_xxx到xxx的映射关系。反例:定义为基本数据
5、类型Boo1.eanisDe1.eted的属性,它的方法也是iSDe1.etedO,RPC框架在反向?析的时候,“误以为”对应的属性名称是de1.eted,导致属性获取不到,进而抛出异常。9 .【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用受数形式。壬例:应用工具类包名为com.a1.ibaba.ai.Utih类名为Message1.Iti1.s(此规则参考spring的框架结构)10 .【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可读性降低。说明:子类、父类成员变量名相
6、同,即使是pub1.ic类型的变量也是能够通过编译,而局部变量在同一方法内的不同代码块中同名也是合法的,但是要避免使用。对于非setter/getter的参数名称也要避免与成员变量名称相同。反例:pub1.icc1.assConfusingNamepub1.icintage;/非Set1.eTVgetAer的参数名称,不允许与本类成员变量同名pub1.icvoidgeData(Stringa1.ibabaif(conditionfina1.intmoney531;/.for(inti=0:i10;i+);/在同一方法体中,不允许与其它代码块中的money命名相同fina1.intmoney61
7、5:/.c1.assSonextendsConfusingName/不允许与父类的成员变量名称相同pubicintage:11 .【强制】杜绝完全不规范的缩写,避免望文不知义。反例:AbStraCtC1.aSS缩写命名成AbsC1.ass;condition缩写命名成CORdi,此类随意缩写严重降低了代码的可阅读性。12 .为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。IE例:在JDK中,表达原子更新的类名为:AtomiCReferenCeFie1.dUPdater。反例:inta的随意命名方式。13 .!在常量与变量的命名时,表示类型的名词放在词尾,



- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 旅游 数据 编码 规范
