【Spring Boot】SpringBoot自动装配-Import

devtools/2025/2/12 4:37:05/
目录
    • 一、前言
    • 二、 定义
    • 三、使用说明
      • 3.1 创建项目
        • 3.1.1 导入依赖
        • 3.1.2 创建User类
      • 3.2 测试导入Bean
        • 3.2.1 修改启动类
      • 3.3 测试导入配置类
        • 3.3.1 创建UserConfig类
        • 3.3.2 修改启动类
      • 3.4 测试导入ImportSelector
        • 3.4.1 创建UseImportSelector类
        • 3.4.2 修改启动类
        • 3.4.3 启动测试
      • 3.5 测试导入ImportBeanDefinitionRegistrar类
        • 3.5.1 创建UserImportBeanDefinitionRegistrar
        • 3.5.2 修改启动类
      • 3.6 小结
    • 四、 改进
      • 4.1 创建注解
      • 4.2 修改启动类
    • 五、 验证
      • 5.1 创建项目
      • 5.2 创建user模块
        • 5.2.1 导入依赖
        • 5.2.2 创建User类
        • 5.2.3 修改启动类
      • 5.3 创建book-manage模块
        • 5.3.1 导入依赖
        • 5.3.2 修改启动类
    • 六、 在user模块中添加Enable注解
    • 七、小结

在这里插入图片描述
在这里插入图片描述

一、前言

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

  1. 导入Bean

  2. 导入配置类

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

  4. 导入 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 {@Beanpublic 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 {@Overridepublic 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 {@Overridepublic void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {// 创建User类型的Bean的定义BeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).getBeanDefinition();// 将创建的UserBean定义注册到SpringRegistry中，其名称为userregistry.registerBeanDefinition("user", beanDefinition);}
}
3.5.2 修改启动类

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

@Import(value = UserImportBeanDefinitionRegistrar.class)
3.6 小结

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

好处：

  1. 导入指定的Bean或配置类。例如：由于业务需要将包路径或者需要加载的Bean类不在@ComponentScan的扫描范围内，这时候我们就可以通过@Import来实现Bean的注入。
  2. 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));}@Beanpublic 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配置


http://www.ppmy.cn/devtools/158112.html

相关文章

PostgreSQL插件-pg_stat_statements-安装和使用

PostgreSQL插件-pg_stat_statements-安装和使用

文章目录 插件介绍插件安装1.修改配置文件postgresql.conf2.插件相关参数参数默认值参数说明特别注意pg_stat_statements.max参数设置太小日志会有警告 插件使用1.创建插件2.使用插件3.重置数据4.删除插件 可能会出现的问题1.没有编译安装插件2.没有配置shared_preload_librari…
阅读更多...
使用WebUI访问本地Deepseek（Ollama集成Open WebUI）

使用WebUI访问本地Deepseek（Ollama集成Open WebUI）

在《deepseek本地部署和使用&#xff08;Linux虚拟机&#xff09;》中&#xff0c;我们使用Ollama部署了Deepseek-r1&#xff0c;但是只能通过命令行方式交互&#xff0c;默认Ollama启动后&#xff0c;会启动一个监听到127.0.0.1&#xff0c;用以接收POST 请求&#xff0c;服务…
阅读更多...
仿 RabbitMQ 实现的简易消息队列

仿 RabbitMQ 实现的简易消息队列

文章目录 项目介绍开放环境第三⽅库介绍ProtobufMuduo库 需求分析核⼼概念实现内容 消息队列系统整体框架服务端模块数据管理模块虚拟机数据管理模块交换路由模块消费者管理模块信道&#xff08;通信通道&#xff09;管理模块连接管理模块 客户端模块 公共模块日志类其他工具类…
阅读更多...
Java GSON 解析 JSON 完全指南

Java GSON 解析 JSON 完全指南

1. 简介 GSON&#xff08;Google JSON&#xff09;是 Google 提供的用于在 Java 中处理 JSON 数据的库。它允许 Java 对象与 JSON 之间进行序列化和反序列化&#xff0c;支持简单对象、集合、泛型和复杂数据结构的转换。GSON 轻量、高效、易用&#xff0c;是 Java 开发中处理 …
阅读更多...
Java面试题-计算机网络

Java面试题-计算机网络

文章目录 1.介绍一下TCP/IP五层模型&#xff1f;2.**什么是TCP三次握手、四次挥手&#xff1f;**1.三次握手建立连接2.四次握手断开连接 **3.HTTPS和HTTP的区别是什么&#xff1f;**4.**浏览器输入www.taobao.com回车之后发生了什么**&#xff1f;1.URL解析&#xff0c;对URL进…
阅读更多...
1.31-子序列问题

1.31-子序列问题

Code-1.31-子序列问题 300. 最长递增子序列 题目分析 1. 状态表示 dp[i]表示&#xff1a;以i结尾的所有子序列中&#xff0c;最长递增子序列的长度。 2. 状态转移方程 dp[i] 长度为1 -> 1长度大于1 -> nums[j] < nums[i] -> max(dp[j] 1) 3. 初始化 把表…
阅读更多...
aio-pika 快速上手（Python 异步 RabbitMQ 客户端）

aio-pika 快速上手（Python 异步 RabbitMQ 客户端）

目录 简介官方文档如何使用 简介 aio-pika 是一个 Python 异步 RabbitMQ 客户端。5.0.0 以前 aio-pika 基于 pika 进行封装&#xff0c;5.0.0 及以后使用 aiormq 进行封装。 https://github.com/mosquito/aio-pikahttps://pypi.org/project/aio-pika/ pip install aio-pika官…
阅读更多...
C#操作excel数据，第一步先保存到Redis，第二步再保存到Sql Server数据库。第三步同步到MongoDB中

C#操作excel数据，第一步先保存到Redis，第二步再保存到Sql Server数据库。第三步同步到MongoDB中

以下是一个完整的C#示例，展示如何将Excel数据依次保存到Redis、SQL Server和MongoDB中。代码分为三个步骤，并使用异步编程模型提高性能。 --- ### **实现步骤** 1. **读取Excel数据**：使用 `EPPlus` 库读取Excel文件。 2. **保存到Redis**：使用 `StackExchange.Redis` 将…
阅读更多...
最新文章

Copyright @ 2022~2023