IDEA配置formatter-maven-plugin插件

举起大象的蚂蚁

已于 2023-10-26 16:41:01 修改

阅读量1.1k

点赞数 1

文章标签： intellij-idea java maven

于 2023-10-25 19:54:54 首次发布

本文链接：https://blog.csdn.net/zx_liu/article/details/134042473

版权

最近公司新招了很多新人，代码的风格伴随不同的开发人员参差不齐，简直就是千奇百怪，给阅读和协作带来了相当大的困难，导致代码质量难以管控，直接关系到代码的可维护性、性能、安全等维度的考量，是不得不重视的问题。

统一的代码风格可节约大量处理问题时间、避免很多问题，其中最重要的一点就是进行代码review时，风格一致可排除代码中大量的换行、空格、直接定位新增修改过的地方，减少内耗。为了解决这个问题，于是引入了代码风格插件：formatter-maven-plugin，该插件通过maven命令便可以，无视开发工具格式化统一的风格，也可与idea集成。

1、准备好格式化的模板

codestyle-template.xml

2、在工程的父pom.xml(一般为root工程)文件中的pluginManagement下新增plugin，如下：

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>net.revelc.code.formatter</groupId>
                <artifactId>formatter-maven-plugin</artifactId>
                <version>2.11.0</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>format</goal> --在构建期间格式化源文件
                            <goal>validate</goal>  --在构建过程中验证源代码
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <encoding>UTF-8</encoding>  --指定在格式化期间使用UTF-8编码
                    <configFile>https://*****/codeformat/codestyle-template.xml</configFile>  --自定义配置文件
                    <lineEnding>LF</lineEnding>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

3、配置git bash为LF换行符

参考： https://blog.csdn.net/sunday2018/article/details/116402894

git config --global core.autocrlf input

配置后，如果提交代码出现“行分隔符警告”（如下图），先按取消，然后执行mvn formatter:format，会将CRLF换行符转换成LF，之后再次提交，选择“按原样提交”。

4、IDEA配置使用

4.1、安装Adapter for Eclipse Code Formatter插件

4.2、配置编码模板：

a、通过Adapter for Eclipse Code Formatter加载风格模板和import顺序模板：File→ New Projects Setup → Settings for New Projects...( 旧版的idea：All Settings → Other Settings) → Adapter for Eclipse Code Formatter → 按如下配置，其中example.importorder文件下载地址：example.importorder