关于后端:开发规范系列二Java后台开发规范

首发博客地址

https://blog.zysicyj.top/

前言

提到 Java 开发标准，那么大家能想到的根本就是 阿里巴巴 Java 开发手册，这个手册的内容很丰盛，然而呢篇幅太长，很多人都记不住，那么怎么办呢？好在阿里巴巴提供了代码扫描插件，不便咱们开发时发现问题并及时批改。

如何应用该插件？

参考这篇文章：【插件】Java 开发标准配套 Idea 阿里巴巴代码扫描

手册内容

{% pdf /static/pdf/Java 开发手册(黄山版).pdf %}

我的项目对立规约

• 工具类对立应用 Hutool，非必要不要自定义工具类
• controller 返回的每个实体须要新建一个 Vo 封装
• controller 承受的参数对立应用 Param 封装
• Do 类不容许增加额定字段
• 业务之间传输应用 Dto 类封装
• 跨模块，接口调用不容许间接传 DO，须要封装成 Dto
• 单机事务必须加上 @Transactional 注解
• 分布式事务必须加上 @Seata 注解
• 对立应用 Mybatis 语法，不要应用 JPA
• ID 对立应用 Leaf 雪花算法获取
• 参数传递应用 POJO 传递，尽量不要应用 Map
• 办法参数超出屏幕宽度（个别 3 到 5 个）封装成对象接管

• 办法命名规定

  • 删除：del*
  • 更新：update*
  • 增加：insert*
  • 单个查问：select*
  • 批量查问：list*
  • 分页：page*
  • 导出：export*
  • 导入：import*
  • 返回布尔值的办法：iz*
  • 校验：check*
  • 填充：fill*

• 类名命名规定

  • 拦截器：*Handler
  • 过滤器：*Filter
  • 枚举：*Enum
  • 常量：*Constant
  • 监听器：*Listener
  • 配置类：*Config

• 变量命名规定（全副驼峰）

  • 动态常量：大写，下划线分隔 例如: USER_NAME_GLOBAL
  • 部分常量：大写，下划线分隔 例如：USER_NAME
  • 全局变量：*Global 例如：userNameGlobal
  • List 类型：*List 例如：userList
  • Map 类型：*Map 例如：userByIdMap
  • Set 类型：*Set 例如：userSet
  • 示意数量：*Num 例如：userTotalNum
  • 示意判断：iz** 例如：izLeader

倡议阅读文章

如何应用校验

【hibernate validator】（二）申明和验证 Bean 束缚
【hibernate validator】（三）申明和验证办法束缚
【hibernate validator】（四）内插束缚谬误音讯
【hibernate validator】（五）分组束缚
【hibernate validator】（六）创立自定义束缚

开发标准

1. MySQL 开发标准
2. 后盾开发标准
3. 前端开发标准
4. 代码提交标准

本文由 mdnice 多平台公布