2.3 IOC之于注解管理bean

2.3、基于注解管理bean

2.3.1、实验一：标记与扫描

①注解

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

班长做了所有标记，同学们来完成具体工作。墙上的标记相当于我们在代码中使用的注解，后面同学们做的工作，相当于框架的具体操作。

②扫描

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

③新建Maven Module

<dependencies>
<!-- 基于Maven依赖传递性，导入spring-context依赖即可导入当前所需所有jar包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.3.1</version>
</dependency>
<!-- junit测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

④创建Spring配置文件

⑤标识组件的常用注解

@Component：将类标识为普通组件
@Controller：将类标识为控制层组件
@Service：将类标识为业务层组件
@Repository：将类标识为持久层组件

问：以上四个注解有什么关系和区别？

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

⑥创建组件

创建控制层组件

@Controller
public class UserController {
}
1
2
3

创建接口UserService

public interface UserService {
}
1
2

创建业务层组件UserServiceImpl

@Service
public class UserServiceImpl implements UserService {
}
1
2
3

创建接口UserDao

public interface UserDao {
}
1
2

创建持久层组件UserDaoImpl

@Repository
public class UserDaoImpl implements UserDao {
}
1
2
3

⑦扫描组件

情况一：最基本的扫描方式

    <!--扫描组件-->
    <context:component-scan base-package="com.gao.spring"></context:component-scan>
1
2

情况二：指定要排除的组件

    <!--扫描组件-->
    <context:component-scan base-package="com.gao.spring">
        <!-- context:exclude-filter标签：指定排除规则 -->
        <!--
        type：设置排除或包含的依据
        type="annotation"，根据注解的类型排除，expression中设置要排除的注解的全类名
        type="assignable"，根据类的类型排除，expression中设置要排除的类型的全类名
        -->
                <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
<!--        <context:exclude-filter type="assignable" expression="com.gao.spring.conntroller.UserController"/>-->
    </context:component-scan>
1
2
3
4
5
6
7
8
9
10
11

情况三：仅扫描指定组件
use-default-filters="false"

 <!--扫描组件-->
    <context:component-scan base-package="com.gao.spring" use-default-filters="false">
        <!-- context:exclude-filter标签：指定排除规则 -->
        <!--
        type：设置排除或包含的依据
        type="annotation"，根据注解的类型排除，expression中设置要排除的注解的全类名
        type="assignable"，根据类的类型排除，expression中设置要排除的类型的全类名
        -->
<!--         <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>-->
<!--        <context:exclude-filter type="assignable" expression="com.gao.spring.conntroller.UserController"/>-->
        <!--*********************************************************************************************************-->
        <!-- context:include-filter标签：指定在原有扫描规则的基础上追加的规则 -->
        <!-- use-default-filters属性：取值false表示关闭默认扫描规则 -->
        <!-- 此时必须设置use-default-filters="false"，因为默认规则即扫描指定包下所有类 -->
        <!--
        type：设置排除或包含的依据
        type="annotation"，根据注解排除，expression中设置要排除的注解的全类名
        type="assignable"，根据类型排除，expression中设置要排除的类型的全类名
        -->

        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
<!--        <context:include-filter type="assignable" expression="com.gao.spring.conntroller.UserController"/>-->
    </context:component-scan>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

⑧测试

    /*
    *
    * @Component：将类标识为普通组件
    @Controller：将类标识为控制层组件
    @Service：将类标识为业务层组件
    @Repository：将类标识为持久层组件
    * */

    @Test
    public void test(){
        ClassPathXmlApplicationContext ioc = new ClassPathXmlApplicationContext("spring-ioc-annotation.xml");
        UserController bean = ioc.getBean(UserController.class);
        System.out.println(bean);

        UserService bean1 = ioc.getBean(UserService.class);
        System.out.println(bean1);

        UserDao bean2 = ioc.getBean(UserDao.class);
        System.out.println(bean2);
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

⑨组件所对应的bean的id

在我们使用XML方式管理bean的时候，每个bean都有一个唯一标识，便于在其他地方引用。现在使用注解后，每个组件仍然应该有一个唯一标识。

默认情况
类名首字母小写就是bean的id。例如：UserController类对应的bean的id就是userController。
自定义bean的id
可通过标识组件的注解的value属性设置自定义的bean的id
@Service(“userService”)//默认为userServiceImpl public class UserServiceImpl implements
UserService {}

    @Test
    public void test(){
        ClassPathXmlApplicationContext ioc = new ClassPathXmlApplicationContext("spring-ioc-annotation.xml");
        UserController bean = ioc.getBean("userController",UserController.class);
        System.out.println(bean);

        UserService bean1 = ioc.getBean("userServiceImpl",UserService.class);
        System.out.println(bean1);

        UserDao bean2 = ioc.getBean("userDaoImpl",UserDao.class);
        System.out.println(bean2);
    }
1
2
3
4
5
6
7
8
9
10
11
12

自定义id

@Controller("controller")
public class UserController {
}

1
2
3
4

ClassPathXmlApplicationContext ioc = new ClassPathXmlApplicationContext("spring-ioc-annotation.xml");
        UserController bean = ioc.getBean("controller",UserController.class);
        System.out.println(bean);
1
2
3

---

2.3.2、实验二：基于注解的自动装配

①场景模拟

参考基于xml的自动装配
在UserController中声明UserService对象
在UserServiceImpl中声明UserDao对象

②@Autowired注解

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

@Controller("controller")
public class UserController {

    @Autowired
    private UserService userService;

    public void saveUser(){
        userService.saveUser();
    }
}

1
2
3
4
5
6
7
8
9
10
11

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    @Override
    public void saveUser() {
        userDao.saveUser();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12

③@Autowired注解其他细节

@Autowired注解可以标记在构造器和set方法上

@Controller
public class UserController {
private UserService userService;
@Autowired
public UserController(UserService userService){
this.userService = userService;
}
public void saveUser(){
userService.saveUser();
}
}
1
2
3
4
5
6
7
8
9
10
11

@Controller
public class UserController {
private UserService userService;
@Autowired
public void setUserService(UserService userService){
this.userService = userService;
}
public void saveUser(){
userService.saveUser();
}
}
1
2
3
4
5
6
7
8
9
10
11

④@Autowired工作流程

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

@Controller
public class UserController {
@Autowired
@Qualifier("userServiceImpl")
private UserService userService;
public void saveUser(){
userService.saveUser();
}
}
1
2
3
4
5
6
7
8
9

@Autowired中有属性required，默认值为true，因此在自动装配无法找到相应的bean时，会装配失败
可以将属性required的值设置为true，则表示能装就装，装不上就不装，此时自动装配的属性为默认值
但是实际开发时，基本上所有需要装配组件的地方都是必须装配的，用不上这个属性。

---

总结

 /*
    *
    * @Component：将类标识为普通组件
    @Controller：将类标识为控制层组件
    @Service：将类标识为业务层组件
    @Repository：将类标识为持久层组件
    * */


    /*
    * @Autowired:实现自动装配功能的注解
    * 1.@Autowired注解能够标识的位置
    * a>标识在成员变量上，此时不需要设置成员变量的set方法
    * b>标识在set方法上
    * c>标识在为当前成员变量赋值的有参构造器上
    * 2.@Autowired注解的原理
    * a>默认byType的方式，在ioc容器中通过类型匹配某个bean为属性赋值
    * b>若有多个类型匹配的bean，此时会自动转换为byname的方式进行自动装配的效果
    * 即将要赋值的属性的属性名作为bean的id匹配某个bean为属性赋值
    * c>若byType和byName的方式都无法实现自动装配，即ioc的容器中有多个类型匹配的bean
    * 且这些bean的id和要赋值的属性的属性名都不一致，此时会抛出异常：NoUniqueBeanDefinitionException
    * d>此时可以在要赋值的属性上，添加一个注解@Qualifier
    * 通过该注解的value属性值，指定某个bean的id，将这个bean为属性赋值
    *
    *
    * 注意：若ioc容器中没有任何一个类型匹配的bean，此时抛出异常：NoSuchBeanDefinitionException
    * @Autowired注解中有一个属性required，默认为true，要求必须完成自动装配
    * 可以将requuired设置为false，此时能装配则装配，无法装配使用属性的默认值
    * */
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29