食品安全编码规范.docx

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

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

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

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

5、x的映射关系。反例：定义为基本数据类型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+*)/在同一方法体中，不允许与其它代码块中的money命名相同f

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

8、名时，表示类型的名词放在词尾，以提升辨识度。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的理念，暴露出来的服务一定是接口，内部的实现类用ImP1

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

11、取单个对象的方法用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 .不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类CaCheCOnStS下；系统

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

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

15、num(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(Jack),append(M

19、a).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.,后边必须要有一个空格。method(args1.

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

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

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

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

24、依赖methodi的执行，将执行结果作为method2的输入。4 .【强制】单元测试是可以重受执行的，不能受到外界环境的影响。说明：单元测试通常会被放到持续集成中，每次有代码checkin时单元测试都会被执行。如果单测对外部环境（网络、服务、中间件等）有依赖，容易导致持续集成机制的不可用。正例：为了不受外界环境影响，要求设计代码时就把SUT的依赖改成注入，在测试时用spring这样的DI框架注入一个本地（内存）实现或者Mock实现。5 .【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测

25、不负责检查踏类或者跨系统的交互逻辑，那是集成测试的领域。6 .【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。7 .【强制】单元测试代码必须写在如下工程目录：src/test/java,不允许写在业务代码目录下。说明：源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。8 .单元测试的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支覆羞率都要达到100%说珥：在工程规约的应用分层中提到的DAO层，Manager层,可重用度高的Service,都应该进行单元测试。9 .编写单元测试代码遵守B

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

27、等，使用Char定长字符串类型。8 .【强制】YarChar是可变长字符串，不预先分配存储空间，长度不要超过5000,如果存储长度大于此值，定义字段类型为text,独立出来一张表，用主键来对应，避免影响其它字段索引效率。9 .【强制】表必备三字段：id,Create_time,update_time0说明：其中id必为主键，类型为bigintunsigned,单表时自增、步长为1。Createupdate_time的类型均为datetime类型。表的命名最好是遵循“业务名称表的作用”。正例：a1.ipay_task/force_project/trade一COnfigH.】库名与应用名称尽量一

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

29、检索速度。正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。对象年龄区间类型字节表示范围人150岁之内tinyintI无符号值：0到255龟数百岁Sma1.1.in1.2无符号值：0到65535说明：SE1.ECT1.ENGTH（轻松工作）；返回为12SE1.ECTCHARAcTERJ_ENGTH（轻松工作）；返回为4如果需要存储表情，那么选择utf8mb4来进行存储，注意它与utf-8编码的区别。ii【QTruncatetab1.e比DE1.ETE速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发trigger,有可能造成事故，故不建议在开发代码中使用此语句。

30、说明：TRUNCATETAB1.E在功能上与不带WHERE子句的DE1.ETE语句相同。（四）ORM映射1.【强制】在表查询中，一律不要使用*作为查询的字段列表，需要哪些字段必须明确写明。说明：1）增加查询分析器解析成本。2）增减字段容易与resu1.tMap配置不一致。3）无用字段增加网络消耗，尤其是text类型的字段。2 .【强制】POJo类的布尔属性不能加is,而数据库字段必须加is_.要求在resu1.tMap中进行字段与属性之间的映射。说明：参见定义PoJo类以及数据库字段定义规定，在中增加映射，是必须的。在MyBatisGenerator生成的代码中，需要进行对应的修改。3 .【强

31、制】不要用resu1.tc1.ass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个PoJO类与之对应。说明：配置映射关系，便字段与DO类解耦，方便维护。4 .【强制】Sq1.Xm1.配置参数使用：#,#Pararri#不要使用$此种方式容易出现SQ1.注入。强制】IBATIS自带的queryFor1.ist（StringStatementName,intstart,intsize）不推荐使用。记明：其实现方式是在数据库取到StatementName对应的SQ1.语句的所有记录，再通过Sub1.ist取start,size的子集合。E例：Mapmap=

32、newHashMap（）;map.put（,start,start）;map.pt（size,size）;6 .【强制】不允许直接於HaShMaP与HaShtab1.e作为查询结果集的输出。三H:resu1.tC1.ass=wHashtab1.ew,会置入字段名和属性值,但是值的类型不可控。单处理等。SerViCe层：相对具体的业务逻辑服务层。Manager层：通用业务处理层，它有如下特征：D对第三方平台封装的层，预处理返回结果及转化异常信息。2)对SerViCe层通用能力的下沉，如缓存方案、中间件通用处理。3)与DAo层交互，对多个DAe)的组合复用。DAo层：数据访问层，与底层MySQ1.

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

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

35、AO(App1.icationObject)：应用对象，在Web层与SerViCe层之间抽象的复用对象模型，极为贴近展示层，复用度不高。VO(ViewObject)：显示层对象，通常是Web向模板渲染引擎层传输的对象。Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用MaP类来传输。(二)二方库依赖1) 【强制】定义GAV遵从以下规则：1)GroUP1.D格式：com.公司BU.业务线.子业务线,最多4级。说出,：公司BU例如：a1.ibaba/taobao/tma1.1./a1.iexpressBU-子业务线可选。正.司：com.taobao.jstor

36、mcom.a1.ibaba.dubbo.register2) ArtifaCt1.D格式：产品线名模块名。语义不重复不遗漏，先到中央仓库去查证一下。F例:dubbo-c1.ient/fastjson-api/jstorm-too1.3) Version：详细规定参考下方。2 .【强制】二方库版本号命名方式：主版本号.次版本号.修订号1)主版本号：产品方向改变，或者大规模AP1.不兼容，或者架构不兼容升级。2)次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的AP1.不兼容修改。3)修订号：保持完全兼容性，修复BUG、新增次要功能特性等。说明：注意起始版本号必须为：1.0.0,而不是OO

37、1.,正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：133,那么下一个合理的版本号:1.3.4或1.4.0或2.0.03 .【强制】线上应用不要依赖SNAPSHoT版本(安全包除外)。说明：不依赖SNAPSHoT版本是保证应用发布的幕等性。另外，也可以加快编译时的打包构建。4 .【强制】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证。说明:在升级时,进行dependency:res。IVe前后信息比对,如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行exc1.u

38、de排除jar包。5 .【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。6 .【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。记晅：依赖SPringframeWOrk-Core,-context,-beans,它们都是同一个版本，可以定义一个变量来保存版本：$spring.version,定义依赖的时候，引用该版本。7 .,）禁止在子项目的POm依赖中出现相同的Group1.d,相同的ArtifaCHd,但是不同的Version0说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war

39、只能有一个版本号出现在最后的Iib目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。8 .底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。9 .所有Pom文件中的依赖声明放在dependencies语句块中，所有版本仲裁放在dependencyManagement语句块中。-说；*：dependencyManagement里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，VerSion和SCoPe都读取自父POm。而（dependencies所有声明在主pom的dependencies里的依赖都会自动引入,并默认被所有的子项目继承。10 .二方库不要

40、有配置项，最低限度不要再增加配置项。11 .f1为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：D精简可控原则。移除一切不必要的AP1.和依赖，只包含SerViCeAPI、必要的领域模型对象、UtiIS类、常量、枚举等。如果依赖其它二方库，尽量是pr。Vided引入，让二方库使用者去依赖具体版本号；无Iog具体实现，只依赖日志框架。2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。（三）服务器1. 高并发服务器建议调小TCP协议的timjwait越时时间。说明：操作系统默认240秒

41、后，才会关闭处于time_Wait状态的连接，在高并发访问下，服务器端会因为处于timjwait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。正例:在IinUX服务器上请通过变更etcsysct1.conf文件去修改该缺省值（秒）：net.ipv4.tcp_fin_timeout=302. 调大服务器所支持的最大文件句柄数（Fi1.eDescriptor,简写为fd）。说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd主流的IinUX服务器默认所支持最大fd数量为1024.当并发连接数很大时很容易因为fd不足而出现opent

42、OomanyfiIeS”错误，导致新的连接无法建立。建议将IinUX服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。3. 给JVM环境参数设置-XX:+HeaPDUmPonOUtofMernOryErrOr参数，让JVM碰到OOM场景时输出dump信息。说明：OoM的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。4. :在线上生产环境，JVM的XmS和XmX设置一样大小的内存容量，避免在GC后调整堆大小带来的压力。5. 【砥考】服务器内部重定向使用forward；外部重定向地址使用UR1.拼装工具类来生成,否则会带来UR1.维护不一致的问题和潜在的安

43、全风险。七、设计规约1 .【强制】存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档。说明:有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数据迁移和系统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地进行设计和评审，生产环境提交执行后，需要进行d。UbIeCheck。王例：评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如在原有表中新增字段）也需要进行评审通过后上线。2 .【强制】在需求分析阶段，如果与系统交互的USer超过一类并且相关的USe

44、rCaSe超过5个，使用用例图来表达更加清晰的结构化需求。3 .【强制】如果某个业务对象的状态超过3个，使用状态图来表达并且明确状态变化的各个触发条件。说明：状态图的核心是对象状态，首先明确对象有多少种状态，然后明确两两状态之间是否存在直接转换关系，再明确触发状态转换的条件是什么。正例：淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。4 .【强能】如果系统中某个功能的调用链路上的涉及对象超过3个，使用时序图来表达并且明确各调用环节的输入与输出。说明：时序图反映了一系列对象间的交互与协作关系，清晰立体地反映系统的调用纵深链

45、路。5 .【强制】如果系统中模型类超过5个，并且存在复杂的依赖关系，使用类图来表达并且明确类之间的关系。说明：类图像建筑领域的施工图，如果搭平房，可能不需要，但如果建造蚂蚁Z空间大楼，肯定需要详细的施工图。6 .【强制】如果系统中超过2个对象之间存在坏作关系，并且需要表示复杂的处理流程,使用活动图来表示。说明：活动图是流程图的扩展，增加了能够体现协作关系的对象泳道，支持表示并发等。7 .需求分析与系统设计在考虑主干功能的同时，需要充分评估异常流程与业务边界。反例：用户在淘宝付款过程中，银行扣款成功，发送给用户扣款成功短信，但是支付宝入款时由于断网演练产生异常，淘宝订单页面依然显示未付款，导致用

46、户投诉。8 .类在设计与实现时要符合单一原则。说明：单一原则最易理解却是最难实现的一条规则，随着系统演进，很多时候，忘记了类设计的初衷。9 .谨慎使用继承的方式来进行扩展，优先使用聚合/组合的方式来实现。说明：不得已使用继承的话，必须符合里氏代换原则，此原则说父类能够出现的地方子类一定能够出现，比如，“把钱交出来“，钱的子类美元、欧元、人民币等都可以出现。10 .】系统设计时，根据依赖倒置原则，尽量依赖抽象类与接口，有利于扩展与维护。说明：低层次模块依赖于高层次模块的抽象，方便系统间的解耦。11 .系统设计时，注意对扩展开放，对修改闭合。说明：极端情况下，交付线上生产环境的代码都是不可修改的，同一业务域内的需求变化，通过模块或类的扩展来实现。12 .I系统设计阶段，共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等，避免出现重复代码或重复配置的情况。说明：随着代码的重复次数不断增加，维护成本指数级上升。13 .避免如下误解：敏捷开发=讲故事+编码+发布。说明：敏捷开发