第二章 SpringFramework

四、SpringIoC 实践和应用

3. 基于 注解 方式管理 Bean

3.1 实验一：Bean 注解标记和扫描 (IoC)

3.1.1 注解理解

• 和 XML 配置文件一样，注解本身并不能执行，注解本身仅仅只是做一个标记，具体的功能是框架检测到注解标记的位置，然后针对这个位置按照注解标记的功能来执行具体操作。
• 本质上：所有一切的操作都是 Java 代码来完成的，XML 和注解只是告诉框架中的 Java 代码如何执行。
• 举例：元旦联欢会要布置教室，蓝色的地方贴上元旦快乐四个字，红色的地方贴上拉花，黄色的地方贴上气球。
  
• 班长做了所有标记，同学们来完成具体工作。墙上的标记相当于我们在代码中使用的注解，后面同学们做的工作，相当于框架的具体操作。

3.1.2 扫描理解

• Spring 为了知道程序员在哪些地方标记了什么注解，就需要通过扫描的方式，来进行检测。然后根据注解进行后续操作。

3.1.3 准备 Spring 项目和组件

3.1.3.1 准备项目 pom.xml

<dependencies>
    <!--spring context依赖-->
    <!--当你引入Spring Context依赖之后，表示将Spring的基础依赖引入了-->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>6.0.6</version>
    </dependency>

    <!--junit5测试-->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <version>5.3.1</version>
    </dependency>
</dependencies>

3.1.3.2 准备组件类

• 普通组件

/**
 * projectName: com.alex.components
 *
 * description: 普通的组件
 */
public class CommonComponent {
}

• Controller 组件

/**
 * projectName: com.alex.components
 *
 * description: controller类型组件
 */
public class XxxController {
}

• Service 组件

/**
 * projectName: com.alex.components
 *
 * description: service类型组件
 */
public class XxxService {
}

• Dao 组件

/**
 * projectName: com.alex.components
 *
 * description: dao类型组件
 */
public class XxxDao {
}

3.1.4 组件添加标记注解

3.1.4.1 组件标记注解和区别

• Spring 提供了以下多个注解，这些注解可以直接标注在 Java 类上，将它们定义成 Spring Bean。

注解	说明
@Component	该注解用于描述 Spring 中的 Bean，它是一个泛化的概念，仅仅表示容器中的一个组件（Bean），并且可以作用在应用的任何层次，例如 Service 层、Dao 层等。 使用时只需将该注解标注在相应类上即可。
@Repository	该注解用于将数据访问层（Dao 层）的类标识为 Spring 中的 Bean，其功能与 @Component 相同。
@Service	该注解通常作用在业务层（Service 层），用于将业务层的类标识为 Spring 中的 Bean，其功能与 @Component 相同。
@Controller	该注解通常作用在控制层（如SpringMVC 的 Controller），用于将控制层的类标识为 Spring 中的 Bean，其功能与 @Component 相同。

• 通过查看源码我们得知，@Controller、@Service、@Repository这三个注解只是在@Component注解的基础上起了三个新的名字。
• 对于Spring使用IOC容器管理这些组件来说没有区别，也就是语法层面没有区别。所以@Controller、@Service、@Repository这三个注解只是给开发人员看的，让我们能够便于分辨组件的作用。
• 注意：虽然它们本质上一样，但是为了代码的可读性、程序结构严谨！我们肯定不能随便胡乱标记。

3.1.4.2 使用注解标记

• 普通组件

/**
 * projectName: com.alex.components
 *
 * description: 普通的组件
 */
@Component
public class CommonComponent {
}

• Controller 组件

/**
 * projectName: com.alex.components
 *
 * description: controller类型组件
 */
@Controller
public class XxxController {
}

• Service 组件

/**
 * projectName: com.alex.components
 *
 * description: service类型组件
 */
@Service
public class XxxService {
}

• Dao 组件

/**
 * projectName: com.alex.components
 *
 * description: dao类型组件
 */
@Repository
public class XxxDao {
}

3.1.5 配置文件确定扫描范围

• 情况1：基本扫描配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
    <!-- 配置自动扫描的包 -->
    <!-- 1.包要精准,提高性能!
         2.会扫描指定的包和子包内容
         3.多个包可以使用,分割 例如: com.alex.controller,com.atguigu.service等
    -->
    <context:component-scan base-package="com.alex.components"/>
  
</beans>

• 情况2：指定排除组件

<!-- 情况三：指定不扫描的组件 -->
<context:component-scan base-package="com.alex.components">
    
    <!-- context:exclude-filter标签：指定排除规则 -->
    <!-- type属性：指定根据什么来进行排除，annotation取值表示根据注解来排除 -->
    <!-- expression属性：指定排除规则的表达式，对于注解来说指定全类名即可 -->
    <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

• 情况3：指定扫描组件

<!-- 情况四：仅扫描指定的组件 -->
<!-- 仅扫描 = 关闭默认规则 + 追加规则 -->
<!-- use-default-filters属性：取值false表示关闭默认扫描规则 -->
<context:component-scan base-package="com.atguigu.ioc.components" use-default-filters="false">
    
    <!-- context:include-filter标签：指定在原有扫描规则的基础上追加的规则 -->
    <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

3.1.6 组件 BeanName 问题

• 在我们使用 XML 方式管理 bean 的时候，每个 bean 都有一个唯一标识 – id 属性的值，便于在其他地方引用。现在使用注解后，每个组件仍然应该有一个唯一标识。
• 默认情况：
  • 类名首字母小写就是 bean 的 id。例如：SoldierController 类对应的 bean 的 id 就是 soldierController。
• 使用value属性指定：

@Controller(value = "tianDog")
public class SoldierController {
}

• 当注解中只设置一个属性时，value属性的属性名可以省略：

@Service("smallDog")
public class SoldierService {
}

3.1.7 总结

• 注解方式 IoC 只是标记哪些类要被 Spring 管理
• 最终，我们还需要XML方式或者后面讲解 Java 配置类方式指定注解生效的包
• 现阶段配置方式为 注解 （标记）+ XML（扫描）

3.2 实验二：组件（bean）作用域和周期方法注解

3.2.1 组件周期方法配置

3.2.1.1 周期方法概念

• 我们可以在组件类中定义方法，然后当 IoC 容器实例化和销毁组件对象的时候进行调用！这两个方法我们成为生命周期方法！
• 类似于 Servlet 的 init/destroy 方法,我们可以在周期方法完成初始化和释放资源等工作。

3.2.1.2 周期方法声明

public class BeanOne {

  //周期方法要求： 方法命名随意，但是要求方法必须是 public void 无形参列表
  @PostConstruct  //注解制指定初始化方法
  public void init() {
    // 初始化逻辑
  }
}

public class BeanTwo {
  
  @PreDestroy //注解指定销毁方法
  public void cleanup() {
    // 释放资源逻辑
  }

3.2.2 组件作用域配置

3.2.2.1 Bean 作用域概念

• <bean> 标签声明 Bean，只是将 Bean 的信息配置给 SpringIoC 容器！
• 在 IoC 容器中，这些<bean>标签对应的信息转成 Spring 内部 BeanDefinition 对象，BeanDefinition 对象内，包含定义的信息（id,class,属性等等）！
• 这意味着，BeanDefinition 与 类 概念一样，SpringIoC 容器可以可以根据 BeanDefinition 对象反射创建多个 Bean 对象实例。
• 具体创建多少个Bean的实例对象，由 Bean 的作用域 Scope 属性指定！

3.2.2.2 作用域可选值

取值	含义	创建对象的时机	默认值
singleton	在 IOC 容器中，这个 bean 的对象始终为单实例	IOC 容器初始化时	是
prototype	这个 bean 在 IOC 容器中有多个实例	获取 bean 时	否

• 如果是在 WebApplicationContext 环境下还会有另外两个作用域（但不常用）：

取值	含义	创建对象的时机	默认值
request	请求范围内有效的实例	每次请求	否
session	会话范围内有效的实例	每次会话	否

3.2.2.3 作用域配置

@Scope(scopeName = ConfigurableBeanFactory.SCOPE_SINGLETON) //单例,默认值
@Scope(scopeName = ConfigurableBeanFactory.SCOPE_PROTOTYPE) //多例  二选一
public class BeanOne {

  //周期方法要求： 方法命名随意，但是要求方法必须是 public void 无形参列表
  @PostConstruct  //注解制指定初始化方法
  public void init() {
    // 初始化逻辑
  }
}

3.3 实验三： Bean 属性赋值：引用类型自动装配（DI）

3.3.1 设定场景

• SoldierController 需要 SoldierService
• SoldierService 需要 SoldierDao
• 同时在各个组件中声明要调用的方法
• SoldierController 中声明方法

import org.springframework.stereotype.Controller;

@Controller(value = "tianDog")
public class SoldierController {

    private SoldierService soldierService;

    public void getMessage() {
        soldierService.getMessage();
    }

}

• SoldierService 中声明方法

@Service("smallDog")
public class SoldierService {

    private SoldierDao soldierDao;

    public void getMessage() {
        soldierDao.getMessage();
    }

}

• SoldierDao 中声明方法

@Repository
public class SoldierDao {

    public void getMessage() {
        System.out.print("I am a soldier");
    }

}

3.3.2 自动装配实现

3.3.2.1 前提

• 参与自动装配的组件（需要装配、被装配）全部都必须在 IoC 容器中。
• 注意：不区分 IoC 的方式！XML 和注解都可以！

3.3.2.2 @Autowired 注解

• 在成员变量上直接标记 @Autowired 注解即可，不需要提供 setXxx() 方法。以后我们在项目中的正式用法就是这样。

3.3.2.3 给 Controller 装配 Service

@Controller(value = "tianDog")
public class SoldierController {
    
    @Autowired
    private SoldierService soldierService;
    
    public void getMessage() {
        soldierService.getMessage();
    }
    
}

3.3.2.4 给 Service 装配 Dao

@Service("smallDog")
public class SoldierService {
    
    @Autowired
    private SoldierDao soldierDao;
    
    public void getMessage() {
        soldierDao.getMessage();
    }
   
}

3.3.3 @Autowired 注解细节

3.3.3.1 标记位置

• 成员变量
  • 这是最主要的使用方式！
  • 与 xml 进行 bean ref 引用不同，他不需要有 set 方法！

@Service("smallDog")
public class SoldierService {
    
    @Autowired
    private SoldierDao soldierDao;
    
    public void getMessage() {
        soldierDao.getMessage();
    }
}

• 构造器

@Controller(value = "tianDog")
public class SoldierController {
    
    private SoldierService soldierService;
    
    @Autowired
    public SoldierController(SoldierService soldierService) {
        this.soldierService = soldierService;
    }
    ……

• setXxx()方法

@Controller(value = "tianDog")
public class SoldierController {

    private SoldierService soldierService;

    @Autowired
    public void setSoldierService(SoldierService soldierService) {
        this.soldierService = soldierService;
    }
    ……

3.3.3.2 工作流程

• 首先根据所需要的组件类型到 IOC 容器中查找
  • 能够找到唯一的 bean：直接执行装配
  • 如果完全找不到匹配这个类型的 bean：装配失败
  • 和所需类型匹配的 bean 不止一个
    • 没有 @Qualifier 注解：根据 @Autowired 标记位置成员变量的变量名作为 bean 的 id 进行匹配
      • 能够找到：执行装配
      • 找不到：装配失败
    • 使用 @Qualifier 注解：根据 @Qualifier 注解中指定的名称作为 bean 的 id 进行匹配
      • 能够找到：执行装配
      • 找不到：装配失败

@Controller(value = "tianDog")
public class SoldierController {
    
    @Autowired
    @Qualifier(value = "maomiService222")
    // 根据面向接口编程思想，使用接口类型引入Service组件
    private ISoldierService soldierService;

3.3.4 佛系装配

• 给 @Autowired 注解设置 required = false 属性表示：能装就装，装不上就不装。但是实际开发时，基本上所有需要装配组件的地方都是必须装配的，用不上这个属性。

@Controller(value = "tianDog")
public class SoldierController {

    // 给@Autowired注解设置required = false属性表示：能装就装，装不上就不装
    @Autowired(required = false)
    private ISoldierService soldierService;

3.3.5 扩展JSR-250注解 @Resource

3.3.5.1 理解 JSR 系列注解

• JSR（Java Specification Requests）是 Java 平台标准化进程中的一种技术规范，而 JSR 注解是其中一部分重要的内容。按照 JSR 的分类以及注解语义的不同，可以将 JSR 注解分为不同的系列，主要有以下几个系列：

  • JSR-175: 这个 JSR 是 Java SE 5 引入的，是 Java 注解最早的规范化版本，Java SE 5 后的版本中都包含该 JSR 中定义的注解。主要包括以下几种标准注解：

    • @Deprecated: 标识一个程序元素（如类、方法或字段）已过时，并且在将来的版本中可能会被删除。
    • @Override: 标识一个方法重写了父类中的方法。
    • @SuppressWarnings: 抑制编译时产生的警告消息。
    • @SafeVarargs: 标识一个有安全性警告的可变参数方法。
    • @FunctionalInterface: 标识一个接口只有一个抽象方法，可以作为 lambda 表达式的目标。

  • JSR-250: 这个 JSR 主要用于在 Java EE 5 中定义一些支持注解。该 JSR 主要定义了一些用于进行对象管理的注解，包括：

    • @Resource: 标识一个需要注入的资源，是实现 Java EE 组件之间依赖关系的一种方式。
    • @PostConstruct: 标识一个方法作为初始化方法。
    • @PreDestroy: 标识一个方法作为销毁方法。
    • @Resource.AuthenticationType: 标识注入的资源的身份验证类型。
    • @Resource.AuthenticationType: 标识注入的资源的默认名称。

  • JSR-269: 这个 JSR 主要是 Java SE 6 中引入的一种支持编译时元数据处理的框架，即使用注解来处理 Java 源文件。该 JSR 定义了一些可以用注解标记的注解处理器，用于生成一些元数据，常用的注解有：

    • @SupportedAnnotationTypes: 标识注解处理器所处理的注解类型。
    • @SupportedSourceVersion: 标识注解处理器支持的 Java 源码版本。

  • JSR-330: 该 JSR 主要为 Java 应用程序定义了一个依赖注入的标准，即 Java 依赖注入标准（javax.inject）。在此规范中定义了多种注解，包括：

    • @Named: 标识一个被依赖注入的组件的名称。
    • @Inject: 标识一个需要被注入的依赖组件。
    • @Singleton: 标识一个组件的生命周期只有一个唯一的实例。

  • JSR-250: 这个 JSR 主要是 Java EE 5 中定义一些支持注解。该 JSR 包含了一些支持注解，可以用于对 Java EE 组件进行管理，包括：

    • @RolesAllowed: 标识授权角色
    • @PermitAll: 标识一个活动无需进行身份验证。
    • @DenyAll: 标识不提供针对该方法的访问控制。
    • @DeclareRoles: 声明安全角色。

• 但是要理解 JSR 是 Java 提供的技术规范，也就是说，他只是规定了注解和注解的含义，JSR 并不是直接提供特定的实现，而是提供标准和指导方针，由第三方框架（Spring）和库来实现和提供对应的功能。

3.3.5.2 JSR-250 @Resource 注解

• @Resource 注解也可以完成属性注入。那它和@Autowired 注解有什么区别？

  • @Resource 注解是 JDK 扩展包中的，也就是说属于 JDK 的一部分。所以该注解是标准注解，更加具有通用性。(JSR-250 标准中制定的注解类型。JSR 是 Java 规范提案。)
  • @Autowired 注解是 Spring 框架自己的。
  • @Resource 注解默认根据 Bean 名称装配，未指定 name 时，使用属性名作为 name。通过 name 找不到的话会自动启动通过类型装配。
  • @Autowired 注解默认根据类型装配，如果想根据名称装配，需要配合@Qualifier 注解一起用。
  • @Resource 注解用在属性上、setter 方法上。
  • @Autowired 注解用在属性上、setter 方法上、构造方法上、构造方法参数上。

  @Resource 注解属于 JDK 扩展包，所以不在 JDK 当中，需要额外引入以下依赖：【高于 JDK11 或低于 JDK8 需要引入以下依赖】

<dependency>
   <groupId>jakarta.annotation</groupId>
   <artifactId>jakarta.annotation-api</artifactId>
   <version>2.1.1</version>
</dependency>

3.3.5.3 @Resource 使用

@Controller
public class XxxController {
    /**
     * 1. 如果没有指定name,先根据属性名查找IoC中组件xxxService
     * 2. 如果没有指定name,并且属性名没有对应的组件,会根据属性类型查找
     * 3. 可以指定name名称查找!  @Resource(name='test') == @Autowired + @Qualifier(value='test')
     */
    @Resource
    private XxxService xxxService;

    //@Resource(name = "指定beanName")
    //private XxxService xxxService;

    public void show(){
        System.out.println("XxxController.show");
        xxxService.show();
    }
}