水质监测分析编码规范.docx

《水质监测分析编码规范.docx》由会员分享，可在线阅读，更多相关《水质监测分析编码规范.docx（21页珍藏版）》请在课桌文档上搜索。

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：专有名词解释58B）领域模型命名规约1）数据对象：xxxDO,XXX即为数据表名。2）数据传输对象：xxxD

2、TO,XXX为业务领域相关的名称。3）展示对象：XXXVO,XXX一般为网页名称。4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxP0J0o（二）常量定义1 .【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。反例：Stringkey=Id#taobao_*+tradeId：cache.put（key,va1.ue）；/缓存get时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题2 .【强制】在1.ong或者1.ong赋值时，数值后使用大写的1.,不能是小写的1,小写容易跟数字1混淆，造成误解。说明：1.onga=21；写的是数字的21,还是1.ong型的

3、2。3 .【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类CacheConsts下：系统配置相关常量放在类ConfigConstsT04 .【推荐】常量的熨用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1）跨应用共享常量：放置在二方库中，通常是c1.ient,jar中的constant目录下。2）应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。反例：易懂变量也要统一定义成应用内共享常量，两位工程

4、师在两个类中分别定义了“YES”的变量：类A中：pub1.icstaticfina1.StringYES=yes：类B中:pub1.icstaticfina1.StringYES=y；A.YES.equa1.s（B.YES）,预期是true,但实际返回为fa1.se,导致线上问题。3） 子工程内部共享常量：即在当前子工程的constant目录下。4） 包内共享常量：即在当前包下单独的ConS1.ant目录下。5） 类内共享常量：直接在类内部privatestaticfina1.定义。6） 【推荐】如果变量值仅在一个固定范围内变化用enum类型来定义。说明：如果存在名称之外的延伸属性应使用enu

5、m类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。正例：pub1.icenumSeasonEnuniSPRING(I),SUMMER(2),AUTUMN(3),WINTER(4)；privateintseq；SeasonEnum(intseq)this.Seq=seq；Ipuh1.icintgetSeq()(returnseq;)(三)代码格式1.【强制】如果是大括号内为空，则简洁地写成即可，大括号中间无需换行和空格；如果是非空代码块则：1)左大括号前不换行。2)左大括号后换行。3)右大括号前换行。4)右大括号后还有e1.se等代码则不换行：表示终止的右大括号后必须换行。2 .【强

6、制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第5条下方正例提示。反例：if(空格a=b空格)3 .【强制】if/for/whi1.e/switch/do等保留字与括号之间都必须加空格。4 .【强制】任何二目、三目运算符的左右两边都需要加一个空格。说吃：运算符包括赋值运算符=、逻辑运算符&、加渡乘除符号等。反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。7 .代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重

7、滞后，就失去了导航的意义。8 .【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用,则删除。说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库已然保存了历史代码）。9 .【参考】对于注释的要求：第一、能够准确反映设计思想和代码逻辑：第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。10 .【参考】好的命名、代码结构是自解释的

8、，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。反例：门pute1.ephantintofridgeput（e1.ephant,fridge）；方法名put,加上两个有意义的变量名e1.ephant和fridge,已经说明了这是在干什么，语义清晰的代码不需要额外的注释。11 .【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。1）待办事宜（TODo）：（标记人，标记时间，预计处理时间）表示需要实现，但目前还未实现的功能。这实际上是一个Ja

9、VadOC的标签，目前的JaYadoC还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个JaVadoC标签）。2）错误，不能工作（FIXME）：（标记人，标记时间，预计处理时间）在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。(九)其它1 .【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。说明:不要在方法体内定义:Patternpattern=Ppi1.e(规则”)；2 .【强制】ve1.ocity调用POJO类的属性时，直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx(),如果是boo1.ean基本数

10、据类型变量(boo1.ean命名不需要加is前缀)，会自动调用isXxx()方法。说明：注意如果是Boo1.ean包装类对象，优先调用getXxx()的方法。3 .【强制】后台输送给页面的变量必须加S!var一中间的感叹号。说明：如果var等于nu1.1.或者不存在，那么$var会直接显示在页面上。4 .【强制】注意Math,random()这个方法返回是doub1.e类型，注意取值的范围0x1.(能够取到零值，注意除零异常)，如果想获取整数类型的随机数，不要将X放大10的若干倍然后取整，直接使用Random对象的nextInt或者next1.ong方法。5 .【强制】获取当前毫秒数Syste

11、m.CurrentTimeMi1.1.isO；而不是newDate().getTime();说明：如果想获取更加精确的纳秒级时间值，使用SyStem.nanoTime()的方式。在JDK8中，针对统计时间等场景，推荐使用InStant类。6 .【强制】日期格式化时，传入pattern中表示年份统一使用小写的y。说明：日期格式化时，yyyy表示当夭所在的年，而大写的YYYY代表是weekinwhichyear(JDK7之后引入的概念)，意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的YYYY就是下一年。另外需要注意： 表示月份是大写的M 表示分钟则是小写的m 24小时

12、制的是大写的11 12小时制的则是小写的h正例：表示日期和时间的格式如下所示：newSimp1.eDateForiiiat(yyyy-MM-ddHH：mm：ss*)；7 .不要在视图模板中加入任何复杂的逻辑。说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。8 .:任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。9 .及时清理不再使用的代码段或配置信息。说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度腌肿，代码冗余。正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(/)来说明注释掉代码的理由。二、异常日志(一

13、)异常处理1 .【强制】JaVa类库中定义的可以通过预检查方式规避的RuntimeException异常不应该通过CatCh的方式来处理，比如：NU1.1.POinterEXCeP1.iOn,IndexOutOfBoundsException等等。说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过catchNuinberFormatException来实现。正例:if(obj!=nu1.1.).反例：tryIobj.method()；catch(Nu1.IPoiDterExcep1.ione),!,2 .【强制】异常不要用来做流程控制，条件控制。说

14、明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。3 .【强制】Ca1.Ch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的Cateh尽可能进行区分异常类型，再做对应的异常处理。说明：对大段代码进行try-catch,使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。4 .【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将

15、该异常批给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。5 .【强制】有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。6.【强制】fina1.1.y块必须对资源对象、流对象进行关闭，有异常也要做try-catcho说明：如果JDK7及以上，可以使用try-with-resources方式。【强制】不要在fina1.1.y块中使用re1.urn0说明：try块中的return语句执行成功后，并不马上返回，而是继续执行fina1.1.y块中的语句，如果此处存在return语句，则在此直接返回，无情丢弃掉try块中的返回点。反例：

16、privateintx=0；pub1.icintCheckReturn()try/x等于1,此处不返回return+x；fina1.1.y/返回的结果是2return+x；)8 .【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。9 .【强制】在调用RPC,二方包、或动态生成类的相关方法时，捕捉异常必须使用Throwab1.e类来进行拦载。说明:通过反射机制来调用方法，如果找不到方法，抛出NosuchMethodExceptiono什么情况会抛出NoSuchMethodError呢？二方包在类冲突时，仲裁机制

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

18、返回类型为基本数据类型，return包装数据类型的对象时，自动拆箱有可能产生NPEo反例：pub1.icintfOtreturnInteger对象,如果为nu1.1.,自动解箱抛NPEo2） 数据库的查询结果可能为nu1.1.o3）集合里的元素即使isNotEmpty,取出的数据元素也可能为nu1.1.。4）远程调用返回对象时，一律要求进行空指针判断，防止NPE。5）对于Session中获取的数据，建议进行NPE检查，避免空指针。6）级联调用obj.getAO.getBO.getCO；一连串调用，易产生NPEo王例：使用JDK8的OPtiona1.类来防止NPE问题。12 .定义时区分UnCh

19、eCked/checked异常，避免直接抛出newRuntimeExceptionO.更不允许抛出Exception或者Throwab1.e,应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如:DAOException/ServiceException等。13 .【参考】对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常拗出：跨应用间RPC调用优先考虑使用Resu1.t方式，封装isSuccess（）方法、“错误码”、“错误简短信息”。说明：关于RPC方法返回方式使用Resu1.t方式的理由：1)使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。2

20、)如果不加栈信息，只是new自定义异常，加入自己的理解的errormessage,对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传揄的性能损耗也是问题。14 .【参考】避免出现重复的代码(DontRepeatYourse1.f),即DRY原则。说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。正例：一个类中有多个pub1.ic方法，都需要进行数行相同的参数校验操作，这个时候请抽取：privateboo1.eancheckParam(DTOdto)(.)(二)日

21、志规约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 .【强制】所有日志文件至少保存15天，因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操

22、作需要留存相关的网络日志不少于6个月。3 .【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式：appName_1.ogType_1.ogName.1.og。IogType:日志类型，如stats/monitor/access等；IogName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。土例：force-web应用中单独监控时区转换异常，如：force_web_timeZoneConvert.1.og4 .【强

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

24、是参数可能会进行字符串拼接运算。此外，如果debug(getName()这种参数内有getName()方法调用，无谓浪费方法调用的开销。正例：/如果判断为真，那么可以抢出IraCe和debug级别的日志if1.ogger.IsDebugEnab1.edO)1.ogger,debug(CurrentIDis：andnameis：(,id,getXame()；6 .【强制】避免重复打印日志，浪费磁盘空间，务必在1.og4j.xm1.中设置additivity=fa1.se工例：7 .【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。壬例:

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

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

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

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

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

30、 I）：Design,与设计文档相结合，来编写单元测试。 E：Error,强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。10 .【】对于数据库相关的查询，更新，弱除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业务插入规则，导致测试结果异常。11 .【】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。正例：在企业智能事业部的内部单

31、元测试中，使用ENTERPRISE_INTE1.1.IGENCE_07工侬匚的前缓来标识单元测试相关代码。12 .对于不可测的代码在适当的时机做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。防止SQ1.注入，禁止字符串拼接SQ1.访问数据库。13 【强制】用户请求传入的任何参数必须做有效性验证。说明：忽略参数校骁可能导致：pagesize过大导致内存溢出恶意Orderby导致数据库慢查询任意重定向SQ1.注入反序列化注入正则输入源串拒绝服务ReDoS说明：Java代码用正则来脸证客户端的揄入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符串

32、来验证，有可能导致死循环的结果。14 【强制】禁止向HTM1.页面输出未经安全过渡或未正确转义的用户数据。15 【强制】表单、AJAX提交必须执行CSRE安全验证。说明:CSRF（Cross-siterequestforgery）跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好UR1.,只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。16 【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。说明：如注册时发送骁证码到手机，如果没有限制

33、次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。17 【：发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。五、MySQ1.数据库（一）建表规约1 .【强制】表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsignedtinyint（1表示是，0表示否）。说叼：任何字段如果为非负数，必须是unsigned.（二）索引规约2 .【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非

34、常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。3 .【强制】超过三个表禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。说明：即使双表join也要注意表索引、SQ1.性能。4 .【强制】在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count（distinctIeft（列名，索引长度）count（*）的区分度来确定。5 .【强制】页面搜索严禁左模糊或

35、者全模糊，如果需要请走搜索引擎来解决。说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。6 .如果有Orderby的场景，请注意利用索引的有序性。Orderby最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现fi1.e-Sort的情况，影响查询性能。J例：Wherea=?andb=?orderbyc；索引:a_b_c反例:索引如果存在范围查询，那么索引有序性无法利用，如：WHEREa100RDERBYb；索引ab无法排序。7 .】利用覆盖索引来进行查询操作，避免回表。说明：如果一本书需要知道第11章是什么标题，会翻开第11章对应的那一页

36、吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用exp1.ain的结果,extra列会出现:usingindexo2 )对SerViCe层通用能力的下沉，如缓存方案、中间件通用处理。3)与DAO层交互，对多个D0的组合复用。DAO层:数据访问层，与底层MySQ1.,Orac1.e,Hbase等进行数据交互。外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接H。3 .【参考】(分层异常处理规约)在DAO层，产生的异常类型有很多，无法用细粒度的异常进行catch,使

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

38、息。开放接口层要将异常处理成错误码和错误信息方式返回。4 .【参考】分层领域模型规约：DO(DataObject)：此对象与数据库表结构对应，通过DAO层向上传输数据源对象。DTO(DataTransferObject)：数据传输对象，Service或Manager向外传输的对象。BO(BusinessObject)：业务对象，由Service层输出的封装业务逻辑的对象。AO(App1.icationObject)：应用对象，在Web层与SerViCe层之间抽象的复用对象模型，极为贴近展示层，复用度不高。VO(ViewObject)：显示层对象，通常是Web向模板渲染引擎层传输的对象。Quer

39、y：数据查询对象，各层接收上层的查询请求。注意超过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/jstor1

40、1-too1.3） Version：详细规定参考下方。2 .【强制】二方库版本号命名方式：主版本号.次版本号.修订号1）主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级。2）次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的AP1.不兼容修改。3）修订号：保持完全兼容性，修复BUG、新增次要功能特性等。说明：注意起始版本号必须为：1.0.0,而不是0.0.1,正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3,那么下一个合理的版本号：1.3.4或1.4.0或2.0.03 .【强制】线上应用不要依赖SNAPSHOT

41、版本（安全包除外）。说明：不依赖SNAPSHOT版本是保证应用发布的暴等性。另外，也可以加快编译时的打包构建。4 .【强制】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证。说明：在升级时，进行dependency：reso1.ve前后信息比对，如果仲裁结果完全不一致，那么通过dependency：tree命令，找出差异点，进行exc1.ude排除jar包。5 .【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。6 .【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免

42、版本号不一致。说明：依赖springframework-core,-context,-beans,它们都是同一个版本，可以定义一个变量来保存版本：$SPring.version）,定义依赖的时候，引用该版本。7 .【强制】禁止在子项目的pom依赖中出现相同的GroupId,相同的ArtifactId,但是不同的Version0说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war,只能有一个版本号出现在最后的Iib目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。1.1 ）底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。9 .所有pom文件中的依赖声

43、明放在dependencies语句块中，所有版本仲裁放在CdependencyManagement）语句块中。说明：VdependencyManagemenD里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version和scope都读取自父pom0而dependencies）所有声明在主pom的dependencies里的依赖都会自动引入，并默认被所有的子项目继承。10 .：二方库不要有配置项，最低限度不要再增加配置项。11 .【参考】为避免应用二方库的依籁冲突问题，二方库发布者应当遵循以下原则:1）精简可控原则，移除一切不必要的Ap1.和依赖，只包含ServiceAPI,必要的

44、领域模型对象、Uti1.s类、常量、枚举等。如果依赖其它二方库，尽量是provided引入，让二方库使用者去依赖具体版本号；无1.og具体实现，只依赖日志框架。2）稳定可追溯原则,每个版本的变化应该被记录，二方库由谁维护，源码在哪里,都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。（三）服务器1. 高并发服务器建议调小TCP怖议的time_wait超时时间。说明：操作系统默认240秒后，才会关闭处于time_wait状态的连接，在高并发访问下，服务器端会因为处于time_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。壬瓦：在IinUX服

45、务器上请通过变更etcsysct1.conf文件去修改该缺省值（秒）：net.ipv4.tcp_fin_timeout=302. 调大服务器所支持的最大文件句柄数（FiIeDescriptor,简写为fd）O说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd主流的IinUX服务器默认所支持最大fd数量为1024,当并发连接数很大时很容易因为fd不足而出现“opentoomanyfi1.es错误，导致新的连接无法建立。建议将IinUX服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。3. r1给JVM环境参数设置-XX：+HCaPDUmP

46、onOUtOMemoryError参数，让JVM碰到OOv场景时输出dump信息。说明：OOM的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。4. 】在线上生产环境，JVM的XmS和XmX设置一样大小的内存容量，避免在GC后调整堆大小带来的压力。5. 参考服务器内部重定向使用forward；外部重定向地址使用UR1.拼装工具类来生成，否则会带来UR1.维护不一致的问题和潜在的安全风险。七、设计规约1 .【强制】存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档。说明：有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数据迁移和系

47、统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地进行设计和评审，生产环境提交执行后，需要进行d。UbIeCheck。正低：评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如在原有表中新增字段）也需要进行评审通过后上线。2 .【强制】在需求分析阶段，如果与系统交互的User越过一类并且相关的UserCase超过5个，使用用例图来表达更加清晰的结构化需求。3 .【强制】如果某个业务对象的状态超过3个，使用状态图来表达并且明确状态变化的各个触发条件I）说明：状态图的核心是对象状杰，首先明确对象有多少种状态,然后明