# 编码好习惯

  1. 注释尽可能全面,写有意义的注释

  2. 项目拆分合理的目录结构

  3. 不在循环里操作数据库,优先批量操作

  4. 封装通用模板

  5. 封装复杂的逻辑判断条件

  6. 保持优化性能的嗅觉

  7. 可变参数配置化处理,不要写死在代码(配置中心或者配置表)

  8. 总结并使用工具类

  9. 控制方法函数的复杂度,抽象

  10. 把日志打印好

# 命名规范

含义描述 命名规范实例
post body 请求参数 XxRequest
展示层,前端展示 XxVO
数据传输对象 XxDTO
ES实体命名 XxIndexDO
DB实体命名,DO,PO Xx,和数据库表名一致
Mongo命名 XxDoc
DB组合关联实体命名 Xx
service接口命名 XxService
service实现命名 XxServiceImpl
manager,service引入多个manager XxManager
封装持久化组合服务(一个实体需要从DB,ES,Redis等多种存储获取) XxRepository