首发博客地址

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多平台公布