12代码编写规范.docx

《12代码编写规范.docx》由会员分享，可在线阅读，更多相关《12代码编写规范.docx（41页珍藏版）》请在第一文库网上搜索。

1、深圳市区域全民健康信息平台基于平台综合管理应用代码编写规范创业慧康科技股份有限公司2023年03月目录第一章引言11.1 编写目的11.2 文档范围11.3 项目概要11.4 术语和缩写11.5 参考资料2第二章编程规约32.1 命名风格32.2 常量定义52.3 代码格式72.4 OOP规约82.5 集合处理132.6 并发处理152.7 控制语句162.8 注释规约172.9 其它19第三章异常日志213. 1异常处理213.2日志规约22第四章单元测试25第五章安全规约27第六章MySQ1数据库296.1 建表规约296.2 索引规约306.3 SQ1语句316.4 ORM映射326.5

2、 工程蹄347.1 应用分层347.2 二方库依赖347.3 服务器36第八章设计规约37第一章引言1.1 编写目的规范编码，有效节约开发工作量，减少成本和资源消耗，能够提升系统的稳定性和可扩展性，无规范、约束的开发，项目就无法做到统一标准，会使得程序变得难以阅读，无法实现高效的编码目的。1.2 文档范围传播范围项目相关的设计、开发、测试环节，以及本系统有往来关系的系统或机构。读者对象开发人员、测试人员、数据库工程师、设计人员13项目概要待开发系统（或软件）的名称深圳市区域全民健康信息平台基于平台综合管理应用本项目的任务提出者深圳市卫生健康发展研究和数据管理中心本项目的开发者创业慧康科技股份有

3、限公司本项目的用户相关业务科室或者相关业务人员与其他系统或其他机构的基本的相互来往关系基于万达信息股份有限公司的基础平台项目，是依赖于基础平台的数据的系统1.4 术语和缩写提示：列出本文件中用到的专门术语的定义和外文首字母组词的原词组。NO术语分类名称术语英文全称术语英文缩号1通用术语DomainGroupDG2通用术语娥DomainDO3通用术语璇FunctionFU4通用术语功能块FunctionB1ockB15通用术语元素E1ementE16通用术语事件EventEV7通用术语雌ActionACT8通用术语数据对象DataObjectOB9通用术语数据元DataE1ementDE10通用

4、术语螃ServiceSV11通用术语Tab1eTB112通用术语数据字段Fie1dF1D13通用术语消息MessageMSG14通用术语规则Ru1eRU15通用术语门户Porta1PO16通用术语犍MenuMU17通用术语模板Temp1ateTP115参考资料序号文档名称版本/日期备注1阿里巴巴java开发手册V1.5.0华山版2Java编程规范中国电力出版社出版第二章编程规约2.1命名风格1 .【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反例：_name/_name/$name/name_/name$/name_2 .【强制】类名使用UPPerCame1C

5、aSe风格，但以下情形例外：DO/BO/DTO/VOA0/PO/UID等。正例：JavaserverIessPIatform/UserDO/XmIService/TcpUdpDeaI/TaPromotion反例：javaserver1essp1atform/UserDo/XM1Service/TCPUDPDeaI/TAPromotion3 .【强制】方法名、参数名、成员变量、局部变量都统一使用IowerCameICase风格，必须遵从驼峰形式。正例：IocaIVaIue/getHttpMessage()/InputUserId4 .【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整

6、清楚,不要嫌名字长。正例：MAX_STOCK_COUNT/CACHE_EXPIRED_TIME反例：MAXj：0UNT/EXPIREDjriME5 .【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以TeSt结尾。6 .【强制】类型与中括号紧挨相连来表示数组。正例：定义整形数组intarayDemo;反例：在main参数中，使用StringargS口来定义。7 .【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。正例：应用工具类

7、包名为com.bsoft.ish.UtiK类名为MessageUtiIs(此规则参考spring的框架结构)8 .【强制】杜绝完全不规范的缩写，避免望文不知义。反例：AbStraCtC1aSS缩写命名成AbSCIass；COndition缩写命名成Condi,此类随意缩写严重降低了代码的可阅读性。9 .【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。正例：在JDK中，表达原子更新的类名为：AtomicReferenceFieIdUpdatero反例：inta的随意命名方式。10 .【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度

8、。正例：StartTime/WorkQueue/name1ist/TERMINATED_THREAD_COUNT反例：StartedAt/QueueOfWork/IistName/COUNT_TERMINATED_THREAD11 .【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。正例：pub1icc1assOrderFactory;pub1icc1ass1oginProxy;pub1icc1assResourceObserver;12 .【推荐】接口类中的方法和属性不要加任何修饰符号(PUbIiC也不要

9、加)，保持代码的简洁性，并加上有效的JaVadOC注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。正例：接口方法签名voidcommit();接口基础常量StringCOMPANY=a1ibaba;反例：接口方法定义pub1icabstractvoidf();说明：JDK8中接口允许有默认实现，那么这个defau1t方法，是对所有实现类都有价值的默认实现。13 .接口和实现类的命名有两套规则：【强制】对于Service和DAO类，暴露出来的服务一定是接口，内部的实现类用ImP1的后缀与接口区别。正例：CacheServiceImpI实现Cac

10、heService接口。【推荐】如果是形容能力的接口名称，取对应的形容词为接口名(通常是一ab1e的形容词)。正例：AbstractTransIator实现Trans1atab1e接口。14 .【参考】枚举类名带上EnUm后缀，枚举成员名称需要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。正例：枚举名字为ProcessStatusEnum的成员名称：SUCCESS/UNKNOWN_REASONo15 .【参考】各层命名规约：A）Service/DAO层方法命名规约1）获取单个对象的方法用get做前缀。2）获取多个对象的方法用IiSt做前缀，

11、复数形式结尾如：IistObjectso3）获取统计值的方法用CoUnt做前缀。4）插入的方法用save/insert做前缀。5）删除的方法用remove/de1ete做前缀。6）修改的方法用UPdate做前缀。B）领域模型命名规约1）数据对象：XxxEntityxDO,XXX即为数据表名。2）数据传输对象：xxDTO,XXX为业务领域相关的名称。3）展示对象：xVO,XXX一般为网页名称。4）PoJo是DO/DTO/BO/VO的统称，禁止命名成XXXPOJ0。2. 2常量定义1 .【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。反例：Stringkey=1d#jieyi_+

12、trade1d;cache.put（key,va1ue）;缓存get时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题2 .【强制】在1ong或者1Ong赋值时，数值后使用大写的1,不要是小写的I,小写容易跟数字1混淆，造成误解说明：1Onga=21;写的是数字的21,还是1Ong型的2。3 .【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量,不利于理解和维护。正例：缓存相关常量放在类CaCheCOnStS下；系统配置相关常量放在类ConfigConsts下。4 .【推荐】常量的复用层次有五层：跨应用

13、共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1)跨应用共享常量：放置在二方库中，通常是C1ientJar中的COnStant目录下。2)应用内共享常量：放置在一方库中，通常是子模块中的constant目录下。反例：易懂变量也要统一定义成应用内共享常量，两位工程师在两个类中分别定义了“YES的变量：类A中：pub1icstaticfina1StringYES=yes;类B中：pub1icstaticfina1StringYES=y;A.YES.equa1s(B.YES),预期是true,但实际返回为fa1se,导致线上问题。3)子工程内部共享常量：即在当前子工程的CO

14、nStam目录下。4)包内共享常量：即在当前包下单独的COnStarIt目录下。5)类内共享常量:直接在类内部privatestaticfina1定义。5 .【推荐】如果变量值仅在一个固定范围内变化用enum类型来定义。说明：如果存在名称之外的延伸属性应使用enum类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。正例：pub1icenumSeasonEnumSPRING(I)zSMMER(2),ATMN(3)zWINTER；privateintseq;SeasonEnum(intseq)this.seq=seq;)pub1icintgetSeq()returnseq;)6 .3代码格式1 .【强制】如果是大括号内为空，则简洁地写成即可，大括号中间无需换行和空格；如果是非空代码块则：1)左大括号前不换行。2)左大括号后换行。3)右大括号前换行。4)右大括号后还有e1se等代码则不换行；表示终止的右大括号后必须换行。2 .【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第5条下方正例提示。反例：if(空格a=b空格)3 .【强制】if/for/whi1