idea 代码格式化 Spotless 教程

介绍

1. Spotless 是一个代码格式化工具。
2. 它支持的开发语言有java, kotlin, scala, sql, javascript, css, json, yaml, etc。
3. 它可以提示哪里不规范，同时也支持自动修正（其实就是批量的将所有类格式化）
4. 支持maven|gradle plugin等插件

接入

下载 check code xml

intellij-java-google-style.xml

pom引入spotless 插件

<plugin>
    <groupId>com.diffplug.spotlessgroupId>
    <artifactId>spotless-maven-pluginartifactId>
    <version>2.22.1version>
    <configuration>
        <java>
            <eclipse>
                <file>${maven.multiModuleProjectDirectory}/src/resources/intellij-java-google-style.xmlfile>
            eclipse>
            <licenseHeader>
                <file>${maven.multiModuleProjectDirectory}/src/resources/license-headerfile>
            licenseHeader>
        java>
    configuration>
      
     <executions>
	        <execution>
	            <goals>
	                <goal>applygoal>
	            goals>
	            <phase>compilephase>
	        execution>
    executions>
plugin>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Spotless 支持格式化指定目录，以及排除指定目录的功能，详情参考spotless-maven-plugin。如无指定，执行 check 或 apply 时，默认项目全量代码。

检验

#格式化
mvn spotless:apply
# 检查
mvn spotless:check
1
2
3
4

开发过程中 格式化 文件

1. 安装插件 Eclipse Code Formatter
2. 选择 intellij-java-google-style.xml为默认格式化模板
3. 使用 IDEA 代码格式化快捷键，就可以完成 Spotless 代码格式化

问题

Spotless 与 Checkstyle 可能冲突,那要看取舍调整了