智慧气象编码规范.docx

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：专有名词解释58for(inti0；i10；i+)/在同一方法体中，不允许与其它代码块中的money命名相同

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

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

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

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

6、 获取单个对象的方法用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 .【强制】不允许任何魔法值（即未经

7、预先定义的常量）直接出现在代码中。反例：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 .【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类CacheCons

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

9、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)；privatei

10、ntseq；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/switch/do等

11、保留字与括号之间都必须加空格。4 .【强制】任何二目、三目运算符的左右两边都需要加一个空格。说吃：运算符包括赋值运算符=、逻辑运算符&、加渡乘除符号等。7 .不要在视图模板中加入任何复杂的逻辑。说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。8 .:任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。9 .及时清理不再使用的代码段或配置信息。说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度腌肿，代码冗余。正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(/)来说明注释掉代码的理由。二、异常日志(一)异常处理1

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

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

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

15、注意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；一连串调用，易产生NPEo王例：使用JDK8的OPtiona1.类来防止NPE问

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

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

18、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 .【强制】所有日志文件至少保存15天，因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统

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

20、nvert.1.og4 .【强制】在日志输出时，字符串变量之间的拼接使用占位符的方式。说明：因为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.ogba

21、ck),就直接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 .【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键

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

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

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

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

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

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

28、正例：在企业智能事业部的内部单元测试中，使用ENTERPRISE_INTE1.1.IGENCE_07工侬匚的前缓来标识单元测试相关代码。12 .对于不可测的代码在适当的时机做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。13 .在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例。14 .单元测试作为一种质量保障手段，在项目提测前完成单元测试，不建议项目发布后补充单元测试用例。15 .【参考】为了更方便地进行单元测试，业务代码应避免以下情况： 构造方法中做的事情过多。 存在过多的全局变量和静态方法。 存在过多的外部依赖。 存在过多的条

29、件语句。说明：多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。16.【参考】不要对单元测试存在如下误解： 那是测试同学干的事情。本文是开发手册，凡是本文内容都是与开发同学强相关的。 单元测试代码是多余的。系统的整体功能与各单元部件的测试正常与否是强相关的。 单元测试代码不需要维护。一年半载后，那么单元测试几乎处于废弃状态。 单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。四、安全规约1 .【强制】隶属于用户个人的页面或者功能必须进行权限控制校险。说明：防止没有做水平权限校脸就可随意访问、修改、删除别人的数据，比如查看他人的私信内容、修改他人的订单。2 .【强制

30、用户敏感数据禁止直接展示，必须对展示数据进行脱敏。说明：中国大陆个人手机号码显示为：137*0969,隐藏中间4位，防止隐私泄露。3 .【强制】用户检入的SQ1.参数严格使用参数绑定或者METADATA字段值限定，防止SQ1.注入，禁止字符串拼接SQ1.访问数据库。4 .【强制】用户请求传入的任何参数必须做有效性验证。说明：忽略参数校骁可能导致：pagesize过大导致内存溢出恶意Orderby导致数据库慢查询任意重定向SQ1.注入反序列化注入正则输入源串拒绝服务ReDoS说明：Java代码用正则来脸证客户端的揄入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符

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

32、制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。8 .【：发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。五、MySQ1.数据库（一）建表规约1 .【强制】表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsignedtinyint（1表示是，0表示否）。说叼：任何字段如果为非负数，必须是unsigned.注意：POJO类中的任何布尔类型的变量，都不要加is前缀，所以，需要在设置从is_xxx到Xxx的映射关系。数据库表示是与否的值，使用tinyint类型，坚持is_xxx的命名方式是为了明确其取值含义与取值范围

33、王例：表达逻辑删除的字段名is_de1.eted,1表示删除，0表示未删除。2 .【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称霜要慎重考虑。说明：MySQ1.在Windows下不区分大小写，但在1.inUX下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。正例：a1.iyunadmin,rdcconfig,Ieve13nameV,例：A1.iyunAdmin,rdcConfig,1.eve1._3_name3 .【强制】表名不使用复数名词。说明：

34、表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于Do类名也是单数形式，符合表达习惯。4 .【强制】禁用保留字，如desc、range、match、de1.ayed等，请参考MySQ1.官方保留字。5 .【强制】主键索引名为pk字段名；唯一索引名为Uk字段名；普通索引名则为idx_字段名。说明：pk_即primarykey；uk_即uniquekey；idx_即index的简称。6 .【强制】小数类型为decima1.,禁止使用f1.oat和doub1.e,说明：在存储的时候，f1.oat和doub1.e都存在精度损失的问题，很可能在比较值的时候，得到不正确的结果。如果存储的数据范围

35、超过decima1.的范围，建议将数据拆成整数和小数并分开存储。7 .【强制】如果存储的字符串长度几乎相等，使用char定长字符串类型。8 .【强制】varchar是可变长字符串，不预先分配存储空间，长度不要超过5000,如果存储长度大于此值，定义字段类型为text,独立出来一张表，用主键来对应，避免影响其它字段索引效率。9 .【强制】表必备三字段：id,create_time,UPdate_time。说明：其中id必为主键，类型为bigintunsigned,单表时自增、步长为1。Createupdate,time的类型均为datetime类型。10 .】表的命名最好是遵循“业务名称一表的作

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

37、请不要在创建表时就分库分表。15 .【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。对象年龄区类型字节表示范围人150岁tinyint1无符号值：0到龟数百岁sma1.Iint2无符号值：0到恐龙数千万int4无符号值：0到约太阳约50bigint8无符号值：0到约合元素数量，控制在100O个之内。10 .【参考】如果有国际化需要，所有的字符存储与表示，均以utf-8编码，注意字符统计函数的区别。说明：SE1.ECT1.ENGTH（轻松工作”）；返回为12SE1.ECTaIARACTER.1.

38、ENGTH（轻松工作”）；返回为4如果需要存储表情，那么选择utf8mb4来进行存储，注意它与utf-8编码的区别。11 .（亨】TRUNCATETB1.E比DE1.ETE速度快，且使用的系统和事务日志资源少,但TRUNCATE无事务且不触发trigger,有可能造成事故，故不建议在开发代码中使用此语句。说用：TRUNCATETAB1.E在功能上与不带WHERE子句的DE1.ETE语句相同。（四）ORM映射1 .【强制】在表查询中，一律不要使用*作为查询的字段列表，需要哪些字段必须明确写明。说明：1）增加查询分析器解析成本。2）增减字段容易与resu1.tMap配置不一致。3）无用字段增加网络

39、消耗，尤其是text类型的字段。2 .【强制】POJO类的布尔属性不能加is,而数据库字段必须加is_,要求在resu1.tMap中进行字段与属性之间的映射。说明：参见定义POJO类以及数据库字段定义规定，在resuhMap中增加映射，是必须的。在MyBa1.iSGenerator生成的代码中，需要进行对应的修改。3 .【强制】不要用resu1.tc1.ass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个POJO类与之对应。说明：配置映射关系，使字段与DO类解耦，方便维护。4 .【强制】Sq1.Xm1.配置参数使用：#,Sparamtf不要使用S此种

40、方式容易出现SQ1.注入。【强制】iBATIS自带的queryFor1.ist（StringStatementName,intstart,iniSiZe）不推荐使用。说叫：其实现方式是在数据库取到StatementName对应的SQ1.语句的所有记录，再通过sub1.ist取start,size的子集合。正例:Mapmap=newHashMapOO；map.put（wstart,start）；map.put（size,size）；2 )对SerViCe层通用能力的下沉，如缓存方案、中间件通用处理。3)与DAO层交互，对多个D0的组合复用。DAO层:数据访问层，与底层MySQ1.,Orac1.e

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

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

43、p1.icationObject)：应用对象，在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或co

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

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

46、ude排除jar包。5 .【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。6 .【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。说明：依赖springframework-core,-context,-beans,它们都是同一个版本，可以定义一个变量来保存版本：$SPring.version）,定义依赖的时候，引用该版本。7 .【强制】禁止在子项目的pom依赖中出现相同的GroupId,相同的ArtifactId,但是不同的Version0说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war,只能有一个版本号出现在最后的Iib目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。1.1 ）底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。9 .所有pom文件中的依赖声明放在dependencies语句块中，所有版本仲裁放在CdependencyManagement）语句块中。说明：VdependencyMa