系统开发规约

1. 实体类命名规范
   1>【强制】数据库表名命名
   说明：数据库表名需见名知意，多单词间用下划线隔开，同模块表名务必统一前缀。索引表统一以模块名_业务表名_idx，若是操作日志表，统一以xxx__operation_log结尾；

   正例：ord_main（订单域：订单主表）、gds_sku_info（商品域：店铺SKU明细表）

   反例：shop_sku_info、shop_ord_main
   
   2>【强制】实体名命名

   说明：实体名称，由mybatis-plus逆向工程基于表名自动生成。
   
   3>【强制】实体CRUD接口名命名

   说明：I...Service、...ServiceImpl表示当前实体类所映射的表的CRUD接口以及实现，该接口以及实现类由mybatis-plus逆向工程自动生成。

   正例：IOrdMainService、OrdMainServiceImpl
   
   4>【强制】RPC接口入参名命名

   说明：RPC接口入参名，通常为model_name+reqDTO，务必遵循驼峰命名规则；

   正例：OrdMainReqDTO、GdsSkuInfoReqDTO
   
   5>【强制】RPC接口返回值命名

   说明：RPC接口返回对象名，通常为model_name+respDTO，务必遵循驼峰命名规则；

   正例：OrdMainRespDTO、GdsSkuInfoRespDTO
   
   6>【强制】RPC接口命名

   说明：IRSV表示RPC客户端接口类名，通常为I+业务模块+RSV，..RSVImpl表示RPC接口实现类名，务必遵循驼峰命名规范；

   正例：IOrdMainRSV、OrdMainRSVImpl（表示与订单主表相关的接口与实现类）
   
   7>【强制】控制器方法入参命名

   说明：控制器方法入参对象名通常为model_name+VO，务必遵循驼峰命名规则；

   正例：OrdMainDTO、GdsSkuInfoDTO
   
   8>【强制】控制器方法出参命名

   说明：控制器方法出参返回值统一为com.chit.core.base.entity.BaseResponse，该返回值中data表示数据源，code表示异常码，msg表示异常信息。
   
   9>【强制】控制器类命名规范

   说明：控制器类命名规范为：业务模块名+Controller。同一业务领域的控制器方法建议统一规整到同一个控制器类中，另外针对控制器类的请求路径也需规范定义，尽量用一到两个单词阐述清楚该控制器下的业务，建议与控制器类名前缀保持一致，务必遵循驼峰命名；

   正例：CloudRebateController 、value = "/cloudRebate"
   
   10>【强制】常量类命名规范

   1. 业务表字段常量类：模块名+Constants

   说明：此常量类主要是定义业务表字段的常量类，在该常量类里通常会以表为维度（一张表一个静态类）对各表的字段值加以标识并说明。

   正例：

   public class GoodsConstants {

    

   //gds_sku_info表相关字段常量

   public static final class GDS_SKU_INFO {

    

   //商品待上架

   public static final String GDS_STATUS_WAITSHELVES = "0";

   }
   
   11>【强制】属性命名规范

   说明：属性值命名需遵循小驼峰命名规范，要尽量简单明了，避免相似或只在大小写上有区别，例如：flag和Flag。
   
   12>【强制】ServiceImpl类上需加@Service注解，注意是springframwork包下的；
   13>【强制】RPC接口的实现类RSVImpl上需加@DubboService注解；
   
   14>【强制】异常日志输出需要在类上加@Slf4j注解
   15>【强制】如需使用Spring的声明式事务，请在方法体上加@Transactional(rollbackFor = Exception.class)注解。

   说明：如果方法体使用了生命式事务，手动catch异常后务必外抛，以免引发事务回滚异常；
   16>【强制】如果当前控制器方法全为post请求，类上用@RestController注解；

   
   
   12>【强制】RSV方法名命名规范

   1. 获取单个对象的方法用 get 做前缀；

   2. 获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects；

   3. 获取多个对象且分页用list做前缀，用page做结尾；

   4. 获取统计值的方法用 count 做前缀；

   5. 插入的方法用 save/insert 做前缀；

   6. 删除的方法用 remove 做前缀；

   7. 修改的方法用 update 做前缀