如何配置Maven：代码存在未解决TODO时触发构建失败？

嘿，这个需求特别实用——能强制团队把代码里遗留的TODO都处理完再允许构建通过对吧？咱们可以借助Maven的Checkstyle插件轻松实现这个功能，具体步骤我给你拆解清楚：

1. 在pom.xml中配置Checkstyle插件 #

首先需要把Checkstyle插件引入到你的Maven构建流程里，让它在构建的验证阶段执行检查。把下面的配置加到你的pom.xml的<build><plugins>节点下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.2.0</version> <!-- 建议使用最新的稳定版本 -->
    <executions>
        <execution>
            <id>enforce-todo-check</id>
            <phase>verify</phase> <!-- 在构建的验证环节触发检查 -->
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <configLocation>checkstyle.xml</configLocation> <!-- 指定自定义规则配置文件 -->
        <failOnError>true</failOnError> <!-- 发现错误时直接终止构建 -->
        <includeTestSourceDirectory>true</includeTestSourceDirectory> <!-- 可选：是否检查测试代码里的TODO -->
    </configuration>
</plugin>

2. 创建Checkstyle规则配置文件 #

在项目根目录下新建一个checkstyle.xml文件，里面定义检查TODO标记的规则：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="TreeWalker">
        <!-- 检测注释中的TODO标记 -->
        <module name="TodoComment">
            <property name="format" value="TODO"/> <!-- 要匹配的标记文本 -->
            <property name="severity" value="error"/> <!-- 将发现的TODO标记为错误级别 -->
        </module>
    </module>
</module>

3. 自定义扩展（可选） #

如果你还想检查其他类似标记（比如FIXME），只需要修改format属性的值为TODO|FIXME，这样两种标记都会被识别并触发构建失败。

4. 测试验证 #

现在你可以在代码里加一个未处理的TODO注释，比如：

// TODO: 这个功能还没实现完
public void unfinishedMethod() {
    // ...
}

然后运行mvn verify，你会看到Maven因为发现TODO错误而终止构建，控制台会输出对应的错误提示。

这样配置完成后，只要代码里存在未解决的TODO标记，Maven构建就会直接失败，完美实现你要的效果。

内容的提问来源于stack exchange，提问作者Jed Cua