智慧气象编码规范.docx

智慧气象编码规范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；i<10；i+)/在同一方法体中，不允许与其它代码块中的money命名相同fina1.intmoney615：/.c1.assSonextendsConfusingName/不允许与父类的成员变量名称相同pub!icintage：11 .【强制】杜绝完全不规范的维写，避免望文不知义。反例：AbStraetC1.ass"缩写"命名成AbsC1.ass：condition"缗写"命名成condi,此类随意缩写严重降低了代码的可阅读性。12 .为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。正例:在JDK中，表达原子更新的类名为：AtomicKeferenceFie1.dUpdatero一例:inta的随意命名方式。13 .【在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。正例：StartTime/WOrkQUeUe/name1.ist/TERMINATED_TIIREAD_COUNT反例：StartedAt/QueucOWork/IistName/COUNTTERMINATEDTHREAD14 .如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念IE例：pub1.icc1.assOrderFactory;pub1.icc1.ass1.oginProxy;pub1.icc1.assKesourceObserver;15 .接口类中的方法和属性不要加任何修饰符号(PUbIiC也不要加)，保持代码的简洁性，并加上有效的JaVadoC注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础富量。-E例：接口方法签名voidcommit()；接口基础常量StringCoMPANY="a1.ibaba"；反例:接口方法定义pub1.icabstractvoidfO；说明：JDK8中接口允许有默认实现，那么这个defau1.t方法，是对所有实现类都有价值的默认实现。16 .接口和实现类的命名有两套规则：1)【强制】对于Service和DAo类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用ImP1.的后缀与接口区别。正例:CacheServiceimp1.实现CaCheSerViCe接口。2) 如果是形容能力的接口名称，取对应的形容词为接口名(通常是-ab1.e的形容词)。正例：AbStraCtTranSIatOr实现Trans1.atab1.e接口。17 .【叁考】枚举类名带上Enum后缀，枚举成员名称需要全大写，单词问用下划线隔开。说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被.默认强制是私有。正例：枚举名字为ProcessStatusEnum的成员名称:SUCCESS/UNKNOWN.REASoN/18 .【参考】各层命名规约：SerViCe/DAO层方法命名规约1) 获取单个对象的方法用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 .【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。反例：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下：系统配置相关常量放在类ConfigConstsT04 .【推荐】常量的熨用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1）跨应用共享常量：放置在二方库中，通常是c1.ient,jar中的constant目录下。2）应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“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类型来定义。说明：如果存在名称之外的延伸属性应使用enum类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。正例：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 .【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第5条下方正例提示。反例：if(空格a=b空格)3 .【强制】if/for/whi1.e/switch/do等保留字与括号之间都必须加空格。4 .【强制】任何二目、三目运算符的左右两边都需要加一个空格。说吃：运算符包括赋值运算符=、逻辑运算符&&、加渡乘除符号等。7 .不要在视图模板中加入任何复杂的逻辑。说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。8 .:任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。9 .及时清理不再使用的代码段或配置信息。说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度腌肿，代码冗余。正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(/)来说明注释掉代码的理由。二、异常日志(一)异常处理1 .【强制】JaVa类库中定义的可以通过预检查方式规避的RuntimeException异常不应该通过CatCh的方式来处理，比如：NU1.1.POinterEXCeP1.iOn,IndexOutOfBoundsException等等。说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过catchNuinberFormatException来实现。正例:if(obj!=nu1.1.).反例：tryIobj.method()；catch(Nu1.IPoiDterExcep1.ione),!,2 .【强制】异常不要用来做流程控制，条件控制。说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。3 .【强制】Ca1.Ch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的Cateh尽可能进行区分异常类型，再做对应的异常处理。说明：对大段代码进行try-catch,使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程说明:通过反射机制来调用方法，如果找不到方法，抛出NosuchMethodExceptiono什么情况会抛出NoSuchMethodError呢？二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配，或者在字节码修改框架（比如：ASM）动态创建或修改类时，修改了相应的方法签名。这些情况，即使代码编译期是正确的，但在代码运行期时，会抛出NoSuchMethodError（10 .【方法的返回值可以为nu1.1.,不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回nu1.1.值。说明：本手册明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回nu1.1.的情况。11 .【1防止NPE,是程序员的基本修养，注意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问题。12 .定义时区分UnCheCked/checked异常，避免直接抛出newRuntimeExceptionO.更不允许抛出Exception或者Throwab1.e,应使