【软件开发规范篇】JAVA后端开发编码格式规范

作者介绍：本人笔名姑苏老陈，从事JAVA开发工作十多年了，带过大学刚毕业的实习生，也带过技术团队。最近有个朋友的表弟，马上要大学毕业了，想从事JAVA开发工作，但不知道从何处入手。于是，产生了写一个博客专栏想法，介绍当前互联网企业JAVA项目开发如何快速入门。

本文收录于《30天企业JAVA项目开发实战入门》专栏，该专栏内容以当前互联网软件企业中的项目实战为线索，介绍企业JAVA项目开发中涉及到的开发流程、技术、工具、规范要求等等。帮助想从事JAVA开发的大学生或新人，更快的、更好的入门JAVA后端开发工作。

一、前言

现在的软件项目都是团队多人合作一起开发，软件架构的复杂性也需要协同开发完成，如何高效地协同呢？

无规矩不成方圆，无规范难以协同。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。

所以，本文介绍一下，JAVA后端开发编码格式规范，以及如何通过代码格式化插件Eclipse Code Formatte格式化代码。

当我们约定了代码的统一模板，使用了统一的编码格式。从而，可以避免不同开发人员使用不同的代码模板带来的编码格式差异化，提高代码的可读性，降低代码Merge时解决冲突问题所花费的成本。

二、代码格式规范

1. 【强制】如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块则：
   1） 左大括号前不换行。
   2） 左大括号后换行。
   3） 右大括号前换行。
   4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

2. 【强制】左小括号和右边相邻字符之间不出现空格；右小括号和左边相邻字符之间也不出现空格；而左大括号前需要加空格。详见第 5 条下方正例提示。

反例：if (空格 a == b 空格)

3. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。
   说明：包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5. 【强制】采用 4 个空格缩进，禁止使用 tab 字符。
   说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置tab 为 4 个空格时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。

正例： （涉及 1-5 点）
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello";
// 运算符的左右必须有一个空格
int flag = 0;
// 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
if (flag == 0) { System.out.println(say);
}

// 左大括号前加空格且不换行；左大括号后换行
if (flag == 1) { System.out.println("world");
// 右大括号前换行，右大括号后有 else，不用换行
} else {
System.out.println("ok");
// 在右大括号后直接结束，则必须换行
}
}

关于IDEA 设置tab 为 4 个空格时，请勿勾选 Use tab character。如下面所示：

6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。

正例：
// 这是示例注释，请注意在双斜线之后有一个空格
String commentString = new String();

7. 【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。

正例：
long first = 1000000000000L; int second = (int)first + 2;

8. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
   1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
   2） 运算符与下文一起换行。
   3） 方法调用的点符号与下文一起换行。
   4） 方法调用中的多个参数需要换行时，在逗号后进行。
   5） 在括号前不要换行，见反例。

正例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，换行缩进 4 个空格，并且方法前的点号一起换行
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...
.append("huang");

反例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，不要在括号前换行
sb.append("you").append("are")...append ("lucky");

// 参数很多的方法调用可能超过 120 个字符，逗号后才是换行处
method(args1, args2, args3, ...
, argsX);

9. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

正例：下例中实参的 args1，后边必须要有一个空格。
method(args1, args2, args3);

10. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。

IDE 的 text file encoding 设置为 UTF-8，如下图所示：

IDE 中文件的换行符使用 Unix 格式，如下图所示：

三、插件的安装和使用

下面介绍在开发工具IDEA中安装代码格式化插件Adapter for Eclipse Code Formatter；

首先，打开开发工具IDEA，通过菜单File>Settings，打开配置窗口。

之后，输入关键字plugins，找到插件安装界面。

之后，在应用市场Marketplace中，搜索要安装的插件名称Adapter for Eclipse Code Formatter；

之后，点击install开始安装；

安装完成后，最后，点击OK。

之后，下面开始导入代码模板文件。

首先，打开开发工具IDEA，通过菜单File>Settings，打开配置窗口；

之后，输入关键字Adapter for Eclipse Code Formatter，找到刚才安装的插件；

之后，选择“Use Eclipse`s code Fomatter”，并且点击上传代码格式模版文件，最后点击OK完成模板导入。

说明，这里推荐使用阿里巴巴的代码格式模版。如下，阿里代码格式模板文件已分享到百度网盘。

百度网盘分享链接：https://pan.baidu.com/s/1WeeN6I9_CUwneqrIbBHzyA?pwd=nyde
提取码：nyde

官方下载地址： https://github.com/alibaba/p3c/tree/master/p3c-formatter

最后，插件安装和配置完成后，打开任意的JAVA文件，可以使用快捷键Ctrl+Alt+L ，进行代码格式化操作。

四、总结

以上介绍了JAVA后端开发编码格式相关的规范，以及如何通过使用格式插件进行代码格式化操作。

附本文参考资料：

• 阿里云官方知乎：https://www.zhihu.com/org/a-li-yun-97-77
• 阿里云开发者官方社区：https://developer.aliyun.com/
• 阿里开发者官方CSDN社区：https://blog.csdn.net/alitech2017?type=blog
• 阿里云云栖号CSDN：https://blog.csdn.net/yunqiinsight/category_10231626.html
• 阿里巴巴技术团队发布的《JAVA开发手册》泰山版
• 阿里云开发者官方微信公众号

如果您对文章中内容有疑问，欢迎在评论区进行留言，我会尽量抽时间给您回复。如果文章对您有帮助，欢迎点赞、收藏。您的点赞，是对我最大的支持和鼓励，谢谢 :-）