99数据治理平台_开发规范.docx

数据治理平台开发规范

版本：1.0

日期：2021-12-03

目录

TOC\o1-3\h\z\u

1、 编程规约 4

(一)命名风格 4

(二)常量定义 9

(三)代码格式 12

(四)OOP规约 19

(五)集合处理 27

(六)控制语句 37

2、 异常日志 41

(一)异常处理 41

(二)日志规约 51

3、 单元测试 53

4、 安全规约 56

5、 MySQL数据库 57

(一)建表规约 57

(二)SQL语句 59

(三)ORM映射 59

编程规约

命名风格

1.代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束

说明：代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束

反例：

_name/__name/$name/name_/name$/name__

2.代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。

正例：

alibaba/taobao/youku/hangzhou等国际通用的名称，可视同英文

反例：

DaZhePromotion[打折]/getPingfenByName()[评分]/int某变量=3

3.包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式

说明：在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。即使有多个单词也不使用下划线或大小写分隔

正例：

应用工具类包名为com.hginfo.ai.util、类名为MessageUtils(此规则参考spring的框架结构）

com.hginfo.产品名.模块名称

com.hginfo.部门名称.项目名称

反例：

com.vip.java_tool,com.vip.javaTool

4.类名使用UpperCamelCase风格，遵从驼峰形式说

说明：

类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。

现在还没有特定的规则或行之有效的约定来命名注解类型。

测试类的命名以它要测试的类的名称开始，以Test结束。

Tcp,Xml等缩写也遵循驼峰形式，但以下情形例外：DO/BO/DTO/VO/AO/PO/UID等

正例：

MarcoPolo/UserDO/XmlService/TcpUdpDeal/TaPromotion

UserId/XmlService/TcpUdpDeal/UserVO

HashTest或HashIntegrationTest

反例：

macroPolo/UserDo/XMLService/TCPUDPDeal/TAPromotion

UserID/XMLService/TCPUDPDeal/UserVo

5.方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式

说明：

正例：

localValue/getHttpMessage()/inputUserIdprivatevoidcalculateRate();publicvoidaddNewOrder();

6.常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长

说明：例外：当一个staticfinal字段不是一个真正常量，比如不是基本类型时，不需要使用大写命名

正例：

MAX_STOCK_COUNTpublicfinalstaticintMAX_VALUE=1000;publicfinalstaticStringDEFAULT_START_DATE=2001-12-08;privatestaticfinalLoggerlogger=Logger.getLogger(MyClass.class);

反例：

MAX_COUNTpublicfinalstaticintmax_value=1000;

7.枚举类名以Enum结尾;抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾

说明：

正例：

DealStatusEnum，AbstractView