02.Spotless代码格式化工具

Spotless代码格式化工具

1.为什么需要

在一些大型项目或开源项目，由于开发人员太多，导致各个代码格式不统一。会让整体项目的代码可读性变差，那么如何可以统一代码格式呢？

使用Spotless就可以完成

2.是什么

Spotless 是支持多种语言的代码格式化工具（自动或手动方式均可），支持 Maven 和 Gradle 以 Plugin 的形式构建。目前 github 已经有 4000+ 开源项目在使用 Spotless 进行格式化代码

3.github地址

https://github.com/diffplug/spotless/tree/main/plugin-maven

4.代码格式化方式

Spotless 提供了多种 Java 代码格式化方式，如 googleJavaFormat、eclipse、prettier 等

5.使用方式

1. Maven插件整合
2. Gradle插件整合

6.Maven整合Spotless

目标

自动为代码添加 licenseHeader 和格式化代码

步骤

1. 在父POM文件中引入插件依赖
2. 创建代码格式文件
3. 手动执行代码格式化
4. 将格式化绑定到 Maven 生命周期

在父POM文件中引入插件依赖

            <!-- spotless插件 -->
            <plugin>
                <groupId>com.diffplug.spotless</groupId>
                <artifactId>spotless-maven-plugin</artifactId>
                <version>2.22.1