如何让formatter-maven-plugin忽略Java 15字符串块的格式化?
解决formatter-maven-plugin格式化Java字符串块时添加多余缩进的问题
要解决这个问题,核心是让formatter-maven-plugin正确识别Java 15+的字符串块(Text Blocks)特性,避免对其内容添加不必要的缩进。具体步骤如下:
1. 升级插件到支持Java 15+的版本
旧版本的formatter-maven-plugin没有适配字符串块特性,必须使用2.20.0及以上版本,这个版本开始支持Java 15及后续版本的语法特性。
2. 配置插件禁用字符串块内容格式化
formatter-maven-plugin底层依赖Eclipse JDT的格式化规则,我们可以通过配置关闭字符串块的自动格式化,保留其原始内容的缩进:
方式一:直接在pom.xml中配置属性
修改插件的configuration,添加针对字符串块的格式化规则:
<plugin> <groupId>net.revelc.code.formatter</groupId> <artifactId>formatter-maven-plugin</artifactId> <version>2.20.0</version> <configuration> <properties> <!-- 关闭字符串块内容的自动格式化 --> <property> <name>org.eclipse.jdt.core.formatter.text_blocks.format</name> <value>false</value> </property> </properties> </configuration> </plugin>
方式二:使用自定义Eclipse格式化配置文件
如果项目已有自定义的formatter.xml配置文件,在其中添加如下规则:
<profile> <!-- 禁止格式化字符串块内容,保留原始缩进 --> <setting id="org.eclipse.jdt.core.formatter.text_blocks.format" value="false"/> </profile>
然后在pom.xml的插件配置中指定该文件路径:
<plugin> <groupId>net.revelc.code.formatter</groupId> <artifactId>formatter-maven-plugin</artifactId> <version>2.20.0</version> <configuration> <configFile>src/main/resources/formatter.xml</configFile> </configuration> </plugin>
验证配置效果
配置完成后,运行mvn formatter:format命令,检查代码中的字符串块内容,会发现不再被自动添加缩进。编译运行项目后,字符串的实际内容也会和原始代码中的一致,不会包含多余的缩进。
这种方案完全可行,只要确保插件版本适配,并且正确配置了字符串块的格式化规则,就能解决问题。
内容的提问来源于stack exchange,提问作者Dmitriy Ten
相关产品推荐
相关产品推荐

