编码规范

供数规范

• 联机可以使用 MQ 和其他系统供数；
• 批量交易使用文件形式供数。

命名规范

• 类名采用大驼峰命名法，变量采用小驼峰命名法；
• list 里面的数组类命名：<xxxRow>Array，例如: List<CifContactRow> contactArray
• api 命名要求：I+模块名+业务，例如：IRbAcct
• api url 命名要求：url 的字母全是小写，模块名/业务/动作，例如：rb/password/opearte
• sequence 命名要求：模块+.+功能缩写，小写驼峰，例如：交易流水，rb.tranHist
• daoSupport 要求：在调用 daoSupport(insert,update,select,delete) 时，组织 Po 对象要考虑是否分库操作，而决定是否需要赋值分库键；例如：查询分户信息 需要分库查询，rbAcct.setClientNo("123"); daoSupport.selectOne(rbAcct);

注释规范

方法注释模板

注意

IDEA 定义方法注释模板时，开头一定不能加 / 字符

在 Settings --> Editor --> Live Templates 中定义方法注释模板：

*  
* @Author $user$  
* @Description //TODO $end$  
* @Date $date$ $time$  
* @Param $param$  
* @return $return$  
**/

---

变量定义

Edit template	Variables
NAME	Expression
date	date()
time
param	methodParameters()
return	methodReturnType()

类注释模板

配置说明

在 Settings --> Editor --> File and Code Templates 中定义类注释模板：

/**
@ClassName ${NAME}
@Author ${USER}
@Date ${DATE} ${TIME}
@Description TODO
@Version 1.0
**/

错误码

详见错误码使用说明。

异常处理

详见异常处理使用说明。

日志

提示

如果需要输出日志，在类上面加注解 @Slf4j，使用 log.info() 等方法。

@Slf4j
public class CifContactComponent implements IBusinessComponent {
}

git 提交注释格式

格式

fix: 存款 #1 修改简述

修改详情

影响范围

Component 使用规范

• component 统一实现 com.dcits.comet.commons.business.IBusinessComponent 接口
• component 的入参统一使用 final 修饰
• component 的入参统一继承 com.dcits.ensemble.cloud.rb.service.bc.model.RbBaseModel
• component 使用过程中 涉及 Base 账户信息和客户信息 统一从模型中直接获取，无特殊要求 不要在进行账户和客户信息查询

注意事项

• 所有的 PO 和 mapper.xml (不是 _ext.xml)都不可以修改；因是自动生成的，随时会被覆盖；
• unit 不能注入 component；如果有这种情况，代表 component 有方法需要挪到 unit 中；
• 所有不带分片键的查询，都必须经过组长或架构师的同意。

IDEA 开发所需

• 安装代码扫描规范插件 Alibaba Java Coding Guidelines，实施扫描代码，形成良好代码风格
• 安装 lombok 插件 Lombok plugin，以方便使用 lombok 的注解
• 安装 testME 插件，BC 层的每个方法都必须写单元测试