DI依赖注入详解

news2024/11/29 10:17:03

DI依赖注入

声明了一个成员变量（对象）之后，在该对象上面加上注解@AutoWired注解，那么在程序运行时，该对象自动在IOC容器中寻找对应的bean对象，并且将其赋值给成员变量，完成依赖注入。

@AutoWired依赖注入的常见方式

1.属性注入

直接使用@AutoWired进行属性注入：

@Autowired
private UserService userService;

这是最简单的依赖注入方式，其优点是：代码简洁，可以方便快速的开发。其缺点是：直接使用属性注入，隐藏了各类之间的依赖关系：Controller是依赖了Service的，但是在类的结构层面无法看出二者的关联。还有可能会破坏类的封装性：按照封装性的解释来看，我们需要将成员属性设置为私有，并对外提供对应的set/get方法；但是直接使用属性注入，没有对外提供set方法，直接对其赋值，在底层是通过反射对其进行赋值的，实际上是破坏了面向对象的封装性原则的。

2.构造函数注入

通过构造函数的方式完成对成员变量的依赖注入：

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

相对于属性注入而言，构造函数注入就能够清晰的看到各类之间的依赖关系，并且基于构造函数注入，可以将userService设置为final，更加安全。但是假如是该类依赖了多个其他的类，都交给IOC容器管理，那么在书写构造方法注入的时候，构造方法的参数将十分多，构造方法将十分臃肿。

注意：如果该类只有一个构造函数，那么该构造函数上的@Autowired注解可以省略

3.setter注入

通过set方法完成对成员变量的依赖注入：

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

优点和构造方法注入类似（但是不能将成员变量设置为final），缺点是需要额外提供set方法，编码繁琐。这种setter注入在开发中基本上不会使用。

在项目开发中，Spring官方推荐构造函数注入，因为其很好的保证了面向对象的特性，并且安全性得到很好的保障；但是在开发中大部分项目都喜欢使用属性注入，因为其简洁、方便开发。所以说要根据项目的具体要求而判断，在简洁性和规范性之间进行取舍。（setter注入基本不用）

使用@AutoWired注解的注意事项

类型注入

@Autowired注解在进行依赖注入时，默认是依据类型进行注入操作。然而，倘若存在需要注入的对象有多个对应的 bean实例时，就会引发错误：

这是第一个UserService的bean

package com.wzb.service.impl;

import com.wzb.dao.UserDao;
import com.wzb.pojo.User;
import com.wzb.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Service层实现类
 *
 */
@Component("newName")
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;
    // 获取用户数据的代码不能写在此处，类的成员变量初始化是在类的实例化阶段进行的，此时可能@AutoWired注入还未完成，导致Null
    // private final List<String> lines = userDao.findUser();

    public List<User> findUser() {
        List<String> lines = userDao.findUser();
        List<User> userList = lines.stream().map(line -> {
            String[] parts = line.split(",");
            Integer id = Integer.parseInt(parts[0]);
            String username = parts[1];
            String password = parts[2];
            String name = parts[3];
            Integer age = Integer.parseInt(parts[4]);
            LocalDateTime updateTime = LocalDateTime.parse(parts[5], DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
            return new User(id, username, password, name, age, updateTime);
        }).collect(Collectors.toList());
        return userList;
    }
}

这是第二个UserService对象的bean

package com.wzb.service.impl;

import com.wzb.dao.UserDao;
import com.wzb.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.stream.Collectors;

/**
 * 用于测试用的bean
 * 
 */
@Component
public class UserServiceImpl2 implements UserService{

    @Autowired
    private UserDao userDao;
    
    public List<User> findUser() {
        List<String> lines = userDao.findUser();
        List<User> userList = lines.stream().map(line -> {
            String[] parts = line.split(",");
            Integer id = Integer.parseInt(parts[0]) + 200;
            String username = parts[1];
            String password = parts[2];
            String name = parts[3];
            Integer age = Integer.parseInt(parts[4]);
            LocalDateTime updateTime = LocalDateTime.parse(parts[5], DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
            return new User(id, username, password, name, age, updateTime);
        }).collect(Collectors.toList());
        return userList;
    }
}

此时Controller中需要依赖UserService这个类，但是IOC容器中有两个这个对象的bean，此时如果直接启动，程序将会直接报错：

报错信息：

根据报错信息的描述来看，是因为UserController需要一个bean（也就是UserService的实现类），但是在IOC容器中找到了两个该对象的bean实例，不知道应该注入哪一个，所以说就报错了。并且还在Action中提供了一个解决方法：使用@Primary、@Qualifier注解。这证明了不能直接将同一个对象的多个bean加入IOC容器管理，如果一个对象有多个bean都需要给IOC容器管理，那么就需要使用其他注解，来成功找到需要的bean并注入。

解决方法

@Primary

假如需要注入的对象在IOC容器中存在多个bean实例，那么就可以在想要被注入的bean上添加注解@Primary：

使用@Primary注解，指定注入的UserService bean实例是UserServiceImpl2，将服务启动结合前端页面查看结果：

发现用户的id都加了200，说明此时注入的UserService实例bean是UserServiceImpl2，@Primary注解成功指定了注入的bean实例。

@Qualifier

@Qualifier注解需要配合@AutoWired注解使用，@Qualifier注解是在声明对象时使用，可以通过注解名（默认是类名小写）指定需要注入的bean实例对象。

通过@Qualifier注解和@AutoWired注解结合使用，指定需要注入UserService的bean实例是UserServiceImpl（注意，bean名字是类名小写）:

发现通过@Qualifier注解和@AutoWired注解结合使用，成功将UserService需要注入的bean实例指定为了UserServiceImpl。

重要一点

此时UserServiceImpl2上面的@Primary注解还在，但是注入的是UserServiceImpl，说明@Qualifiler的优先级高于@Primary。

@Resource

@Resource注解是在声明对象时使用，单独使用，通过注解名指定需要注入的bean实例：

@Resource注解不是Spring提供的，是JavaEE规范中提供的，使用时需要指定name = "bean名"，同样，此时UserServiceImpl2的@Primary注解还在，但是注入的是@Resource注解指定的bean实例，所以说@Resource注解的优先级也高于@Primary注解。

但是假如将@Resource和@Qualifier注解一起用：