Spring非常实用的技巧，你确定知道？

在Spring框架中，@Nullable注解为我们提供了一种机制来处理可能为null的字段或参数。通过使用@Nullable，我们可以明确告知Spring容器某字段或参数可能是null，从而避免因未注入而导致的运行时错误。

环境：Spring5.3.23

1.简介

在Spring框架中，依赖注入是实现组件间解耦的重要手段。然而，当尝试注入一个不存在的Bean时，程序通常会报错，这可能导致应用程序无法正常启动。

为了解决这个问题，我们将介绍一些最佳实践和技巧，帮助开发者在编写代码时避免此类错误。例如，通过@Autowired(required = false)将required设置为false或者通过Optional来避免此类异常情况。但是本文将要介绍另外一种解决办法。

2.重现错误

static class PersonDAO {
}
@Component 
static class PersonService {
  @Autowired
  private PersonDAO dao ;
  public void find(Integer id) {
    System.out.println("id = " + id.toString()) ;
  }
}

上面的PersonDAO类并没有被注册为Bean，但在PersonService类中使用了@Autowired进行注入，在这种情况下程序启动就会报错。

Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.pack.main.autowired_resource.ResourceInjectAndNullableMain2$PersonDAO' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
  at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoMatchingBeanFound(DefaultListableBeanFactory.java:1801)

错误意思就是期望一个PersonDAO，但是容器中并没有这个类。

如果真有这种情况，要解决这个问题我们可以通过设置@Autowired属性required为false。这样启动就不会报错了。当然这是其中一种方法，其实还有其它的方式解决。

• 【Spring揭秘】ObjectProvider：让依赖注入更加灵活和安全这篇文章详细的介绍了如何使用ObjectProvider
• Optional
• ObjectFactory这种方式会在调用getObject方法的时候报错（如果不存在时）。

通过上面3中方式都可以解决当不存在的时候，容器启动不至于报错。但是今天我们可不是讲这些。今天我们要将的是@Nullable注解

3. @Nullable注解

直接上代码，示例1：

@Nullable
@Autowired
private PersonDAO dao ;

通过该注解程序启动将不会报错了，我这里使用的是spring包下的。org.springframework.lang.Nullable。

示例2：

@javax.annotation.Nullable
@Autowired
private PersonDAO dao ;

程序同样正常启动

是不是说只要加了Spring的或者是java自己的@Nullable就可以了呢？接着往下看

示例3：

自定义Nullable注解

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
static @interface Nullable {
}

接着使用上面自定义的注解，发现程序启动也不会报错。是不是很神奇？Spring又是如何处理的呢？

4. 原理

Spring在注入一个对象时都，在这个过程中它会将你要注入的对象包装成DependencyDescriptor，在该类中有个isRequire方法

public class DependencyDescriptor extends InjectionPoint {
  // 判断注入对象是不是必须的
  public boolean isRequired() {
    // 是否对@Autuwored配置了required属性，设置为false。
    if (!this.required) {
      return false;
    }


    if (this.field != null) {
      // hasNullableAnnotation判断是否有@Nullable注解
      return !(this.field.getType() == Optional.class || hasNullableAnnotation() ||
          (KotlinDetector.isKotlinReflectPresent() &&
              KotlinDetector.isKotlinType(this.field.getDeclaringClass()) &&
              KotlinDelegate.isNullable(this.field)));
    } else {
      return !obtainMethodParameter().isOptional();
    }
  }
  private boolean hasNullableAnnotation() {
    // 遍历字段上的所有注解
    for (Annotation ann : getAnnotations()) {
      // 这里的判断，仅仅是判断你的类名是否为Nullable，并不关心具体是哪个包下的注解
      if ("Nullable".equals(ann.annotationType().getSimpleName())) {
        return true;
      }
    }
    return false;
  }
}

我们还可以将注解加到方法参数上，一样是生效的

@Autowired
public void setDao(@Nullable PersonDAO dao) {
  this.dao = dao ;
}

总结：在Spring框架中，@Nullable注解为我们提供了一种机制来处理可能为null的字段或参数。通过使用@Nullable，我们可以明确告知Spring容器某字段或参数可能是null，从而避免因未注入而导致的运行时错误。

@Nullable注解的使用非常简单，只需在字段，方法参数上添加该注解即可。Spring会在依赖注入时检查是否存在相应的字段，如果不存在，则不会抛出异常，而是将该类或字段的值设置为null。

完毕！！！