媒体电影大数据项目编码规范.docx

《媒体电影大数据项目编码规范.docx》由会员分享，可在线阅读，更多相关《媒体电影大数据项目编码规范.docx（26页珍藏版）》请在课桌文档上搜索。

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

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

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

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

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

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

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

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

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

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

11、O层方法命名规约1) 获取单个对象的方法用get做前缀。2)获取多个对象的方法用1.ist做前掇，复数形式结尾如：IiStObjects03) 获取统计值的方法用count做前缀。4) 插入的方法用save/insert做前跟。5) 删除的方法用remove/de1.ete做前缀。6) 修改的方法用UPdate做前缀。B）领域模型命名规约1）数据对象：xxxDO,XXX即为数据表名。2）数据传输对象：xxxDTO,XXX为业务领域相关的名称。3）展示对象：XXXVO,XXX一般为网页名称。4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxP0J0o（二）常量定义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 .【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在

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

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

15、);privateintseq；SeasonEnum(intseq)this.Seq=seq；Ipuh1.icintgetSeq()(returnseq;)(三)代码格式1 .【强制】如果是大括号内为空，则简洁地写成即可，大括号中间无需换行和空格；如果是非空代码块则：1)左大括号前不换行。2)左大括号后换行。3)右大括号前换行。4)右大括号后还有e1.se等代码则不换行：表示终止的右大括号后必须换行。2 .【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第5条下方正例提示。反例：if(空格a=b空格)3 .【强制】if/for/whi1.e

16、/switch/do等保留字与括号之间都必须加空格。4 .【强制】任何二目、三目运算符的左右两边都需要加一个空格。说吃：运算符包括赋值运算符=、逻辑运算符&、加渡乘除符号等。5 .【强制】采用4个空格缩进，禁止使用tab字符。说明：如果使用tab缩进，必须设置1个tab为4个空格。IDEA设置tab为4个空格时，请勿勾选1.setabcharacter：而在ec1.ipse中，必须勾选insertspacesfortabs0正例：(涉及1-5点)pub1.icstaticvoidmain(Stringargs)/缩进4个空格Stringsay=he1.1.o；/运算符的左右必须有一个空格int

17、f1.ag=0；/关键词if与括号之间必须有一个空格，括号内的f与左括号，0与右括号不需要空格if(f1.ag=0)System.out.print1.n(say)；/左大括号前加空格且不换行；左大括号后换行if(f1.ag=1)System.out.printin(wor1.d)；/右大括号前换行，右大括号后有e1.se,不用换行e1.seSystem,out.PrintIn(ok)；/在右大括号后直接结束，则必须换行)6 .【强制】注释的双斜线与注释内容之间有且仅有一个空格。正例：/这是示例注释，请注意在双斜线之后有一个空格StringparamnewString)；7 .【强制】在进行类

18、型强制转换时，右括号与强制转换值之间不需要任何空格隔开。正例：1.ongfirst10000000000001.；intsecond(int)first2；8 .【强制】单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则:1)第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进，参考示例。2)运算符与下文一起换行。3)方法调用的点符号与下文一起换行。4)方法调用中的多个参数需要换行时，在逗号后进行。5)在括号前不要换行，见反例。正例：StringBuiIdersb=newStringBui1.derO：/超过120个字符的情况下，换行缩进4个空格，点号和方法名称一起换行sb.a

19、ppend(Jack),append(Ma).appendCa1.ibaba).append(na1.ibaba).append(a1.ibaba)；反例：StringBui1.dersb=newStringBui1.derO;/超过120个字符的情况下，不要在括号前换行sb.append(Jackn).append(Ma).append(a1.ibaba)；/参数很多的方法调用可能超过120个字符，不要在逗号前换行method(args1,args2,args3argsX)；9 .【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。正例：下例中实参的args1.,后边必须要有一个空格

20、。method(args1.args2,args3)；j,u10 .【强制】IDE的textfi1.eencoding设置为UTF-8；IDE中文件的换行符便用UniX格式，不要使用Windows格式。11 .【单个方法的总行数不超过80行。说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80行。正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰；共性逻辑抽取成为共性方法，便于复用和维护。12 .没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。正例：intone=1：1.ongtwo=21.；

21、f1.oatthree=3F；StringBuiIdersb=newStringBui1.derO:说明：增加sb这个变量，如果需要对齐，则给one.two,three都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。13 .，不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明：任何情形，没有必要插入多个空行进行隔开。(四)OoP规约1 .【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。2 .【强制】所有的覆写方法，必须加的Verride注解。说明:getbject()与getbject()的问题。一

22、个是字母的0,一个是数字的0,加SOverride可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。3 .【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。7 .不要在视图模板中加入任何复杂的逻辑。说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。8 .:任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。9 .及时清理不再使用的代码段或配置信息。说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度腌肿，代码冗余。正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方

23、，统一规定使用三个斜杠(/)来说明注释掉代码的理由。二、异常日志(一)异常处理1 .【强制】JaVa类库中定义的可以通过预检查方式规避的RuntimeException异常不应该通过CatCh的方式来处理，比如：NU1.1.POinterEXCeP1.iOn,IndexOutOfBoundsException等等。说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过catchNuinberFormatException来实现。正例:if(obj!=nu1.1.).反例：tryIobj.method()；catch(Nu1.IPoiDterExcep1

24、.ione),!,2 .【强制】异常不要用来做流程控制，条件控制。说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。3 .【强制】Ca1.Ch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的Cateh尽可能进行区分异常类型，再做对应的异常处理。说明：对大段代码进行try-catch,使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程说明:通过反射机制来调用方法，如果找不到方法，抛出Nosuc

25、hMethodExceptiono什么情况会抛出NoSuchMethodError呢？二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配，或者在字节码修改框架（比如：ASM）动态创建或修改类时，修改了相应的方法签名。这些情况，即使代码编译期是正确的，但在代码运行期时，会抛出NoSuchMethodError（10 .【方法的返回值可以为nu1.1.,不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回nu1.1.值。说明：本手册明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、

26、运行时异常等场景返回nu1.1.的情况。11 .【1防止NPE,是程序员的基本修养，注意NPE产生的场景：12 返回类型为基本数据类型，return包装数据类型的对象时，自动拆箱有可能产生NPEo反例：pub1.icintfOtreturnInteger对象,如果为nu1.1.,自动解箱抛NPEo2） 数据库的查询结果可能为nu1.1.o3）集合里的元素即使isNotEmpty,取出的数据元素也可能为nu1.1.。4）远程调用返回对象时，一律要求进行空指针判断，防止NPE。5）对于Session中获取的数据，建议进行NPE检查，避免空指针。6）级联调用obj.getAO.getBO.getCO

27、；一连串调用，易产生NPEo王例：使用JDK8的OPtiona1.类来防止NPE问题。12 .定义时区分UnCheCked/checked异常，避免直接抛出newRuntimeExceptionO.更不允许抛出Exception或者Throwab1.e,应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如:DAOException/ServiceException等。13 .【参考】对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常拗出：跨应用间RPC调用优先考虑使用Resu1.t方式，封装isSuccess（）方法、“错误码”、“错误简短信息”。说明：关于R

28、PC方法返回方式使用Resu1.t方式的理由：1)使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。2)如果不加栈信息，只是new自定义异常，加入自己的理解的errormessage,对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传揄的性能损耗也是问题。14 .【参考】避免出现重复的代码(DontRepeatYourse1.f),即DRY原则。说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。正例：一个类中有多个pub1.ic方法，都需要进行数行相同

29、的参数校验操作，这个时候请抽取：privateboo1.eancheckParam(DTOdto)(.)(二)日志规约1-【强制】应用中不可直接使用日志系统(1.og4、1.ogback)中的API,而应依赖使用日志框架S1.F4J中的API,使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。importorg.s1.f4j.1.ogger；importorg.s1.f4j.1.oggerEactory;privatestaticfina1.1.ogger1.ogger=1.oggerFactory.get1.ogger(Test,c1.ass)；2 .【强制】所有日志文件至少保存

30、15天，因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于6个月。3 .【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式：appName_1.ogType_1.ogName.1.og。IogType:日志类型，如stats/monitor/access等；IogName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。土例：forc

31、e-web应用中单独监控时区转换异常，如：force_web_timeZoneConvert.1.og4 .【强制】在日志输出时，字符串变量之间的拼接使用占位符的方式。说明：因为String字符串的拼接会使用StringBui1.der的append。方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。正例：1.ogger.Processingradewitid：andsymbo1.：,.id.symbo1.；5 .【强制】对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。说明：虽然在debug(参数)的方法体内第一行代码isDisab1.ed(1.

32、eve1.DEBUGNT)为真时(S1.f4j的常见实现1.og4j和1.ogback),就直接return,但是参数可能会进行字符串拼接运算。此外，如果debug(getName()这种参数内有getName()方法调用，无谓浪费方法调用的开销。正例：/如果判断为真，那么可以抢出IraCe和debug级别的日志if1.ogger.IsDebugEnab1.edO)1.ogger,debug(CurrentIDis：andnameis：(,id,getXame()；6 .【强制】避免重复打印日志，浪费磁盘空间，务必在1.og4j.xm1.中设置additivity=fa1.se工例：7 .【强

33、制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。壬例:IOgger.error(各类参数或者对象toString()+e.getMessageO,);8 .谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题,避免把服务器横盘撑爆，并记得及时删除这些观察日志。说明：大量地输出无效日志,不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？9 .可以使用warn日志级

34、别来记录用户输入参数错误的情况，避免用户投6 .【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。7 .【强制】单元测试代码必须写在如下工程目录：src/test/java,不允许写在业务代码目录下。说明：源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。8 .单元测试的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支覆盖率都要达到100%说明：在工程规约的应用分层中提到的DAO层，Manager层，可重用度高的Service,都应该进行单元测试。9 .1编写单元测试代码遵守BCDE原则，

35、以保证被测试模块的交付质量。 B:Border,边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。 C：Correct,正确的输入，并得到预期的结果。 I）：Design,与设计文档相结合，来编写单元测试。 E：Error,强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。10 .【】对于数据库相关的查询，更新，弱除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业务插入规则，导致测试结果

36、异常。11 .【】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。正例：在企业智能事业部的内部单元测试中，使用ENTERPRISE_INTE1.1.IGENCE_07工侬匚的前缓来标识单元测试相关代码。12 .对于不可测的代码在适当的时机做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。防止SQ1.注入，禁止字符串拼接SQ1.访问数据库。13 【强制】用户请求传入的任何参数必须做有效性验证。说明：忽略参数校骁可能导致：pagesize过大导致内存溢出恶意Orderby导致数据库慢查询任意重定向SQ1.注入反序

37、列化注入正则输入源串拒绝服务ReDoS说明：Java代码用正则来脸证客户端的揄入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。14 【强制】禁止向HTM1.页面输出未经安全过渡或未正确转义的用户数据。15 【强制】表单、AJAX提交必须执行CSRE安全验证。说明:CSRF（Cross-siterequestforgery）跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好UR1.,只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。16 【强制】在使用平台资源，譬如

38、短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。说明：如注册时发送骁证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。17 【：发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。五、MySQ1.数据库（一）建表规约1.【强制】表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsignedtinyint（1表示是，0表示否）。说叼：任何字段如果为非负数，必须是unsigned.9 .【强制】表必备三字段：id,create_tim

39、e,UPdate_time。说明：其中id必为主键，类型为bigintunsigned,单表时自增、步长为1。Createupdate,time的类型均为datetime类型。10 .】表的命名最好是遵循“业务名称一表的作用”。正例：a1.ipaytask/forceproject/tradeconfig11 .库名与应用名称尽量一致。12 .如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。13 .【字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：1）不是频繁修改的字段。2）不是VarChar超长字段，更不能是text字段。3）不是唯一索引的字段。正例：商

40、品类目名称使用频率高，字段长度短，名称基本一不变，可在相关联的表中冗余存储类目名称，避免关联查询。14 .【单表行数超过500万行或者单表容量超过2GB,才推荐进行分库分表。说明：如果颈计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。15 .【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。对象年龄区类型字节表示范围人150岁tinyint1无符号值：0到龟数百岁sma1.Iint2无符号值：0到恐龙数千万int4无符号值：0到约太阳约50bigint8无符号值：0到约（二）索引

41、规约1 .【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。2 .【强制】超过三个表禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。说明：即使双表join也要注意表索引、SQ1.性能。3 .【强制】在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。说明：索引的长度与区分度是一

42、对矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count（distinctIeft（列名，索引长度）count（*）的区分度来确定。4 .【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。5 .如果有Orderby的场景，请注意利用索引的有序性。Orderby最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现fi1.e-Sort的情况，影响查询性能。J例：Wherea=?andb=?orderbyc；索引:a_b_c反例:索引如果存在范围

43、查询，那么索引有序性无法利用，如：WHEREa100RDERBYb；索引ab无法排序。6 .】利用覆盖索引来进行查询操作，避免回表。说明：如果一本书需要知道第11章是什么标题，会翻开第11章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用exp1.ain的结果,extra列会出现:usingindexo2 )对SerViCe层通用能力的下沉，如缓存方案、中间件通用处理。3)与DAO层交互，对多个D0的组合复用。DAO层:数据访问层，与底层MySQ1.,Orac1.e,Hbase等

44、进行数据交互。外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接H。3 .【参考】(分层异常处理规约)在DAO层，产生的异常类型有很多，无法用细粒度的异常进行catch,使用catch(Exceptione)方式，并thrownewDAOException(e),不需要打印日志，因为日志在ManagerZService层一定需要捕获并打印到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在Service层出现异常时，必须记录出错日志到磁盘，尽可能带上参数信息，相当于保护案发现场。如果Manager层与Service同机部署，日志方式与DAO层处理一致，如果是

45、单独部署,则采用与Service一致的处理方式。Web层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，加上用户容易理解的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。4 .【参考】分层领域模型规约：DO(DataObject)：此对象与数据库表结构对应，通过DAO层向上传输数据源对象。DTO(DataTransferObject)：数据传输对象，Service或Manager向外传输的对象。BO(BusinessObject)：业务对象，由Service层输出的封装业务逻辑的对象。AO(App1.icat

46、ionObject)：应用对象，在Web层与SerViCe层之间抽象的复用对象模型，极为贴近展示层，复用度不高。VO(ViewObject)：显示层对象，通常是Web向模板渲染引擎层传输的对象。Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用Map类来传输。(二)二方库依赖1 .【强制】定义GAV遵从以下规则:1） GroupID格式：Com.公司/BU.业务线.子业务线,最多4级。说明:公司BU例如:a1.ibaba/taobao/tma1.1/a1.iexpress等BU一级;子业务线可选。IF例：com.taobao.jstorm或com.a1.ibaba,dubbo.register2） ArtifaCt1.D格式：产品线名-模块名。语义不重里不遗漏，先到中央仓库去查证一下。正例：dubbo-c1.ient/fastjson-api/jstor11-too1.3） Version：详细规定