Spring 常用注解

Spring 常用注解

编写信息

编写日期：2023.05.29

笔者：LiiiYiAn

参考文献

CSDN - @Autowired 与@Resource的区别（详细） 参考日期：2023.05.29

@Component 相关用于标注 Bean

@Component：

可以使用此注解描述 Spring 中的 Bean，但它是一个泛化的概念，仅仅表示一个组件（Bean)，并且可以作用在任何层次。使用时只需将该注解标注在相应类上即可。

@Repository：通常作用在数据访问层，将类标识为 Spring 中的 Bean，功能与 @Component 相同

@Service：通常作用在业务层，将类标识为 Spring 中的 Bean,，功能与 @Component 相同

@Controller：通常作用在控制层，将类标识为 Spring 中的 Bean，功能与 @Component 相同

数据访问层、业务层、控制层又称为 DAO 层、Service、Controller 层

@Repository、@Service、@Controller 是 @Component 在 DAO 层、Service 层、Controller 层的不同化身，都是用来修饰类，标注被修饰的类会生成 bean

@Configuration 和 @ComponentScan

@Configuration：

标注在类上，表示该类是一个配置类，因为我们在创建 ApplicationContext 时：

ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

使用的实现类是 AnnotationConfigApplicationContext，在基于 Java 注解管理 Bean 时，必须传入一个标注了 @Configuration 的类名

@ComponentScan：

标注在类上，它告诉容器，自动扫描当前类所在的包以及子包，把所有标注为 @Component 的 Bean 自动创建出来，并根据 @Autowired 进行装配。

注意是当前类所在的包及其子包，因此被标注的类必须在你想要自动扫描的类的上级

这就是为什么前面说可以不需要在 XML 配置文件中配置自动扫描的原因

如果即没有在 XML 中配置自动扫描，也没有标注 @ComponentScan，则运行会抛出异常：

• NoClassDefFoundError

找不到指定类，原因就是 Spring 无法自动装配

@Resource、@Autowired 和 @Qualifier

@Resource

属于 J2EE，通过 byName 和 byType 的方式注入

属于 J2EE：由 JSR-250 提供

byName：名称装配 byType：类型装配

默认按名称装配，名称通过 name 属性指定，如果没有指定 name：

• 注解写在字段上，默认取字段名进行装配

• 注解写在 setter 方法上，默认取属性名进行装配

当找不到与名称匹配的 bean 时，才按照类型进行装配。但需要注意的是：

• 如果 name 属性一旦指定，就只会按照名称进行装配。

@Resource 有两个属性是比较重要的：name 和 type，Spring 将 @Resource 的 name 属性解析为 bean的名字，而 type 属性则解析为 bean 的类型：

• 使用 name 属性，则使用 byName 的自动注入策略
• 使用 type 属性，则使用 byType 自动注入策略
• 既不指定 name 也不指定 type 属性，这时将通过反射机制使用 byName 自动注入策略

@Resource 装配顺序：

1. 如果同时指定了 name 和 type，则从 Spring 上下文中找到唯一匹配的 bean 进行装配，找不到则抛出异常
　　2. 如果指定了 name，则从上下文中查找名称（id）匹配的 bean 进行装配，找不到则抛出异常
　　3. 如果指定了 type，则从上下文中找到类型匹配的唯一 bean 进行装配，找不到或者找到多个，都会抛出异常
　　4. 如果既没有指定 name，又没有指定 type，则自动按照 byName 方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配

@Autowired

根据数据类型自动扫描并装配，自动从 Spring 应用上下文中找到合适的 bean 来注入

使用 @Annotation 配合自动扫描能大幅简化 Spring 的配置，我们只需要保证：

• 开启了自动扫描

• 每个 Bean 被标注为 @Component 并正确使用 @Autowired 注入

• 配置类被标注为 @Configuration

• 所有 Bean 均在指定包以及子包内

@Autowired 默认按类型装配，这个注解属于 Spring

默认情况下要求依赖对象必须存在，即不能为 null，如果要允许 null 值，可以设置它的 required 属性为 false，如：

@Autowired(required = false)
private UserMapper userMapper;

@Qualifier

@Qualifier 一般作为 @Autowired 的修饰用，@Autowired 是根据类型进行自动装配的

当出现以下 2 种情况时，会抛出异常 BeanCreationException：

• Spring 上下文中存在不止一个指定类型的 bean

• Spring 上下文中不存在指定类型的 bean

可以让 @Autowired 结合 @Qualifier，使用**名称装配（byName）**方式，解决以上问题。如下：

在 field 上时：

field /fiːld/ n.领域，在 Java 中，类的 field 指类的属性，有时也称领域

@Autowired()@Qualifier("userMapper2")
private UserMapper userMapper;

在 setter 上时：

private UserMapper userMapper;

public setUserMapper(@Qualifier("userMapper3") UserMapper userMapper) {
    this.userMapper = userMapper;
}

针对上面两个例子，Spring 会找到 id 为 userMapper2 和 userMapper3 的 bean 进行装配

@Autowired 与 @Resource 的区别

@Autowired 与 @Resource 都可以用来装配 bean，都可以写在 field 上或写在 setter 方法上

所属规范：

• @Autowired 属于 Spring
• @Resource 属于 J2EE

从这个角度看，@Resource 属于J2EE，减少了与 Spring 的耦合。这样代码看起就比较优雅

默认：

• @Autowired 默认按类型（byType）装配，要求依赖对象必须存在，即不能为 null。可以和 @Qualifier 结合使用按名称装配
• @Resource 默认按名称（byName）装配，通过 name 属性指定，也可以按类型装配，通过 type 属性指定