Maven-Java代码格式化插件spring-javaformat

官方文档：点击进入

前言

• 项目研发过程中，随着团队人员的增加变更环境配置的不同，有些同学甚至没有格式化代码的习惯，导致编码风格不统一杂乱无章，为解决这一问题引入Spring提供的格式化代码插件。
• 插件支持多种方式使用，本文以maven项目管理工具，配置pom.xml的方式撰写，其他方式请参考官方文档。

spring-javaformat是什么？

一组插件，可以应用于任何Java项目，以提供一致的“Spring”样式。该集目前包括：

• 应用包装和空白约定的源格式化程序
• 跨代码库强制一致性的checkstyle插件
  由于这个项目的目的是提供一致性，所以每个插件通常都是不可配置的。您需要更改代码以匹配所需的约定。您无法将插件约定配置为与您的风格相匹配！

使用步骤

引入库

在项目的pom.xml中引入此插件

<build>
	<plugins>
		<plugin>
			<groupId>io.spring.javaformat</groupId>
			<artifactId>spring-javaformat-maven-plugin</artifactId>
			<version>0.0.39</version>
			<executions>
				<execution>
					<phase>validate</phase>
					<inherited>true</inherited>
					<goals>
						<goal>validate</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>

配置文件(可选)

默认的配置空白缩进\t制表符，依据阿里巴巴规范缩进需要调整为4空格，解决此问题官方文档中给出解决方案，在项目根路径下，新增.springjavaformatconfig文件

indentation-style=spaces

执行格式化

在插件中点击apply即可执行格式化，也可以通过命令执行

总结

通过spring提供的格式化插件，使团队的代码格式进行了统一，解决了格式化风格杂乱无章的问题。