spring（二）：基于注解实现依赖注入

1. 前期准备

1.1 添加依赖

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

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

    <!--log4j2的依赖-->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.19.0</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j2-impl</artifactId>
        <version>2.19.0</version>
    </dependency>
</dependencies>

1.2 开启组件扫描

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

<?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="org.kkk.spring6"></context:component-scan>
</beans>

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

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

<context:component-scan base-package="org.kkk.spring6"> </context:component-scan>

方式二：指定要排除的组件

<context:component-scan base-package="org.kkk.spring6">
    <!-- context:exclude-filter标签：指定排除规则 -->
    <!-- 
 		type：设置排除或包含的依据
		type="annotation"，根据注解排除，expression中设置要排除的注解的全类名
		type="assignable"，根据类型排除，expression中设置要排除的类型的全类名
	-->
    <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

方式三：仅扫描指定组件

<context:component-scan base-package="org.kkk" 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:component-scan>

2. 注解介绍

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

3. 注解使用方法

3.1 @Autowired注入

单独使用@Autowired注解，默认根据类型装配。在需要注入的属性上添加注解@Autowired即可，spring会自动根据类型进行注入。

例如：

创建UserServiceImpl实现类，且给这个实现类添加注解service，将其交给容器管理。

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
   

    @Autowired
    private UserDao userDao;

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

在UserController类中，在属性userService上添加注解autowired，那么spring就可以进行属性注入。

package org.kkk.spring6.controller;

import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@Controller
public class UserController {
   

    @Autowired
    private UserService userService;

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

}

3.2 set注入

与3.1不同，在3.1中，注解autowired是添加在属性上，而set注入是将注解autowired添加到该属性的set方法上。举例如下：

修改UserServiceImpl类

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@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层执行结束");
    }
}

修改UserController类，注意注解@Autowired的位置

package org.kkk.spring6.controller;

import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@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层执行结束。");
    }

}

3.3 构造方法注入

这种方式是将注解@autowired加在有参构造函数上。举例如下：

修改UserServiceImpl类

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@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层执行结束");
    }
}

修改UserController类

package org.kkk.spring6.controller;

import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@Controller
public class UserController {
   

    private UserService userService;

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

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

}

3.4 形参上注入

这种方式与3.3类似，也需要有参构造函数。与3.3不同的是，这种方式需要将注解加在形参前面。举例如下：

修改UserServiceImpl类

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@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层执行结束");
    }
}

修改UserController类

package org.kkk.spring6.controller;

import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@Controller
public class UserController {
   

    private UserService userService;

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

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

}

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

当构造方法只有一个，且该构造方法是有参构造时，@Autowired注解可以省略。举例如下：

修改UserServiceImpl类

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
   

    private UserDao userDao;

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

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

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

如果一个类型的Bean数量超过一个时，那么根据这个类型去进行属性注入会出现错误。这种情况下，如果要正确的进行属性注入，那就需要用到注解Qualifier根据名称进行装配。

举例如下：

添加dao层实现，此时接口UserDao的实现类有两个，因此无法只根据类型进行装配。

package org.kkk.spring6.dao.impl;

import org.kkk.spring6.dao.UserDao;
import org.springframework.stereotype.Repository;

@Repository
public class UserDaoRedisImpl implements UserDao {
   

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

修改UserServiceImpl类，使用注解Qualifier根据名称进行装配。

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
   

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

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

3.7 @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需要引入以下依赖。】

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

3.7.1 根据name注入

修改UserDaoImpl类

package org.kkk.spring6.dao.impl;

import org.kkk.spring6.dao.UserDao;
import org.springframework.stereotype.Repository;

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

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

修改UserServiceImpl类

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import jakarta.annotation.Resource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
   

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

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

3.7.2 不指定name进行注入

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

修改UserDaoImpl类

package org.kkk.spring6.dao.impl;

import org.kkk.spring6.dao.UserDao;
import org.springframework.stereotype.Repository;

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

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

修改UserServiceImpl类

package org.kkk.spring6.service.impl;

import org.kkk.spring6.dao.UserDao;
import org.kkk.spring6.service.UserService;
import jakarta.annotation.Resource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
   

    @Resource
    private UserDao myUserDao;

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

4. Spring全注解开发

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

package org.kkk.spring6.config;

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

@Configuration
@ComponentScan("org.kkk.spring6")
public class Spring6Config {
   
}

加载方法与XML相同

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