《旅游大数据编码规范.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 .!在常量与变量的命名时，表示类型的名词放在词尾，
8、以提升辨识度。王例：StartTime/workQueue/name1.ist/TERMINATEDTHREADCOUNT反例：StartedAt/QueueOfWork/IistName/COUNT_TERMNATED_THREAD14 .(如果模块、接口、类、方法使用了设计模式，在命名时需体现出具6/44体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念E例：pub1.icc1.assOrderFactory;pub1.icc1.ass1.oginProxy;pubicc1.assResourceObserver;15 .:】接口类中的方法和属性不要加任何修饰符号（PU
9、bIiC也不要加），保持代码的简洁性，并加上有效的JaVadoC注释。尽量不要在接口里定义变量,如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。正例:接口方法签名voidcommit（）；接口基础常量StringCOMPANY=a1.ibaba;反例：接口方法定义pb1.icabstractvoidfO；说明：JDK8中接口允许有默认实现，那么这个defau1.t方法，是对所有实现类都有价值的默认实现。16 .接口和实现类的命名有两套规则：1）【强制】对于Service和DAO类，基于SOA的理念，暴拓出来的服务一定是接口，内部的实现类用ImP1.的后缀与接口区别。F例：C
10、acheService1.mp1.实现CaCheSerViCe接口。2）】如果是形容能力的接口名称，取对应的形容词为接口名（通常是一ab1.e的形容词）。正例：AbStraCtTranSIatOr实现Trans1.atab1.e接口。17 .【喙普】枚举类名带上EnUm后缀，枚举成员名称霜要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。正例：枚举名字为ProcessStatusEnuin的成员名称：SUCCESS/UNKNOWN_REASON018 .【参考】各层命名规约：SerViCe/DAO层方法命名规约1） 获取单个对象的方法用get
11、做前缀。2)获取多个对象的方法用IiSt做前缓，复数形式结尾如：IiStObjects。3) 获取统计值的方法用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的统称，禁止命名成XXXPoJ0。(二)常量定义1 .【强制】不允许任何魔法值(即未经预先定义的常量)直接出现
12、在代码中。反例：Stringkey=Idtaobao-+tradeId；cache,put(key.va1.ue)；/缓存get时，由于在代码复制时，漏掉下划线，导致馈存击穿而出现问题2 .【强制】在1.ong或者1.ong赋值时，数值后使用大写的1.,不能是小写的1,小写容易跟数字1混淆，造成误解。说明：1.onga=21；写的是数字的21,还是1.Ong型的203 .不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类CacheConsts下；系统配置相关常量放在类Con
13、figConsts下。4 ,常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1)跨应用共享常量：放置在二方库中，通常是c1.ient,jar中的constant目录下。2)应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES”的变量：类A中：pub1.icstaticfina1.StringYES=yes；类B中：pub1.icstaticfina1.StringYES=wy；.YES.equa1.s(B.YES),预期是true,但实际返回
14、为fa1.se,导致线上问题。3) 子工程内部共享常量：即在当前子工程的constant目录下。4) 包内共享常量：即在当前包下单独的constant目录下。5) 类内共享常量：直接在类内部privatestaticfina1.定义。5. 如果变量值仅在一个固定范围内变化用enum类型来定义。说明：如果存在名称之外的延伸属性应使用enum类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。正例：pub1.icenunSeasonEnumSPR1.NG(I),SUMMER(2),AUTUMN(3),WINTER(4)；privateintseq：SeasonEnum(intseq；1th
15、is.seqseq：pub1.icintgetSeqOreturnseq：(三)代码格式1 .【强制】如果是大括号内为空，则简洁地写成)即可，大括号中间无需换行和空格；如果是非空代码块则：1)左大括号前不换行。2)左大括号后换行。3)右大括号前换行。4)右大括号后还有e1.se等代码则不换行；表示终止的右大括号后必须换行。9/442 .【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第5条下方正例提示。反例：if(空格a=b空格)3 .【强制】ifforWhiIeswitchdo等保留字与括号之间都必须加空格。4 .【强制】任何二目、三目运
16、算符的左右两边都需要加一个空格。说明：运算符包括求值运算符=、逻辑运算符&、加减乘除符号等。5 .【强制】采用4个空格缩进，禁止使用tab字符。说明：如果使用tab缩进，必须设置1个tab为4个空格。IDEA设置tab为4个空格时，请勿勾选USetabcharacter；而在ec1.ipse中，必须勾选insertspacesfortabs。正例：(涉及1-5点)pub1.icstaticvoidmain(Stringargs),/缩进4个空格Stringsay=he1.1.o；/运算符的左右必须有一个空格intf1.ag=0；/关键词if与括号之间必须有一个空格，括号内的f与左括号，0与右括
17、号不需要空格if(f1.ag=0)System,out.printin(say)；)/左大括号前加空格且不换行：左大括号后换行if(f1.ag=1)System,out.printIn(wor1.d)；/右大括号前换行，右大括号后有e1.se,不用换行e1.seuSystem,out.PrintIn(ok)；/在右大括号后直接结束，则必须换行)6 .【强制】注释的双斜线与注程内容之间有且仅有一个空格。正例：/这是示例注释，请注意在双斜线之后有一个空格Stringparam=newString)：7 .【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。正例：1.ongfir
18、st10000000000001.：intsecondIintjfirS1.2；8.【强制】单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：1)第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进，参考示例。2)运算符与下文一起换行。3)方法调用的点符号与下文一起换行。4)方法调用中的多个参数需要换行时，在逗号后进行。5)在括号前不要换行，见反例。正例：StringBui1.derSb=newStringBui1.derO:/.超过120个字符的情况下，换行缩进4个空格，点号和方法名称一起换行sb.append(Jack),append(Ma).append(a1.ibab
19、a).append(a1.ibaba).append(na1.ibaba)；反例：StringBuiIderSb=newStringBui1.derO:/.超过120个字符的情况下，不要在括号前换行sb.append(Jack).append(Ma).append(wa1.ibaba)；/参数很多的方法调用可能超过120个字符，不要在逗号前换行method(args1.,args2,args3,.,argsX)；9.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。-E例：下例中实参的args1.,后边必须要有一个空格。method(args1.,args2,args3)：10 .【
20、强制】IDE的textfi1.eencoding设置为UTF-8；IDE中文件的换行符使用Unix格式，不要使用Windows格式。11 .1单个方法的总行数不超过80行。说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80行。正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法,使主干代码更加清晰；共性逻辑抽取成为共性方法，便于复用和维护。12 .(没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。正例：intone=1；1.ongtwo=21.;f1.oatthree=3F；StringBui1.dersb=ne
21、wStringBui1.derO;说明：增加sb这个变量，如果需要对齐，则给one、two、three都要增加几个空格，在变量比较多的情况下，是非常累赘的事情。13 .不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明：任何情形，没有必要插入多个空行进行隔开。(四)OoP规约1 .【强制】避免通过一个类的对象引用访问此类的静态变量或价态方法，无谓增加编译器解析成本，直接用类名来访问即可。2 .【强制】所有的覆写方法，必须加OvecJde注解。说明:getbject()与getbject()的问题。一个是字母的0,一个是数字的0,加0VeiTide可以准确判断是否覆盖成
22、功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。3 .【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用ObjeCto说明：可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)例：pub1.ic1.istIistUsers(Stringtype.1.ong.ids).4 .【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。5 .【强制】不能使用过时的类或方法。说玩:.UR1.Decoder中的方法decode(Str
23、ingencodeStr)这个方法已经过时，应该使用双参数decode(Stringsource,Stringencode)o接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。6 .【强制】Object的equa1.s方法容易抛空指针异常，应使用常量或确定有值的对象来调用equa1.so工例:test.equa1.s(object);反例:object,equa1.s(test)；说明:推荐使用java.uti1.Objectstfequa1.s(JDK7引入的工具类)。13.447 .【强制】所有整型包装类对象之间值的比较，全部使用
24、equa1.s方法比较。说所：对于Integervar=?在-128至127范围内的赋,值，Integer对象是在IntegerCache.cache产生，会复用巳有对象，这个区间内的Integer值可以直接使用=进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equa1.s方法进行判断。8 .【强制】浮点数之间的等值判断，基本数据类型不能用=来比较，包装数据类型不能用equa1.s来判断。说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数，具体原理参考码出高效0反例：f
25、1.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;AO(AppIicationObject)：应用对象，在Web层与S
26、erViCe层之间抽象的复用对象模型，极为贴近展示层，复用度不高。VO(ViewObject)：显示层对象，通常是Web向模板渲染引擎层传输的对象。Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用MaP类来传输。(二)二方库依赖1.【强制】定义GAV遵从以下规则：1) GroUPID格式：COm.公司/BU.业务线.子业务线,最多4级。说出,：公司BU例如：a1.ibaba/taobao/tma1.1./a1.iexpressBU-子业务线可选。正.司：com.taobao.jstormcom.a1.ibaba.dubbo.register2) Artif
27、aCt1.D格式：产品线名模块名。语义不重复不遗漏，先到中央仓库去查证一下。F例:dubbo-c1.ient/fastjson-api/jstorm-too1.3) Version：详细规定参考下方。2 .【强制】二方库版本号命名方式：主版本号.次版本号.修订号1)主版本号：产品方向改变，或者大规模AP1.不兼容，或者架构不兼容升级。2)次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的AP1.不兼容修改。3)修订号：保持完全兼容性，修复BUG、新增次要功能特性等。说明：注意起始版本号必须为：1.0.0,而不是OO1.,正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本
28、号不允许覆盖升级。如当前版本：133,那么下一个合理的版本号:1.3.4或1.4.0或2.0.03 .【强制】线上应用不要依赖SNAPSHoT版本(安全包除外)。说明：不依赖SNAPSHoT版本是保证应用发布的幕等性。另外，也可以加快编译时的打包构建。4 .【强制】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证。说明：在升级时，进行dependency:reso1.ve前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行exdude排除jar包。5 .【强制】二方库里可以定义枚举类型，参数可以使用枚举
29、类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的PoJO对象。6 .【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。说明：依赖SPringframeWOrk-Core,-context,-beans,它们都是同一个版本，可以定义一个变量来保存版本：$spring.version,定义依赖的时候，引用该版本。7 .【强制】禁止在子项目的Porn依赖中出现相同的GrOUP1.d,相同的ArtifaCtId,但是不同的Version0说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war,只能有一个版本号出现在最后的Iib目录中。可能出现线下调试是正确
30、的，发布到线上却出故障的问题。8 .底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。9 .所有POm文件中的依赖声明放在dependencies语句块中，所有版本仲裁放在dependencyManagement语句块中O丁：dependencyManagement只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，VerSiOn和SCOPe都读取目父POm。而（dependencies所有声明在主pom的dependencies）里的依赖都会自动引入，并默认被所有的子项目继承。10 .二方库不要有配置项，最低限度不要再增加配置项。11 .-i为避免应用二方库的依赖冲
31、突问题，二方库发布者应当遵循以下原则：1）精简可控原则。移除一切不必要的AP1.和依赖，只包含SerViCeAPI、必要的领域模型对象、UtiIS类、常量、枚举等。如果依赖其它二方库，尽量是pr。Vided引入，让二方库使用者去依赖具体版本号；无Iog具体实现，只依赖日志框架。2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。（三）服务器1. 高并发服务器建议调小TCP坏议的timjwait超时时间。说明：操作系统默认240秒后，才会关闭处于time_wait状态的连接，在高并发访问下，,服务器
32、端会因为处于timjwait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。正例:在IinUX服务器上请通过变更etcsysct1.conf文件去修改该缺省值（秒）：net.ipv4.tcp_fin_timeout=302. 调大服务器所支持的最大文件句柄数（FiieDeSCriptor,简写为fd）。说殂：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd主流的IinUX服务器默认所支持最大fd数量为1024,当并发连接数很大时很容易因为fd不足而出现opent。OmanyfiIeS”错误，导致新的连接无法建立。建议将IinUX服
33、务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。3. 给JVM环境参数设置-XX:+HeaPDUmPonOUtOfMemOrYErTOr参数,让JVM碰到OOM场景时输出dump信息。说明：OoM的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。4. ；在线上生产环境，JVM的XmS和XmX设置一样大小的内存容量，避免在GC后调整堆大小带来的压力。5. 【专考】服务器内部重定向使用forward；外部重定向地址使用UR1.拼装工具类来生成,否则会带来UR1.维护不一致的问题和潜在的安全风险。七、设计规约1 .【强制】存储方案和底层数据结构的设计获得评审一
34、致通过，并沉淀成为文档。说明:有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数据迁移和系统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地进行设计和评审，生产环境提交执行后，需要进行d。UbIeCheck。1例：评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如在原有表中新增字段）也需要进行评审通过后上线。2 .【强制】在需求分析阶段，如果与系统交互的USer超过一类并且相关的USerCaSe超过5个，使用用例图来表达更加清晰的结构化需求。3 .【强制】
35、如果某个业务对象的状态超过3个，使用状态图来表达并且明确状态变化的各个触发条件。说明：状态图的核心是对象状态，首先明确对象有多少种状态，然后明确两两状态之间是否存在直接转换关系，再明确触发状态转换的条件是什么。正例：淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。4 .【强制】如果系统中某个功能的调用链路上的涉及对象超过3个，使用时序图来表达并且明确各调用环节的输入与输出。说明：时序图反映了一系列对象间的交互与协作关系，清晰立体地反映系统的调用纵深链路。5 .【强制】如果系统中模型类超过5个，并且存在复杂的依赖关系，使用
36、类图来表达并且明确类之间的关系。说明：类图像建筑领域的施工图，如果搭平房，可能不需要，但如果建造蚂蚁Z空间大楼，肯定需要详细的施工图。6 .【强制】如果系统中超过2个对象之间存在协作关系，并且需要表示受杂的处理流程,使用活动图来表示。说明：活动图是流程图的扩展，增加了能够体现协作关系的对象泳遭，支持表示并发等。7 .需求分析与系统设计在考虑主干功能的同时，需要充分评估异常流程与业务边界O反例：用户在淘宝付款过程中，银行扣款成功，发送给用户扣款成功短信，但是支付宝入款时由于断网演练产生异常，淘宝订单页面依然显示未付款，导致用户投诉。8 .类在设计与实现时要符合单一原则。说明：单一原则最易理解却是
37、最难实现的一条规则，随着系统演进，很多时候，忘记了类设计的初衷。9 .谨慎使用继承的方式来进行扩展，优先使用聚合/组合的方式来实现。说明：不得已使用继承的话，必须符合里氏代换原则，此原则说父类能够出现的地方子类一定能够出现，比如，“把钱交出来“，钱的子类美元、欧元、人民币等都可以出现。10 .系统设计时，根据依赖倒置原则，尽量依赖抽象类与接口，有利于扩展与维护。说明：低层次模块依赖于高层次模块的抽象，方便系统间的解耦。11 .1系统设计时，注意对扩展开放，对修改闭合。说明：极端情况下，交付线上生产环境的代码都是不可修改的，同一业务域内的需求变化，通过模块或类的扩展来实现。12 .系统设计阶段，
38、共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等，避免出现重复代码或重复配置的情况。说明：随着代码的重复次数不断增加，维护成本指数级上升。13 .【；】避免如下误解：敏捷开发=讲故事+编码+发布。说明：敏捷开发是快速交付迭代可用的系统，省略多余的设计方案，摒弃传统的审批流程，但核心关键点上的必要设计和文档沉淀是需要的。反例：某团队为了业务快速发展，敏捷成了产品经理催进度的借口，系统中均是勉强能运行但像面条一样的代码，可维护性和可扩展性极差，一年之后，不得不进行大规模重构，得不偿失。14 .【叁考】系统设计主要目的是明确需求、理顺逻辑、后期维护，次要目的用于指导编码。说明：避免为
39、了设计而设计，系统设计文档有助于后期的系统维护和重构，所以设计结果需要进行分类归档保存。15 .【。:考】设计的本质就是识别和表达系统难点，找到系统的变化点，并隔离变化点。说明：世间众多设计模式目的是相同的，即隔离系统变化点。16 .【工考】系统架构设计的目的： 确定系统边界。确定系统在技术层面上的做与不做。,确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入与输出。 确定指导后续设计与演化的原则。使后续的子系统或模块设计在规定的框架内继续演化。确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等。17 .【参考】在做无障碍产品设计时，需要考虑到：所有可交互的控件元素必须
40、能被tab键聚焦，并且焦点顺序需符合自然操作逻辑。,用于登陆校验和请求拦截的验证码均需提供图形验证以外的其它方式。自定义的控件类型需明确交互方式。附1：专有名词解释POJO(P1.ainOrdinaryJavaObject):在本手册中，POJO专指只有Setter/getter/toString的简单类，包括D0/DT0/B0/V0等。GAV(Group1.d.Art1.factct1.d.version):MaVen坐标，是用来唯一标识jar包。OOP(objectOrientedProgramming)：本手册泛指类、对象的编程处理方式。4. ORM(ObjectRe1.ationMap
41、ping)：对象关系映射,对象领域模型与底层数据之间的转换，本文泛指iBATIS,mybatis等框架。NPE(java.Iang.Nu1.1.PointerException)：空指针异常OSOA(Service-OrientedArchitecture)：面向服务架构，它可以根据需求通过网络对松散耦合的粗粒度应用组件进行分布式部署、组合和使用，有利于提升组件可重用性，可维护性。IDE(IntegratedDeve1.opmentEnvironment)：用于提供程序开发环境的应用程序，一般包括代码编辑器、编译器、调试器和图形用户界面等工具，本手册泛指InteIIiJIDEA和ec1.ipseoOOM(outofMemory):源于java.1.ang.OutOfMemoryEror,当JVM没有足够的内存来为对象分配空间并且垃圾回收器也无法回收空间时，系统出现的严重状况。9. 一方库：本工程内部子项目模块依赖的库(jar包)。10. 二方库：公司内部发布到中央仓库，可供公司内部其它应用依赖的库（jar包）。I1.三方库：公司之外的开源库（jar包）。
