如何在Maven构建中实现Java代码的编译期契约检查？

我给你推荐一个完美适配需求的方案——Checker Framework，它完全能解决你当前的痛点：支持编译期强制契约检查，无缝集成到Maven构建流程，契约表达能力不逊于JetBrains Contracts，甚至覆盖更多场景。

第一步：配置Maven依赖与编译插件 #

在你的pom.xml里添加以下配置，这样Maven的编译阶段会自动触发契约检查，一旦发现违规直接中断构建：

<dependencies>
    <dependency>
        <groupId>org.checkerframework</groupId>
        <artifactId>checker-qual</artifactId>
        <version>3.42.0</version> <!-- 建议使用最新稳定版本 -->
        <scope>provided</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.11.0</version>
            <configuration>
                <!-- 启用空值契约检查器，你可以根据需求切换其他检查器 -->
                <annotationProcessors>
                    <annotationProcessor>org.checkerframework.checker.nullness.NullnessChecker</annotationProcessor>
                </annotationProcessors>
                <compilerArgs>
                    <arg>-AprintErrorStack</arg> <!-- 可选，帮助更清晰地定位错误原因 -->
                </compilerArgs>
            </configuration>
        </plugin>
    </plugins>
</build>

第二步：为你的函数添加契约注解 #

针对你提供的safeToLong函数，用Checker Framework的空值注解来定义契约：

import org.checkerframework.checker.nullness.qual.Nullable;

public class YourUtilsClass {
    // 正确契约：输入null返回null，输入非null可能返回null或有效Long
    public static @Nullable Long safeToLong(@Nullable String value) {
        if (value == null) {
            return null;
        }
        try {
            return Long.parseLong(value);
        } catch (NumberFormatException e) {
            return null;
        }
    }
}

如果像你之前那样设置错误契约——比如错误声明输入null时必须返回非null，代码写成这样：

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.checker.nullness.qual.NonNull;

public class YourUtilsClass {
    // 错误契约：强制声明输入null返回非null
    public static @NonNull Long safeToLong(@Nullable String value) {
        // 原代码逻辑不变
        if (value == null) {
            return null;
        }
        try {
            return Long.parseLong(value);
        } catch (NumberFormatException e) {
            return null;
        }
    }
}

此时执行mvn compile会直接失败，抛出类似error: [return.type.incompatible] incompatible types in return的编译错误，完全实现了你要的"契约违规则构建失败"的效果。

为什么Checker Framework是最优选择？ #

• 编译期强制校验：不像JetBrains Contracts只在IDE里给警告，它直接嵌入javac编译流程，违规直接中断构建，确保代码符合契约要求
• 丰富的契约体系：除了空值契约，还支持类型确定性、索引安全、正则匹配等多种契约场景，满足更多复杂需求
• Maven零额外工具集成：不需要安装专用分析工具，仅通过maven-compiler-plugin配置即可完成集成
• 渐进式改造支持：可以逐步为代码添加契约，不需要一次性重构整个代码库

另外，如果你习惯JetBrains Contracts的@Contract语法，Checker Framework也支持通过org.checkerframework.checker.contracts.ContractsChecker来识别该注解，只需要调整annotationProcessor为这个类，并添加对应的依赖即可，学习成本极低。

内容的提问来源于stack exchange，提问作者Colm Bhandal