Java 后端工程规范

后端工程规范

• 规范的意义和作用

1. 编码规范可以最大限度的提高团队开发的合作效率
2. 编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
3. 编码规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码
4. 规范性编码还可以让开发人员养成好的编码习惯，甚至锻炼出更加严谨的思维

• 开发环境规范

1. 开发环境

JDK 统一使用 1.8版本

1. 开发工具

IntelliJ IDEA 2019.3.5 +（安装Lombok Plugin），不使用IDEA2020.1版本（此版本不稳定），如需使用新特性请使用2020.3更高版本2021.1。推荐使用2019.3.5版本，可以兼容现有很多插件版本，版本升级后可能一些插件暂未支持。

1. 构建工具

使用Maven来构建项目，版本使用3.6.3 + ，配置公司私服地址

1. 代码管理工具

Git，详细部分请查看代码提交规范文档

• 项目结构规范

1. 项目命名规范

工程名全部为小写字母，尽量为单个单词，不能使用缩写，不能使用拼音
例如，统一数据服务 data-service

Maven POM坐标如下，版本号x.x.x，依据实际来，尽量不带后缀-SNAPSHOT

    org.apache.poi
    poi-