实现Comparable接口时遇参数未注解覆盖@NotNull参数警告问题

当实现Comparable<Item>接口并重写compareTo方法时，参数other出现如下警告：

Warning: Not annotated parameter overrides @NotNull parameter

问题代码示例：

@Data
public class Item implements Comparable<Item> {
    private Long id;

    @Override
    public int compareTo(final Item other) {
        if (this.id != null && other.id != null) {
            return (int) (this.id - other.id);
        }
        return 0;
    }
}

解决方案 #

1. 为参数添加@NotNull注解

JetBrains的注解体系中，JDK的Comparable.compareTo方法参数被标记为@NotNull，重写时需保持注解一致。先确保项目引入了JetBrains注解依赖（如org.jetbrains.annotations.NotNull），再修改方法：

import org.jetbrains.annotations.NotNull;

@Data
public class Item implements Comparable<Item> {
    private Long id;

    @Override
    public int compareTo(@NotNull final Item other) {
        if (this.id != null && other.id != null) {
            return (int) (this.id - other.id);
        }
        return 0;
    }
}

2. 用注解抑制警告（不依赖额外库）

如果不想引入JetBrains注解依赖，可在方法上添加抑制特定警告的注解：

@Data
public class Item implements Comparable<Item> {
    private Long id;

    @SuppressWarnings("NullableProblems")
    @Override
    public int compareTo(final Item other) {
        if (this.id != null && other.id != null) {
            return (int) (this.id - other.id);
        }
        return 0;
    }
}

3. 优化排序逻辑（避免潜在问题）

原代码中id为null时直接返回0的逻辑，可能违反compareTo的自反性、对称性、传递性规范，同时强制类型转换存在int溢出风险（如大数值Long相减超出int范围）。推荐优化为：

import org.jetbrains.annotations.NotNull;

@Data
public class Item implements Comparable<Item> {
    private Long id;

    @Override
    public int compareTo(@NotNull final Item other) {
        if (this.id == null) {
            return other.id == null ? 0 : 1; // null值排在非null值之后
        }
        if (other.id == null) {
            return -1;
        }
        return this.id.compareTo(other.id); // 用Long自身的compareTo避免溢出
    }
}

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