基于注解管理Bean

Spring从2.5版本开始提供了对注解技术的全面支持，我们可以使用注解来实现自动装配，简化Spring的XML配置。 Spring通过注解实现自动装配的步骤如下：

引入依赖
开启组件扫描
使用注解定义Bean
依赖注入

1. 工程准备

搭建子模块spring6-ioc-annotation，拷贝spring-ioc-xml模块中的log4j2.xml和相关pom.xml依赖。

2. 开启组件扫描

Spring默认不使用注解装配Bean，因此我们需要在Spring的XML配置中，通过 <context:component-scan>元素开启Spring Beans的自动扫描功能。开启此功能后，Spring会自动从扫描指定的包(base-package 属性设置)及其子包下的所有类，如果类上使用了@Component注解，就将该类装配到容器中。

xml

<?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-3.0.xsd
    http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd">
    <!--开启组件扫描功能-->
    <context:component-scan base-package="com.rocket.spring"></context:component-scan>
</beans>

提示

在使用<context:component-scan>元素开启自动扫描功能前，首先需要在XML配置的一级标签<beans>中添加context相关的约束。

2.1 最基本的扫描方式

xml

<context:component-scan base-package="com.rocket.spring">
</context:component-scan>

2.2 指定要排除的组件

xml

<context:component-scan base-package="com.rocket.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.rocket.spring.controller.UserController"/>-->
</context:component-scan>

2.3 仅扫描指定组件

xml

<context:component-scan base-package="com.rocket" use-default-filters="false">
    <!-- 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.rocket.spring.controller.UserController"/>-->
</context:component-scan>

3. 使用注解定义Bean

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 相同。

4. @Autowired注入

单独使用@Autowired注解，默认根据类型装配。【也就是默认是byType】, 查看源码：

java

package org.springframework.beans.factory.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Autowired {
    boolean required() default true;
}

源码中有两处需要注意：

第一处：该注解可以标注在哪里？

构造方法上
方法上
形参上
属性上
注解上

第二处：该注解有一个required属性，默认值是true，表示在注入的时候要求被注入的Bean必须是存在的，如果不存在则报错。如果required属性设置为false，表示注入的Bean存在或者不存在都没关系，存在的话就注入，不存在的话，也不报错。

4.1 属性注入

java

public class UserTest {

    private Logger logger = LoggerFactory.getLogger(UserTest.class);

    @Test
    public void testAnnotation(){
        ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");
        UserController userController = context.getBean("userController", UserController.class);
        userController.out();
        logger.info("执行成功");
    }
}

以上构造方法和setter方法都没有提供，经过测试，仍然可以注入成功。

4.2 set注入

修改UserServiceImpl类\UserController类：

UserServiceImpl.javaUserController.java

java

@Service
public class UserServiceImpl implements UserService {

    private UserDao userDao;

    @Autowired
    public void setUserDao(UserDao userDao) {
        this.userDao = userDao;
    }

    @Override
    public void out() {
        userDao.print();
        System.out.println("Service层执行结束");
    }
}

java

@Controller
public class UserController {

    private UserService userService;

    @Autowired
    public void setUserService(UserService userService) {
        this.userService = userService;
    }

    public void out() {
        userService.out();
        System.out.println("Controller层执行结束。");
    }
}

测试：成功调用

4.3 构造方法注入

修改UserServiceImpl类\UserController类:

UserServiceImpl.javaUserController.java

java

@Service
public class UserServiceImpl implements UserService {

    private UserDao userDao;

    @Autowired
    public UserServiceImpl(UserDao userDao) {
        this.userDao = userDao;
    }

    @Override
    public void out() {
        userDao.print();
        System.out.println("Service层执行结束");
    }
}

java

@Controller
public class UserController {

    private UserService userService;

    @Autowired
    public UserController(UserService userService) {
        this.userService = userService;
    }

    public void out() {
        userService.out();
        System.out.println("Controller层执行结束。");
    }
}

测试：成功调用

4.4 形参上注入

修改UserServiceImpl类\修改UserController类:

UserServiceImpl.javaUserController.java

java

@Service
public class UserServiceImpl implements UserService {

    private UserDao userDao;

    public UserServiceImpl(@Autowired UserDao userDao) {
        this.userDao = userDao;
    }

    @Override
    public void out() {
        userDao.print();
        System.out.println("Service层执行结束");
    }
}

java

@Controller
public class UserController {

    private UserService userService;

    public UserController(@Autowired UserService userService) {
        this.userService = userService;
    }

    public void out() {
        userService.out();
        System.out.println("Controller层执行结束。");
    }
}

测试：成功调用

4.5 只有一个构造函数，无注解

修改UserServiceImpl类:

java

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    public UserServiceImpl(UserDao userDao) {
        this.userDao = userDao;
    }

    @Override
    public void out() {
        userDao.print();
        System.out.println("Service层执行结束");
    }
}

测试通过
当有参数的构造方法只有一个时，@Autowired注解可以省略。
说明：有多个构造方法时呢？大家可以测试(再添加一个无参构造函数)，测试报错

4.6 @Autowired注解和@Qualifier注解联合

添加dao层实现:

java

import com.jack.spring6.dao.UserDao;
import org.springframework.stereotype.Repository;

@Repository
public class UserDaoRedisImpl implements UserDao {

    @Override
    public void print() {
        System.out.println("Redis Dao层执行结束");
    }
}

测试：测试异常
错误信息中说：不能装配，UserDao这个Bean的数量等于2
怎么解决这个问题呢？当然要byName，根据名称进行装配了。
修改UserServiceImpl类:

java

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    @Qualifier("userDaoImpl") // 指定bean的名字
    private UserDao userDao;

    @Override
    public void out() {
        userDao.print();
        System.out.println("Service层执行结束");
    }
}

总结

@Autowired注解可以出现在：属性上、构造方法上、构造方法的参数上、setter方法上。
当带参数的构造方法只有一个，@Autowired注解可以省略。()
@Autowired注解默认根据类型注入。如果要根据名称注入的话，需要配合@Qualifier注解一起使用。

5. @Resource注入

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

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

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

xml

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

@Resource注解源码：

java

package jakarta.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Resources.class)
public @interface Resource {
    String name() default "";

    String lookup() default "";

    Class<?> type() default Object.class;

    Resource.AuthenticationType authenticationType() default Resource.AuthenticationType.CONTAINER;

    boolean shareable() default true;

    String mappedName() default "";

    String description() default "";

    public static enum AuthenticationType {
        CONTAINER,
        APPLICATION;

        private AuthenticationType() {
        }
    }
}

5.1 根据name注入

修改UserDaoImpl类\UserServiceImpl类:

UserDaoImpl.javaUserServiceImpl.javaUserDaoImpl.javaUserServiceImpl.java

java

@Repository("myUserDao")
public class UserDaoImpl implements UserDao {

    @Override
    public void print() {
        System.out.println("Dao层执行结束");
    }
}

java

@Service
public class UserServiceImpl implements UserService {

    @Resource(name = "myUserDao")
    private UserDao myUserDao;

    @Override
    public void out() {
        myUserDao.print();
        System.out.println("Service层执行结束");
    }
}

测试通过

5.2 name未知注入

修改UserDaoImpl类\UserServiceImpl类:

UserDaoImpl.javaUserServiceImpl.java

java

@Repository("myUserDao")
public class UserDaoImpl implements UserDao {

    @Override
    public void print() {
        System.out.println("Dao层执行结束");
    }
}

java

@Service
public class UserServiceImpl implements UserService {

    @Resource
    private UserDao myUserDao;

    @Override
    public void out() {
        myUserDao.print();
        System.out.println("Service层执行结束");
    }
}

测试通过
当@Resource注解使用时没有指定name的时候，还是根据name进行查找，这个name是属性名。

5.3 其他情况

修改UserServiceImpl类，userDao1属性名不存在:

java

@Service
public class UserServiceImpl implements UserService {

    @Resource
    private UserDao userDao1;

    @Override
    public void out() {
        userDao1.print();
        System.out.println("Service层执行结束");
    }
}

测试异常
根据异常信息得知：显然当通过name找不到的时候，自然会启动byType进行注入，以上的错误是因为UserDao接口下有两个实现类导致的。所以根据类型注入就会报错。
@Resource的set注入可以自行测试 总结：
@Resource注解：默认byName注入，没有指定name时把属性名当做name，根据name找不到时，才会byType注入。byType注入时，某种类型的Bean只能有一个。

6. Spring全注解开发

全注解开发就是不再使用spring配置文件了，写一个配置类来代替配置文件。

java

package com.rocket.spring.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan("com.rocket.spring")
public class Spring6Config {
}

测试类

java

@Test
public void testAllAnnotation(){
    ApplicationContext context = new AnnotationConfigApplicationContext(Spring6Config.class);
    UserController userController = context.getBean("userController", UserController.class);
    userController.out();
    logger.info("执行成功");
}

基于注解管理Bean ​

1. 工程准备 ​

2. 开启组件扫描 ​

2.1 最基本的扫描方式 ​

2.2 指定要排除的组件 ​

2.3 仅扫描指定组件 ​

3. 使用注解定义Bean ​

4. @Autowired注入 ​

4.1 属性注入 ​

4.2 set注入 ​

4.3 构造方法注入 ​

4.4 形参上注入 ​

4.5 只有一个构造函数，无注解 ​

4.6 @Autowired注解和@Qualifier注解联合 ​

5. @Resource注入 ​

5.1 根据name注入 ​

5.2 name未知注入 ​

5.3 其他情况 ​

6. Spring全注解开发 ​

基于注解管理Bean

1. 工程准备

2. 开启组件扫描

2.1 最基本的扫描方式

2.2 指定要排除的组件

2.3 仅扫描指定组件

3. 使用注解定义Bean

4. @Autowired注入

4.1 属性注入

4.2 set注入

4.3 构造方法注入

4.4 形参上注入

4.5 只有一个构造函数，无注解

4.6 @Autowired注解和@Qualifier注解联合

5. @Resource注入

5.1 根据name注入

5.2 name未知注入

5.3 其他情况

6. Spring全注解开发