在软件开发领域，代码是程序的基础，也是程序员交流的常用语言。Java 作为广泛应用于企业级应用的编程语言，其代码的可读性与一致性对项目的长期维护和团队协作意义重大。本文将引领你探寻 Java 代码的美学，展现那些能让你的代码既美观又高效的样式规范。初出茅庐的新手能从中获得灵感，提升编码的艺术。经验丰富的老手也能从中获得灵感，提升编码的艺术。

一、为什么要代码样式规范

对于团队开发来说，不同的代码规范或者不规范可能会引发一些问题，这些问题包含但不限于：

1.代码可读性，代码是为了人阅读的，不是只为了机器执行；

2.代码引发的大量的diff，干扰code ；

3.间接影响代码质量和团队协作效率；

在敏捷迭代的软件开发环境里，良好的代码规范有诸多作用。它可以帮助团队成员迅速理解彼此的代码，从而减少沟通成本。同时，在进行代码维护和扩展时，还能节省宝贵的时间。另外，一致的代码风格也是项目专业性的一种体现，能够给代码审查者以及未来的维护者留下良好的第一印象。

二、探索Java代码规范

我们会深入去探讨被 Java 社区广泛认可的编码规范。这些规范包含 Java Style 以及官方的编码指南等。从命名方面的约定，到代码的格式化，还有注释的使用情况，以及错误处理和测试代码的编写等，每一个细节都对构建高质量的 Java 代码起着关键作用。

业界关于 Java 代码的样式规范是 Java Style 。

在上维护的多种编程语言的代码规范：

，其中：

.html 完整地定义了 Java 编程语言代码的编码标准；

•

-java--style.xml 为 Java 代码规范方面的文件，它适用于 IDEA 这一开发工具。

b. 阿里Java规范

阿里在 上有一个关于 Java 开发规范的仓库 p3c：

，其中：

Java 开发手册（黄山版）.pdf 涵盖了编程规约这一维度；Java 开发手册（黄山版）.pdf 涵盖了异常日志这一维度；Java 开发手册（黄山版）.pdf 涵盖了单元测试这一维度；Java 开发手册（黄山版）.pdf 涵盖了其他维度，共七个维度。

Java 插件市场所提供的代码指导插件，其中 idea 能够提供编译方面的指导、安装的指导以及使用手册。

c. 其它规范

[]

Style Guide

Sun/

The Sun Java Style Guide

Open (AOSP) Style Guide

’s Java Style Guide

The Style Guide

2.2 规范选择与制定a. 规范选择

3. 团队的开发习惯。

明确目标：使用代码规范的目的，是为了使项目内的代码风格保持一致呢，还是为了与其他团队进行分享，亦或是为了与其他公司分享，亦或是为了进行开源呢？

•使用环境：开发阅读代码的环境是什么，、、公司内部的？

工具支持方面，有 code 工具的支持情况，还有 code style check 工具的支持情况。编译工具包括 maven 等，IDE 有多种，如 VS Code 等。

综合上面的三个方面的考虑，优先选择 Java Style。

b. 规范制定

Java Style 的部分代码样式团队难以接受，例如采用 2 空格进行缩进等情况。可以在原本的 Java Style 之上，进行适当的定制化调整。

•修改

-java--style.xml中的内容：

value

value

note

行缩进空格数

TAB空格数

SIZE

换行缩进空格数

100

120

单行长度

DS

无

TRUE

中，保留手动的换行

无

TRUE

Java代码中，保留手动的换行

•修改

-java-jd-style.xml文件下载：

2.3 规范使用

代码样式规范的使用分为两个方面：

•代码格式化

•代码样式校验

规范使用

英文

使用对象

使用方式

说明

配置文件

代码格式化

code style

开发者

IDE手动

定义代码风格

-java-jd-style.xml

代码样式校验

check style

团队

自动化

校验代码风格

.xml

注意：code style 的“配置文件”与 check style 的“配置文件”必须相互对应，也就是说，依据 code style 的代码，check style 不能出现报错情况。

代码样式校验

代码格式化需要开发者手动进行。为了让团队或项目的代码样式规范得以落实，就需要有全面且自动化的代码检查。按照当前业界的推荐，要采用某种工具作为自动化代码样式的校验工具。

需要对原始 Code Style 的进行定制，以适配上面

-java-jd-style.xml的定制。

•修改中的内容：

value

value

note

max

100

120

单行长度

ion

2 2 2 4 4 2

4 0 4 4 4 4

使用默认缩进风格

•修改.xml文件下载：

除了有上述的长度方面的代码样式校验以及缩进方面的代码样式校验之外，还能够配置其他类型的代码校验，并且可以依据团队的接受情况来进行相应的配置。

value

note

max

2000

单个文件长度

max

150

单个方法长度

max

方法的参数个数

Java语言规范

max

检查if-else嵌套层数

max

检查try-catch-嵌套层数

max

一个方法最多有的数量

max

10

方法圈复杂度

检查魔法数字intellij idea java，未被定义为常量的数值

...

a. 在 IDEA 中进行 code style 配置

在 IDEA下，使用

在对-java-jd-style.xml进行代码格式化之前，必须先进行相关配置。

设置配置文件，其路径为 IDEA 到 Code Style 。可以参考下图。

导入定制的code style文件：

-java-jd-style.xml

命名，如图中JD-Style，并启用该代码样式规范

b. IDEA使用code style

完成上述配置后，在 Mac 环境的 IDEA 里，能够对选中的代码进行格式化，其快捷键是“++L”；也能够对选中的文件进行格式化，快捷键是“Shift+++L”

3.2 check style配置&使用

check style的配置和使用有两种主要方式：

开发者在开发环境 IDE 中配置插件后，能够触发代码样式规范的检查，然后依据提示项来进行代码修改。

在 maven 项目里，要进行插件的配置，这样就能通过命令行来触发对代码样式规范的检查，并且可以将其集成到 CI（持续集成）的自动化流水线当中。

a. IDEA配置插件

在 IDEA下，安装，路径： IDEA→→，参考下图：

下载配置文件.xml，然后配置 IDEA 插件。路径为：IDEA→→Tools→。接着增加自定义配置文件并进行命名，可参考下图。

b. IDEA使用插件

安装并配置插件之后，工具窗口新增了一个 Tab。在这个窗口进行检查时，可以进行如下选择：

•Check File

•Check

•Check

c. maven配置插件

参考 maven 插件的官方配置案例，对于多模块项目的配置来说，通常我们会在项目中新建一个 build-tools 模块，然后把.xml 等配置文件放置在这个模块的目录之下。

project-name
| -- pom.xml
| -- build-tools
| | -- pom.xml
| | -- src
| | | -- main
| | | -- resources
| | | -- checkstyle.xml
检查样式抑制文件为 checkstyle-suppressions.xml 。
| -- core
| -- gui
| -- other-module

build-tools 模块的 pom.xml 采用的是 IDEA 自动生成的配置文件，具体情况如下：

    
        project-name
        com.jd.project-name
        1.0.0
    
    4.0.0
    build-tools

配置文件.xml、

-.xml可以从中下载

。

父项目的pom.xml中，增加如下配置：

    ...
    
        ...
        build-tools
    
    
        ...
        3.6.0
    
    
        
            
                
                    
                    org.apache.maven.plugins
                    maven-checkstyle-plugin
                    ${maven.checkstyle.version}
                    
                        build-tools 目录下的 main 资源文件夹中的 checkstyle.xml 文件
                        true
                        checkstyle-report.xml
                        false
                        true
                        target/**
                    
                    
                        
                            checkstyle
                            validate
                            
                                check
                            
                        
                    
                
            
        
        
            
                org.apache.maven.plugins
                maven-checkstyle-plugin
            
        
    
    
        
            
                org.apache.maven.plugins
                maven-checkstyle-plugin
                
                    
                        
                            checkstyle
                        
                    
                
            
        
    

maven--的配置参数具体可参见:check的参数说明。

这里对几项配置进行说明：

•>>>

id可以自行决定，这里选择""；

phase 绑定到 maven 的哪个执行阶段呢？这里绑定到了某个特定的阶段上，这意味着在执行 maven 时会执行该任务。选择阶段能够保障：check 会在代码编译之前执行，倘若检查出违反样式规范的问题，那么在代码编译之前就会将其报告出来。

goal 是用于绑定执行的具体任务的，这里绑定的任务是“check”。

•>>>

检查到违反样式规范的问题后，会将其打印出来intellij idea java，打印出的问题级别是依据.xml 中进行配置所确定的。

将级别配置为 error，并且将其设为 true。当检查到违反样式规范的问题时，maven 命令会停止继续执行。

注意配置项的区别，一旦检查到问题就立即停止执行，并且在检查到问题时输出检查日志后再停止执行。

按照上述配置，能够在 mvn 编译代码之前强制进行代码样式规范的检查。如果发现违反规范的问题，就不会继续进行 java 的编译和打包。

d. maven使用插件

运行mvn 即可正常打包。

也可以单独执行命令：

mvn checkstyle:check

可以为项目配置行云流水线任务，以实现自动化代码样式规范检查。同时，要设置代码评审的自动化检查，指定某条流水线作为卡点，只有当指定为卡点的流水线运行成功后，MR 才允许合并。

四、结语：代码规范-团队协作的桥梁

我们首先总结下 Java 样式规范对于团队协作的重要性。接着鼓励每位开发者把这些规范内化为自己的编码习惯。因为代码规范既体现个人技艺，又是团队协作和项目成功的基石。

阅读本文后，你会了解到 Java 样式规范的重要性，也能掌握将这些规范应用到实际开发中的方法，使你的代码更加优雅且强大。让我们一同追求编码的艺术，用规范的代码照亮编程的世界。

参考

•京东JAVA代码规范-V1.0.pdf

•JD编码规范：

代码规范/Java/ 这个部分主要涉及到 Java 语言的代码编写规范相关内容，包括命名规范、代码结构规范、注释规范等等。它对于编写高质量、易维护的 Java 代码具有重要的指导意义。通过遵循这些规范，可以使代码更加清晰、可读、易于理解和调试，提高代码的可维护性和可扩展性。

• Java code style:

•官网：

•发布：

• Maven :

如有侵权请联系删除！