代码规范

代码生成

统一使用Bladex代码生成模板

文档

Yapi

中间件

• 文件存储: 使用Bladex策略配置
• 短信发送: sms4j
• 定时任务: xxl-job、
• 三方调用: Forest

依赖组件

阿里云私有仓库

注释规范

1. 类注释模板

/**
 * @author: xxx
 * @date: ${DATE}
 * @description: 类功能描述
 */ 

2. service、dao方法注释必须写上
3. 行内注释也需要注明

目录规范

1. 包规范

• 包命名：com.wit.业务

2. 模块分层

├──> API模块
├       ├ - api
├       ├  
├       ├ - dto 
├       ├       ├ - 业务模块1（DTO类）   
├       ├     
├       ├ - query 
├       ├       ├─────>业务模块1（查询入参以Query结尾） 
├       ├  
├       ├ - vo   
├               ├ -  业务模块1(类名以VO结尾)
├   
├   
├   
├   
├
├──> Service模块
├          ├ - common
├          ├ - domain
├          ├     | - 业务1 DO
├          ├ - controller
├          ├    | - 业务1 controller
├          ├    | - 业务2 controller
├          ├- logic
├               ├- 三方调用
├               ├- manage
├               ├- 模块1（sys、业务1、业务2）              
├               ├    ├- service
├               ├    ├      | - 业务领域 1 Service
├               ├    ├      | - 业务领域 2 Service
├               ├    ├- impl
├               ├    ├     | - 业务领域 1 ServiceImpl
├               ├    ├     | - 业务领域 2 ServiceImpl
├         ├- - dao
├         ├    | - 业务1 Mapper
├         ├    | - 业务2 Mapper             

代码规范

Java开发规范

补充

1. 分页方式改用pageHelper方式，避免用Ipage参数及返回对象
2. 参数校验、针对新增、编辑根据group校验
3. 提交之前阿里巴巴规约插件扫描。
4. 异常 统一异常编码
5. 日志

• 如果被访问频率不高，关键的节点（如调用第三方 api 前后）必须使用 log.info 在日志中输出入参、出参和调用的地址，方便直接通过日志进行排查。
• 如果被访问频率较高，关键的节点日志参考如下结构：

if (log. isDebugEnabled()) {
log.debug(…);
}

6. 拒绝一个方法几百行代码，必须要进行拆解封装。复杂逻辑能用设计模式最好。

基础框架Bladex

• 注意项：政务端多租户配置，底层过滤了基础表 -董仁亮
• 注意项：mapper中的插入，自动填充字段丢失 -吕群
• 注意项：xml中写关联表查询租户id字段条件注入问题

质量要求

交付指标

1. 需求完整性
2. 功能通畅性
3. 数据准确性
4. UI 一致性

性能指标

1. 驾驶舱接口返回 1s 以内
2. 业务系统接口返回 2s 以内
3. 报表等业务接口返回 3s 以内