@ParametersAreNonnullByDefault注解提示解决-CSDN博客

本文链接：https://blog.csdn.net/weixin_41979605/article/details/124269273

本文探讨了Java Guava Cache在构建时IDEA提示的`Notannotatedparameteroverrides@ParametersAreNonnullByDefault`问题，解释了该提示的含义，即参数默认非空的规范。通过示例展示了问题的复现及解决方法，即使用@Nonnull注解明确参数非空。同时，强调了遵循此类注解规范的重要性，以避免空指针异常并提高代码质量。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

🤳背景

Guava Cache构建的时候，实现抽象方法的时候，idea默认会提示

Not annotated parameter overrides @ParametersAreNonnullByDefault
parameter Inspection info: Reports problems related to nullability
annotations: overriding problems (for example, when a nullable
parameter is annotated as not-null in the overriding method),
non-annotated getters of annotated fields, and so on.

    private final LoadingCache<String, Configure> COMPANY_CODE_CACHE = CacheBuilder.newBuilder()
            .initialCapacity(150)
            .expireAfterWrite(6, TimeUnit.MINUTES)
            .refreshAfterWrite(4, TimeUnit.MINUTES)
            .concurrencyLevel(5)
            .build(new CacheLoader<String, Configure>() {
                @Override
                public Configure load(String companyCode) throws Exception {
                    return configureMapper.selectByCompanyCode(companyCode);
                }
            });

但是实际上这个方法传递进来的key一定是非空的，但是校验的逻辑是在其他地方，所以idea无法识别。
在这里插入图片描述具体的校验逻辑是在get的时候校验的com.google.common.cache.LocalCache#get(K, com.google.common.cache.CacheLoader<? super K,V>),如下图，在hash之前会先校验key是否为空，null会抛出NullPointerException

🎉问题原因

百度翻译：

Not annotated parameter overrides @ParametersAreNonnullByDefault helps you define that all method parameters in a class or a package have @NotNull semantic, unless they are explicitly annotated with the @Nullable annotation.

未注释的参数重写@ParametersRenonNullByDefault帮助您定义类或包中的所有方法参数都具有@NotNull语义，除非它们使用@Nullable注释显式注释。

@ParametersAreNonnullByDefault注解是jsr305支持的Java注解，在javax.annotation包下,我们默认安装的jdk是没有这个注解的，需要单独引入，它还有个兄弟注解ParametersAreNullableByDefault，其实作用和他们的名字是一样的，就是表示参数默认是不能为空的(ParametersAreNonnullByDefault)，和默认可以为空的规范(ParametersAreNonnullByDefault)。有这个的修饰的，如果调用方使用了空值，编译器就能直接给出提示，避免一些传空值的错误。
在这里插入图片描述

🐱‍👓问题复现

简单的复现一下现象和问题
在这里插入图片描述构造两个方法，调用提示

@ParametersAreNonnullByDefault
public class HelloService {
    public String getParam(String username) {
        return username;
    }

    public void test() {
        String param = getParam(null);
    }
}

🐱‍🐉解决办法

解决办法就是使用对应配套的注解标识

@ParametersAreNonnullByDefault 对应标识 @Nonnull
@ParametersAreNullableByDefault 对应标识 @Nullable

就是名称中包含的关键字，当然你也可以ParametersAreNonnullByDefault 的方法标识@Nullable那么编译器就会允许空值传递，反之亦然。

在这里插入图片描述

    private final LoadingCache<String, Configure> COMPANY_CODE_CACHE = CacheBuilder.newBuilder()
            .initialCapacity(150)
            .expireAfterWrite(6, TimeUnit.MINUTES)
            .refreshAfterWrite(4, TimeUnit.MINUTES)
            .concurrencyLevel(5)
            .build(new CacheLoader<String, Configure>() {
                @Override

                public Configure load(@Nonnull String companyCode) throws Exception {
                    return configureMapper.selectByCompanyCode(companyCode);
                }
            });