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

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等保留字

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

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

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

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

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

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

22、的0,一个是数字的0,加Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。3 .【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。说明：可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)壬例：pub1.ic1.ist1istUsers(Stringtype,1.ong.ids).4 .【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加刨)eprecated注解，并清晰地说明采用的新接口或者新服务是什么。5 .【强制】不能使用过时的类

23、或方法。说明:.UR1.Decoder中的方法decode(StringencodeStr)这个方法已经过时，应该使用双参数decode(Stringsource,Stringencode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。6 .【强制】Object的equa1.s方法容易抛空指针异常，应使用常量或确定有值的对象来调用equa1.So土例:test,equa1.s(object)；反例：object,equa1.s(test);说葭：推荐使用java.uti1.Objects#equa1.s(JDK7引入的工具类)。

24、7 .【强制】所有整型包装类对象之间值的比较，全部使用equa1.s方法比较。说所：对于Integervar=?在-128至127范围内的赋,值，Integer对象是在IntegerCache.cache产生，会复用巳有对象，这个区间内的Integer值可以直接使用=进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equa1.s方法进行判断。8 .【强制】浮点数之间的等值判断，基本数据类型不能用=来比较，包装数据类型不能用equa1.s来判断。说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确

25、表示大部分的十进制小数，具体原理参考码出高效0反例：f1.oata1.Of-0.9f：f1.oatb0.9f-0.8f：if(a=b/预期进入此代码快，执行其它业务逻辑/但事实上a=b的结果为fa1.seF1.oatxF1.oat,vaIueOf(a；F1.oaty=F1.oat,va1.uef,b,；if(x.equa1.s(y)/预期进入此代码快，执行其它业务逻辑/但事实上equa1.s的结果为fa1.se正例：(1)指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。f1.oata1.0f0.9f：f1.oatb0.9f0.8:f1.oatdiff=1.e-6;3 .【强制】

26、应用中的扩展日志(如打点、临时监控、访问日志等)命名方式：appNameIogTypeIogName.1.ogoIogTyPe:日志类型,如stats/monitor/access等；IogName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。正列：force-Web应用中单独监控时区转换异常，如：force_web_tIineZoneConvert.1.og4 .【强制】在日志输出时，字符串变量之间的拼接使用占位符的方式。说

27、明：因为String字符串的拼接会使用StringBui1.der的append。方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。正例：1.ogger,debug(Processingtradewithid：and-1：,id.symbo1.):5 .【强制】对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。说明:虽然在debug(参数)的方法体内第一行代码isDisab1.ed(1.eve1.DEBUG_INT)真时(S1.f4j的常见实现1.og4j和1.ogback),就直接return,但是参数可能会进行字符串拼接运算。此外，如果debu

28、g(getName()这种参数内有getNameO方法调用,无谓浪费方法调用的开销。正例：/如果判断为真，那么可以输出trace和debug级别的日志if(1.ogger,iSDebugEnab1.ed:)1.ogger,debug(CurrentIDis：andnameis：.id.getName()；6 .【强制】避免重复打印日志，浪费磁盘空间，务必在1.og4j.xm1.中设置additivity=fa1.seo正例：7 .【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上拗出。正例：Iogger.error（各类参数或者对象toSt

29、ring（）+e.getMessageO.e）；8 .谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用Warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘探爆，并记得及时删除这些观察日志。说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？9.1可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出error级别，避免频繁报警。说明:注意日志输出的级别，error级别只记

30、录系统逻辑出错、异常或者重要的错误信息。10.】尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生岐义。【强制】国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。三、单元测试1.【强制】好的单元测试必须遵守AIR原则。说明：单元测试在线上运行时，感觉像空气（A1.R）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。A：Automatic（自动化）T:Indepcndent（独立性）R：RepeatabIe（可重复）2 .【强制】单元测试应该是全自动执

31、行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用System.out来进行人肉脸证，必须使用assert来验证。3 .【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序。反例:method2需要依赖method1.的执行，将执行结果作为method2的输入。4 .【强制】单元测试是可以重复执行的，不能受到外界环境的影响。说明：单元测试通常会被放到持续集成中，每次有代码checkin时单元测试都会被执行。如果单测对外部环境（网

32、络、服务、中问件等）有依赖，容易导致持续.集成机制的不可用。正例：为了不受外界环境影响，要求设计代码时就把SUT的依敕改成注入，在测试时用spring这样的D1.框架注入一个本地（内存）实现或者Mock实现。5 .【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑，那是集成测试的领域。6 .【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。7 .【强制】单元测试代码

33、必须写在如下工程目录：src/test/java,不允许写在业务代码目录下。说明：源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。8 .单元测试的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支农曾率都要达到100%说突：在工程规约的应用分层中提到的DAO层，Manager层，可重用度高的SerViCe,都应该进行单元测试。9 .编写单元测试代码遵守BCDE原则，以保证被测试模块的交付质量。 B：Border,边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。 C：Correct,正确的输入，并得到预期的结果。 D：Design,与设计文档相结合，来编写单元测试。

34、E：Error,强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。10 .对于数据库相关的杳询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业务插入规则，导致测试结果异常。11 .和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏改他人的订单。2 .【强制】用户敏感数据禁止直接展示，必须对展示数据进行脱敬。说明：中国大陆个人手机号码显示为：137*0969,隐藏中间4位，防

35、止隐私泄露。3 .【强制】用户箍入的SQ1.参数严格使用参数绑定或者METADATA字段值限定，防止SQ1.注入，禁止字符串拼接SQ1.访问数据库。4 .【强制】用户请求传入的任何参数必须做有效性验证。说明：忽略参数校验可能导致：pagesize过大导致内存溢出 恶意Orderby导致数据库慢查询 任意重定向SQ1.注入 反序列化注入,正则输入源串拒绝服务ReDoS说明：JaVa代码用正则来骏证客户端的输入，有些正则写法验证普通用户输入没有问题,但是如果攻击人员使用的是特殊构造的字符串来脸证，有可能导致死循环的结果。5 .【强制】禁止向HTM1.页面输出未经安全过滤或未正确转义的用户数据。6

36、t强制】表单、AJAX提交必须执行CSRF安全验证。说明:CSRF(Cross-siterequestforgery)跨站请求伪造是一类常见编程漏洞O对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好UR1.,只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。7 .【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校脸，避免被滥刷而导致资损。说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。8 .发贴、评论、发送即时消息等用户生成

37、内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。五、MySQ1.数据库(一)建表规约存储长度大于此值，定义字段类型为text,独立出来一张表，用主键来对应，避免影响其它字段索引效率。9 .【强制】表必备三字段：id.Createupdate-time说明：其中id必为主键，类型为bigintunsigned,单表时自增、步长为1。createtime,updatetime的类型均为datetime类型。10 .】表的命名最好是遵循“业务名称一表的作用”。F例：a1.ipay_task/force_project/trade_config11 .】库名与应用名称尽量一致。12 .J如果修改

38、字段含义或对字段表示的状态追加时，需要及时更新字段注释。13 .（1字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：1）不是频繁修改的字段。2）不是varchar超长字段，更不能是text字段。3）不是唯一索引的字段。正例：商品类目名称使用频率高，字段长度短，名称基本一不变，可在相关联的表中冗余存储类目名称，避免关联查询。14 .J单表行数超过500万行或者单表容量超过2GB,才推荐进行分库分表。说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。15 .【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。正例：

39、如下表，其中无符号值可以避免误存负数，且扩大了表示范围。对象年龄区间类型字节表不范围人150岁之内tinyint1无符号值：0到255龟数百岁sma1.Iint2无符号值：6到65535恐龙化石数千万年厂intunsigned4无符号值：0到约42.9约50亿年bigint8无符号值：0到约10（二）索引规约1 .【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校跄控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。2 .【强制】超过三个表

40、禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。说明:即使双表join也要注意表索引、SQ1.性能。3 .【强制】在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为20的索弓I,区分度会高达90%以上，可以使用count（distinctIeft（列名，索引长度）coun1.（*）的区分度来确定。4 .【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。说明：索引文件具有B-Tree的最左前缀匹配特性，

41、如果左边的值未确定，那么无法使用此索引。5 .如果有Orderby的场景，请注意利用索引的有序性。orderby最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现fi1.e_sort的情况,影响查询性能。J例:wherea=?andb=?orderbyc；索引：a_b_c反例:索引如果存在范围查询，那么索引有序性无法利用，如：WHEREa10ORDERBYb；索引ab无法排序。6 .利用覆盖索引来进行查询操作，避免回表。说明：如果一本书需要知道第11章是什么标题，会翻开第I1.章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。正例：能够建立索引的种类分为主键索

42、引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用exp1.ain的结果，extra列会出现：usingindex如果需要存储表情，那么选择utf8mb4来进行存储，注意它与utf-8编码的区别。U.】Truncatetab1.e比DE1.ETE速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发trigger,有可能造成事故，故不建议在开发代码中使用此语句。说明：TRUNCATETAB1.E在功能上与不带WHERE子句的DE1.ETE语句相同。(四)ORM映射1 .【强粕】在表查询中，一律不要使用*作为查询的字段列表，需要哪些字段必须明确写明。说吃：1)增加查

43、询分析.器解析成本。2)增;成字段容易与resu1.tMap配置不一致。3)无用字段增加网络消耗，尤其是text类型的字段。2 .【强塞】PoJo类的布尔属性不能加is,而数据库字段必须加is_,要求在resu1.tMap中进行字段与属性之间的映射。说明：参见定义POJo类以及数据库字段定义规定，在中增加映射，是必须的。在MyBatisGenerator生成的代码中，需要进行对应的修改。3 .【强制】不要用resu1.tc1.ass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个POJO类与之对应。说明：配置映射关系，使字段与DO类解耦，方便维护。4

44、强制】Sq1.Xm1.配置参数使用：#(,#Param件不要使用$此种方式容易出现SQ1.注入。强制iBATIS自带的queryFor1.ist(StringStatementNameJntstart,intsize)不推荐使用。记明：箕实现方式是在数据库取到StatementName对应的SQ1.语句的所有记录，再通过sub1.ist取start,size的子集合。F例：Mapmap=newHashMap();map.put(start,start);map.putsize,size);6 .【强制】不允许直接拿HaShMaP与HaShtab1.e作为查询结果集的输出。说.明：resu1

45、tC1.ass=Hashtab1.e”,会置入字段名和属性值,但是值的类型不可控。7 .【强制】更新数据表记录时，必须同时更新记录对应的gmjmodified字段值为当前时间。8 .不要写一个大而全的数据更新接口。传入为PoJo类，不管是不是自己的目49/442)对SerViCe层通用能力的下沉，如缓存方案、中间件通用处理。3)与DAo层交互，对多个DAO的组合复用。DAO层：数据访问层，与底层MySQ1.、Orac1.eHbaSe等进行数据交互。外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接口。2 .【参考】(分层异常处理规约)在DAo层，产生的异常类型有

46、很多，无法用细粒度的异常进行CatCh,使用CatCh(EXCePtiOne)方式，thrownewDAOExceptionfe),不需要打印日志，因为日志在Manager/Service层一定需要捕获并打印到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在SerViCe层出现异常时，必须记录出错日志到磁盘，尽可能带上参数信息，相当于保护案发现场。如果Manager层与SerViCe同机部署，日志方式与DAO层处理一致，如果是单独部署，则采用与SerViCe一致的处理方式。Web层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常遭染，那么就应该直接跳转到友好错误页面，加上用户容易理解的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。