【Spring Boot】SpringBoot自动装配-Import

Import导入的类会被Spring加载到IOC容器中。而@Import提供4中用法：导入Bean导入配置类导入 ImportSelector 实现类。一般用于加载配置文件中的类导入 ImportBeanDefinitionRegistrar 实现类。@Import注解定义如下，其内部只有一个参数为Class对象数组Class

从零开始的-CodeNinja之路

2254人浏览 · 2024-09-15 23:43:51

从零开始的-CodeNinja之路 · 2024-09-15 23:43:51 发布

一、前言

@Import导入的类会被Spring加载到IOC容器中。而@Import提供4中用法：

导入Bean
导入配置类
导入 ImportSelector 实现类。一般用于加载配置文件中的类
导入 ImportBeanDefinitionRegistrar 实现类。

二、定义

@Import注解定义如下，其内部只有一个参数为Class对象数组

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {
  Class<?>[] value();
}

三、使用说明

通过一个简单的小例子测试一下@Import是不是真的能实现Bean的注入

3.1 创建项目

在这里插入图片描述

3.1.1 导入依赖

这里我们除了springboot依赖，再添加个lombok依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ldx</groupId>
    <artifactId>import-annotation</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>import-annotation</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

3.1.2 创建User类

package com.ldx.importannotation;

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * 用户信息实体
 * @author ludangxin
 * @date 2021/8/1
 */
@Data
@AllArgsConstructor
public class User {
   public User() {
      this.name = "李四";
      this.age = 13;
   }
   private String name;

   private Integer age;
}

3.2 测试导入Bean

3.2.1 修改启动类

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Import;

@Slf4j
// 注入UserBean
@Import(value = User.class)
@SpringBootApplication
public class ImportAnnotationApplication {

   public static void main(String[] args) {
      ConfigurableApplicationContext applicationContext = SpringApplication.run(ImportAnnotationApplication.class, args);
      User user = applicationContext.getBean(User.class);
      log.info("user info ==={}",user);
   }
}

3.3 测试导入配置类

3.3.1 创建UserConfig类

import org.springframework.context.annotation.Bean;

/**
 * 用户配置类
 * @author ludangxin
 * @date 2021/8/1
 */
public class UserConfig {
   @Bean
   public User getUser(){
      return new User();
   }
}

3.3.2 修改启动类

将启动类上的@Import的value指向UserConfig类

@Import(value = UserConfig.class)

UserBean注入成功。

3.4 测试导入ImportSelector

3.4.1 创建UseImportSelector类

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

/**
 * 用户Bean选择器配置类
 * @author ludangxin
 * @date 2021/8/1
 */
public class UseImportSelector implements ImportSelector {
   @Override
   public String[] selectImports(AnnotationMetadata importingClassMetadata) {
      // 指定User类的全限类名
      return new String[]{"com.ldx.importannotation.User"};
   }
}

3.4.2 修改启动类

将启动类上的@Import的value指向UseImportSelector类

@Import(value = UseImportSelector.class)

3.4.3 启动测试

UserBean注入成功。

3.5 测试导入ImportBeanDefinitionRegistrar类

3.5.1 创建UserImportBeanDefinitionRegistrar

package com.ldx.importannotation;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

/**
 * 用户Bean定义注册配置类
 * @author ludangxin
 * @date 2021/8/1
 */
public class UserImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
   @Override
   public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
      // 创建User类型的Bean的定义
      BeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).getBeanDefinition();
      // 将创建的UserBean定义注册到SpringRegistry中，其名称为user
      registry.registerBeanDefinition("user", beanDefinition);
   }
}

3.5.2 修改启动类

将启动类上的@Import的value指向UserImportBeanDefinitionRegistrar类

@Import(value = UserImportBeanDefinitionRegistrar.class)

3.6 小结

简介中介绍的四种方式都可以注入UserBean。

好处：

导入指定的Bean或配置类。例如：由于业务需要将包路径或者需要加载的Bean类不在@ComponentScan的扫描范围内，这时候我们就可以通过@Import来实现Bean的注入。
ImportSelector方式是制定需要加载类的全限类名。这时候我们就可以将我们的需要装载的类写到配置文件中，比如某个txt中，然后项目启动的时候读取txt中的全限类名，实现Bean的装载。SpringBoot就是使用这种方式实现的自动装配。

四、改进

上面的例子通过使用@Import注解实现了spring bean的自动注入。但是装载Bean每次都得指定Bean的类或者配置类，在生产环境中我们在使用第三方Jar的时候根本不知道应该使用哪个配置文件或者压根就不知道配置文件的名称。这时我们其实可以扩展一个注解来优化这个问题。

4.1 创建注解

package com.ldx.importannotation;

import org.springframework.context.annotation.Import;
import java.lang.annotation.*;

/**
 * 启用User配置信息注解
 * @author ludangxin
 * @date 2021/8/1
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
// 指定需要导入的UserBean的配置类
@Import(UseImportSelector.class)
public @interface EnableUser {}

4.2 修改启动类

注掉之前的@Import，使用刚创建的@EnableUser注解

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Import;

@Slf4j
//@Import(value = UserImportBeanDefinitionRegistrar.class)
@EnableUser
@SpringBootApplication
public class ImportAnnotationApplication {

   public static void main(String[] args) {
      ConfigurableApplicationContext applicationContext = SpringApplication.run(ImportAnnotationApplication.class, args);
      User user = applicationContext.getBean(User.class);
      log.info("user info ==={}",user);
   }
}

UserBean注入成功。

思考🤔
SpringBoot项目中能不能直接获取或者使用Jar包中的Bean呢？

五、验证

5.1 创建项目

user模块为Bean的提供者，book-manage通过引入user模块Jar，来验证项目中能不能直接使用Jar中的Bean

5.2 创建user模块

5.2.1 导入依赖

没啥特别的依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.5.3</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.ldx</groupId>
   <artifactId>user</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>user</name>
   <description>Demo project for Spring Boot</description>
   <properties>
      <java.version>1.8</java.version>
   </properties>
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter</artifactId>
      </dependency>

      <dependency>
         <groupId>org.projectlombok</groupId>
         <artifactId>lombok</artifactId>
         <optional>true</optional>
      </dependency>
   </dependencies>

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
               <excludes>
                  <exclude>
                     <groupId>org.projectlombok</groupId>
                     <artifactId>lombok</artifactId>
                  </exclude>
               </excludes>
            </configuration>
         </plugin>
      </plugins>
   </build>

</project>

5.2.2 创建User类

package com.ldx.user;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.ArrayList;
import java.util.List;

/**
 * 用户信息类
 * @author ludangxin
 * @date 2021/8/1
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
   private Integer id;

   private String name;
   /**
    * 角色状态吗 1.管理员 2.老师 3.学生
    */
   private Character role;

   private Integer age;

   public User getUserInfo() {
      return new User(66, "张三", '3', 21);
   }

   /**
    * 获取其任课老师信息
    */
   public List<User> getTeachers() {
      List<User> users = new ArrayList<>();
      User user = new User();
      user.setId(2);
      user.setName("王麻子");
      user.setAge(45);
      user.setRole('2');
      User user1 = new User();
      user1.setId(3);
      user1.setName("李四");
      user1.setAge(35);
      user1.setRole('2');
      users.add(user);
      users.add(user1);
      return users;
   }
}

5.2.3 修改启动类

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Bean;

@Slf4j
@SpringBootApplication
public class UserApplication {

  public static void main(String[] args) {
    ConfigurableApplicationContext applicationContext = SpringApplication.run(UserApplication.class, args);
    User user = applicationContext.getBean(User.class);
    user.getTeachers().forEach(obj ->
      log.info("user teacher info ==={} ", obj)
    );
  }

  @Bean
  public User getUser() {
    return new User();
  }
}

5.3 创建book-manage模块

5.3.1 导入依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.5.3</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.ldx</groupId>
   <artifactId>book-manage</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>book-manage</name>
   <description>Demo project for Spring Boot</description>
   <properties>
      <java.version>1.8</java.version>
   </properties>
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter</artifactId>
      </dependency>
      <dependency>
         <groupId>org.projectlombok</groupId>
         <artifactId>lombok</artifactId>
         <optional>true</optional>
      </dependency>
      <!-- user模块依赖 -->
      <dependency>
         <groupId>com.ldx</groupId>
         <artifactId>user</artifactId>
         <version>0.0.1-SNAPSHOT</version>
      </dependency>
   </dependencies>

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
               <excludes>
                  <exclude>
                     <groupId>org.projectlombok</groupId>
                     <artifactId>lombok</artifactId>
                  </exclude>
               </excludes>
            </configuration>
         </plugin>
      </plugins>
   </build>

</project>

5.3.2 修改启动类

直接获取User Bean 并调用getUserInfo方法

import com.ldx.user.User;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@Slf4j
@SpringBootApplication
public class BookManageApplication {

  public static void main(String[] args) {
    ConfigurableApplicationContext applicationContext = SpringApplication.run(BookManageApplication.class, args);
    User user = applicationContext.getBean(User.class);
    log.info("user info === {}", user.getUserInfo());
  }

}

六、在user模块中添加Enable注解

import org.springframework.context.annotation.Import;
import java.lang.annotation.*;

/**
 * 启用User配置信息注解
 * @author ludangxin
 * @date 2021/8/1
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(User.class)
public @interface EnableUser {}

七、小结

不能直接在当前项目中使用Jar中的Bean（SpringBoot默认使用ImportSelector的方式加载META-INF/spring.factories中指定的配置类，会导致只需要导入相应的第三方Jar就可以使用其环境中的Bean）
可以在当前项目中使用Jar包中提供的Enable注解来导入Jar的Bean配置