解密Spring Boot：深入理解条件装配与条件注解

news2024/11/25 20:00:30

在这里插入图片描述

文章目录

    • 一、条件装配概述
      • 1.1 条件装配的基本原理
      • 1.2 条件装配的作用
    • 二、常用注解
      • 2.1 @ConditionalOnClass
      • 2.2 @ConditionalOnBean
      • 2.3 @ConditionalOnProperty
      • 2.4 @ConditionalOnExpression
      • 2.5 @ConditionalOnMissingBean
    • 三、条件装配的实现原理
    • 四、实际案例

一、条件装配概述

1.1 条件装配的基本原理

条件装配的基本原理是根据特定的条件来决定是否应用特定的配置或组件。在 Spring Boot 中，条件装配是通过条件注解来实现的。

条件注解是一种特殊的注解，用于标记在配置类、组件类或方法上。它们根据某些条件的结果来决定是否应用相应的配置或组件。

条件注解的基本原理：

  1. 条件判断：Spring 在处理配置类或组件时，会对标记了条件注解的类或方法进行条件判断。
  2. 条件匹配：条件注解中定义的条件匹配器会根据特定的条件，如类路径是否存在、Bean 是否存在、属性是否被设置等，对环境进行判断，如果条件满足则返回 true，否则返回 false。
  3. 条件注解处理器：Spring 容器会使用条件注解处理器来处理条件注解，根据条件匹配的结果来决定是否应用相应的配置或组件。
  4. 应用配置或组件：根据条件注解的处理结果，Spring 容器会决定是否应用相应的配置或组件。如果条件满足，则进行相应的配置或组件的注册和初始化；如果条件不满足，则忽略该配置或组件。

1.2 条件装配的作用

条件装配的作用在于根据特定的条件来决定是否应用特定的配置或组件，从而实现灵活性和可配置性。

条件装配实现的作用：

  1. 环境适配：通过条件装配，可以根据当前的运行环境（如开发环境、测试环境、生产环境）或者配置（如不同的数据库、不同的服务提供商）来动态地选择合适的配置或组件，从而使应用程序适应不同的环境。
  2. 可插拔性：条件装配可以根据应用程序的需求动态地选择性地应用不同的配置或组件，使得应用程序的功能可以根据需求进行扩展或者替换，从而增强了应用程序的可插拔性和可扩展性。
  3. 简化配置：通过条件装配，可以根据特定的条件自动地应用相应的配置或组件，而无需手动配置或编写复杂的条件判断逻辑，从而简化了配置过程，提高了配置的易用性和可维护性。
  4. 优化性能：通过条件装配，可以根据特定的条件选择性地应用相应的配置或组件，避免不必要的资源消耗，从而优化了应用程序的性能和资源利用率。

二、常用注解

2.1 @ConditionalOnClass

@ConditionalOnClass 是 Spring Boot 中的一个条件注解，用于在类路径中存在指定的类时才会应用相应的配置。

定义了一个灵活的条件注解 ConditionalOnClass，它可以根据类路径中特定类的存在与否来决定是否应用相应的配置或组件。
在这里插入图片描述

示例和用法说明：

/**
 * 只有当应用程序的类路径中存在 RedisTemplate 类时，RedisConfiguration 类中定义的 redisTemplate() 方法才会被注册为 Bean，并被 Spring 容器管理
 * 如果类路径中不存在 RedisTemplate 类，则该配置类中的 Bean 将被忽略
 */
@Configuration
@ConditionalOnClass({org.springframework.data.redis.core.RedisTemplate.class})
public class RedisConfiguration {

    @Bean
    public RedisTemplate<String, Object> redisTemplate() {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        // 配置 RedisTemplate 的相关属性
        return redisTemplate;
    }
}

2.2 @ConditionalOnBean

@ConditionalOnBean 是 Spring Framework 中的一个条件注解，它的作用是在容器中存在指定的 Bean 时，才会应用相应的配置或组件。如果指定的 Bean 不存在，则该配置或组件将被忽略。

定义了一个具有多个属性的注解 ConditionalOnBean，可以用于指定条件判断所依赖的类、名称、注解等信息，以及搜索依赖 Bean 的策略和泛型容器中的参数化类型。

在这里插入图片描述

示例和用法说明：

  1. 基本用法：
/**
 * MyService 类被标记为 @ConditionalOnBean(MyBean.class)，这意味着只有当容器中存在 MyBean 类型的 Bean 时，MyService 才会被创建并添加到容器中
 */
@Configuration
public class MyConfiguration {

    @Bean
    public MyBean myBean() {
        return new MyBean();
    }

    @ConditionalOnBean(MyBean.class)
    @Bean
    public MyService myService() {
        return new MyService();
    }
}
  1. 多个 Bean 的情况：
/**
 * MyService 类被标记为 @ConditionalOnBean({MyBean.class, AnotherBean.class})，这意味着只有当容器中同时存在 MyBean 和 AnotherBean 类型的 Bean 时，MyService 才会被创建并添加到容器中
 */
@Configuration
public class MyConfiguration {

    @Bean
    public MyBean myBean() {
        return new MyBean();
    }

    @Bean
    public AnotherBean anotherBean() {
        return new AnotherBean();
    }

    @ConditionalOnBean({MyBean.class, AnotherBean.class})
    @Bean
    public MyService myService() {
        return new MyService();
    }
}
  1. 使用名称来指定 Bean：
/**
 * MyService 类被标记为 @ConditionalOnBean(name = {"myBean", "anotherBean"})，这意味着只有当容器中同时存在名称为 "myBean" 和 "anotherBean" 的 Bean 时，MyService 才会被创建并添加到容器中
 */
@Configuration
public class MyConfiguration {

    @Bean(name = "myBean")
    public MyBean myBean() {
        return new MyBean();
    }

    @Bean(name = "anotherBean")
    public AnotherBean anotherBean() {
        return new AnotherBean();
    }

    @ConditionalOnBean(name = {"myBean", "anotherBean"})
    @Bean
    public MyService myService() {
        return new MyService();
    }
}

2.3 @ConditionalOnProperty

@ConditionalOnProperty 注解是 Spring Framework 中的条件注解之一，用于基于配置属性的存在与否来决定是否应用某个配置。

定义了一个具有多个属性的注解 ConditionalOnProperty，它可以用于根据配置文件中的属性值来决定是否应用某个配置。

在这里插入图片描述

示例和说明：

/**
 * @ConditionalOnProperty 注解指定了一个名为myapp.feature.enabled 的属性，当这个属性存在并且其值为"true"时，MyFeatureConfiguration 配置类中的配置会生效
 * havingValue 参数指定了期望的属性值，如果没有指定havingValue，则默认匹配任何非空值
 * matchIfMissing 参数指定了当配置文件中未设置该属性时，是否应该匹配。如果设置为 true，则表示当属性不存在时也匹配，这样可以设置默认行为
 */
@Configuration
@ConditionalOnProperty(
    name = "myapp.feature.enabled",
    havingValue = "true",
    matchIfMissing = true
)
public class MyFeatureConfiguration {
    
}

myapp.feature.enabled=true

2.4 @ConditionalOnExpression

@ConditionalOnExpression 是 Spring 框架中的一个条件注解，在应用配置时根据 SpEL表达式的结果来决定是否进行配置。它允许我们使用更灵活的表达式来控制配置的条件。

定义了一个具有一个属性的注解 ConditionalOnExpression，它可以根据 SpEL 表达式的结果来决定是否应用某个配置。

在这里插入图片描述

示例和说明：

/**
 * 检查配置文件中的 my.config.enabled 属性是否等于 'true'
 * 如果等于 'true'，则表达式结果为 true`，MyBean 实例将会被创建
 * 否则，表达式结果为 false，配置将被忽略，不会创建 MyBean 实例
 */
@Configuration
public class MyConfig {
    @Bean
    @ConditionalOnExpression("#{environment.getProperty('my.config.enabled') == 'true'}")
    public MyBean myBean() {
        // 配置生效时创建 MyBean 实例
        return new MyBean();
    }
}

2.5 @ConditionalOnMissingBean

@ConditionalOnMissingBean 是一个 Spring Boot 中常用的条件注解，它的作用是：当容器中不存在指定的 Bean 时，才会进行配置。

定义了一个具有多个属性的注解 ConditionalOnMissingBean，用于根据存在或缺少特定类型的 bean 来决定是否应用某个配置。

在这里插入图片描述

示例和说明：

/**
 * 使用 @ConditionalOnMissingBean 注解来判断容器中是否已经存在了 MyService 类型的 Bean
 * 如果不存在，则创建一个 MyServiceImpl 实例并返回
 * 否则，不进行任何操作。
 */
@Configuration
public class MyConfiguration {

    @Bean
    @ConditionalOnMissingBean(MyService.class)
    public MyService myService() {
        return new MyServiceImpl();
    }
}

三、条件装配的实现原理

条件装配的实现原理主要基于Spring的IoC容器和@Conditional注解。

在Spring的IoC容器中，BeanFactoryPostProcessor和BeanPostProcessor是两个核心的接口，它们允许我们在bean的创建和配置过程中添加额外的逻辑。(想要了解源码，读者可以查看我前面的博文)

条件装配的实现原理：

  1. @Conditional注解：这个注解可以标记在类、方法或注解上，用于指定在特定的条件满足时才创建和配置bean。@Conditional注解需要一个Class类型的参数，这个参数需要实现Condition接口。
  2. Condition接口：这是一个函数式接口，它定义了一个matches(ConditionContext context, AnnotatedTypeMetadata metadata)方法。
    • 这个方法返回一个boolean值，表示条件是否满足。如果返回true，则Spring容器会创建和配置相应的bean；如果返回false，则不会创建和配置。
    • 两个参数提供了关于Spring容器和当前正在评估的bean的元数据信息。
  3. 自动配置：在Spring Boot中，条件装配被广泛应用于自动配置。
    • Spring Boot会根据我们在pom.xml文件中引入的依赖，自动配置相应的bean。
    • 这是通过一系列的AutoConfiguration类实现的，这些类上通常会使用@ConditionalOnClass、@ConditionalOnMissingBean等注解来指定条件。

四、实际案例

假设正在开发一个在线商城的 Spring Boot 应用程序，其中包含了用户管理和订单管理两个模块。现在，希望在用户注册时发送一封欢迎邮件，但是如果用户已经在系统中存在，则不发送邮件。

ps：使用条件注解 @ConditionalOnMissingBean 来实现这一定制化功能。

  1. 创建一个邮件服务接口 EmailService 和实现类 WelcomeEmailService。
/**
 * 邮件服务接口
 */
public interface EmailService {
    void sendWelcomeEmail(String email);
}

/**
 * 发送欢迎邮件
 */
@Service
public class EmailServiceImpl implements EmailService {
    @Override
    public void sendWelcomeEmail(String email) {
        // 发送欢迎邮件的逻辑
        System.out.println("Sending welcome email to: " + email);
    }
}
  1. 创建一个用户服务类 UserService，在用户注册时调用邮件服务发送欢迎邮件。
public interface UserService {
    public void registerUser(String email);
}

/**
 * 在用户注册时检查是否已经存在该用户，如果不存在则发送欢迎邮件
 */
@Service
public class UserServiceImpl implements UserService {
    private final UserMapper userMapper;
    private final EmailService emailService;

    @Autowired
    public UserServiceImpl(UserMapper userMapper, EmailService emailService) {
        this.userMapper = userMapper;
        this.emailService = emailService;
    }

    @Override
    public void registerUser(String email) {
        if(!userMapper.existsByEmail(email)) {
            userMapper.save(email);
            emailService.sendWelcomeEmail(email);
        }else {
            throw new IllegalArgumentException("Email already exists");
        }
    }
}
  1. 创建一个 UserRepository实现，它使用HashSet来模拟存储用户信息。
/**
 * 不想使用数据库，直接使用HashSet来模拟存储用户信息的email
 * 使用一个HashSet来存储注册过的email，HashSet不允许存储重复的元素
 * @author LEK
 */
@Repository
public class UserMapper {
    private final Set<String> registeredEmails = new HashSet<>();

    public boolean existsByEmail(String email) {
        return registeredEmails.contains(email);
    }

    public void save(String email) {
        if (Objects.nonNull(email) && !email.isEmpty()) {
            registeredEmails.add(email);
        }
    }
}
  1. 使用 @ConditionalOnMissingBean 注解来确保只有在容器中不存在 EmailService 的实现类时才会注入 WelcomeEmailService。这样，如果用户在系统中已经存在，就不会发送欢迎邮件。
@Configuration
public class EmailConfig {
    /**
     * 邮件配置
     * */
    @Bean
    @ConditionalOnMissingBean(EmailService.class)
    public EmailServiceImpl email() {
        return new EmailServiceImpl();
    }
}
  1. 新建UserServiceImplTest测试类，由于是使用HashSet来模拟运行，每次启动都是不存在的，然后手动一下。
@SpringBootTest
public class UserServiceImplTest {

    @Autowired
    private UserService userService;

    @Test
    public void testRegisterExistingUser() {
        String existingEmail = "existing@example.com";

        userService.registerUser(existingEmail);
        // 注册已存在的用户，预期会抛出 IllegalArgumentException
        userService.registerUser(existingEmail);
    }
}
  1. 运行效果。

在这里插入图片描述

哪儿有勤奋，哪儿就有成功

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1808862.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

SpringBoot中实现一个通用Excel导出功能

SpringBoot中实现一个通用Excel导出功能

SpringBoot中实现一个通用Excel导出功能 文章目录 SpringBoot中实现一个通用Excel导出功能这个导出功能的特色看效果代码解析1、依赖2、Excel 入参（ExcelExportRequest）3、Excel 出参（ExcelExportResponse）4、ExcelExportField5、ExcelExportUtils 工具类6、ExcelHead 头部…
阅读更多...
LeetCode1318或运算的最小翻转次数

LeetCode1318或运算的最小翻转次数

题目描述 给你三个正整数 a、b 和 c。你可以对 a 和 b 的二进制表示进行位翻转操作&#xff0c;返回能够使按位或运算 a OR b c 成立的最小翻转次数。「位翻转操作」是指将一个数的二进制表示任何单个位上的 1 变成 0 或者 0 变成 1 。 解析 这一题就按位依次比较就行了。取这…
阅读更多...
【SQLAlChemy】Query函数可传入的参数有哪些？

【SQLAlChemy】Query函数可传入的参数有哪些？

Query 函数的使用 参数种类 一般可以传递的参数有如下三种&#xff1a; 模型名。指定查找这个模型的全部属性&#xff08;对应于数据库查询中的全表查询&#xff09;。模型中的属性。可以用来指定只查询某个模型的几个属性值。使用聚合函数。 func.count():统计行的数量。fu…
阅读更多...
【机器学习】GPT-4中的机器学习如何塑造人类与AI的新对话

【机器学习】GPT-4中的机器学习如何塑造人类与AI的新对话

&#x1f680;时空传送门 &#x1f50d;引言&#x1f4d5;GPT-4概述&#x1f339;机器学习在GPT-4中的应用&#x1f686;文本生成与摘要&#x1f388;文献综述与知识图谱构建&#x1f6b2;情感分析与文本分类&#x1f680;搜索引擎优化&#x1f4b4;智能客服与虚拟助手&#x1…
阅读更多...
打造智慧校园信息系统，提升学校科技实力

打造智慧校园信息系统，提升学校科技实力

在如今数字化的时代&#xff0c;打造智慧校园信息系统已成为提升学校科技实力的关键。随着科技的迅猛发展&#xff0c;学校需要跟上时代步伐&#xff0c;利用先进技术建设一个高效、智能的信息系统&#xff0c;为学生、教师和管理人员提供更好的学习和工作环境。 智慧校园信息系…
阅读更多...
企业官网：过时了，但又没完全过时

企业官网：过时了，但又没完全过时

作为一名互联网冲浪级选手&#xff0c;我经常会看到一些有趣的产品。 这两年比较让我感兴趣的产品有「飞聊」、「即刻」及其旗下的「橙 App」等等&#xff0c;然后我就想上它们的官网看看。 虽然现在 app 是主流&#xff0c;但我非常不喜欢下载 app&#xff0c;一是麻烦&…
阅读更多...
数据结构与算法笔记：基础篇 - 二叉树基础（下）：有了如此高效的散列表，为什么还需要二叉树？

数据结构与算法笔记：基础篇 - 二叉树基础（下）：有了如此高效的散列表，为什么还需要二叉树？

概述 上篇文章&#xff0c;我们学习了树、二叉树及二叉树的遍历&#xff0c;本章来学习一种特殊的二叉树&#xff0c;二叉查找树。二叉查找树最大的特点就是&#xff0c;支持动态数据集合的快速插入、删除、查找操作。 之前说过&#xff0c;散列表也是支持这些操作的&#xf…
阅读更多...
RAG：如何从0到1搭建一个RAG应用

RAG：如何从0到1搭建一个RAG应用

通过本文你可以了解到&#xff1a; 什么是RAG&#xff1f;如何搭建一个RAG应用&#xff1f;目前开源的RAG应用有哪些&#xff1f; 大模型学习参考&#xff1a; 1.大模型学习资料整理&#xff1a;大模型学习资料整理&#xff1a;如何从0到1学习大模型&#xff0c;搭建个人或企业…
阅读更多...
67. UE5 RPG 创建法师敌人角色

67. UE5 RPG 创建法师敌人角色

我们设置的敌人类型分三种&#xff0c;分别时战士类型&#xff0c;远程射手&#xff0c;和法师类型。在前面&#xff0c;我们创建了战士和射手类型的&#xff0c;还没有法师类型的&#xff0c;在这一篇文章中&#xff0c;我们创建一个法师类型的角色。 在64. UE5 RPG 创建新的双…
阅读更多...
矩阵杯2024 Re wp 前两题

矩阵杯2024 Re wp 前两题

1. packpy UPX壳&#xff0c;但不能直接脱&#xff0c;应该是修改了头文件&#xff08;l_info) 改一下就能脱了 脱完是个elf文件 进IDA看一眼 明显的Py打包标志&#xff0c;用pyinstxtractor解包出来&#xff08;最好用对应的python3.8&#xff09; 可以得到packpy.pyc文件&a…
阅读更多...
ROS学习记录：C++节点发布自定义地图

ROS学习记录：C++节点发布自定义地图

前言 ROS栅格地图格式 在了解了ROS地图消息包的数据结构后(链接在上)&#xff0c;本文将编写一个节点&#xff0c;发布地图消息包&#xff0c;看看在RViz中显示是什么效果。 一、准备 1、为了简单起见&#xff0c;发布一个两行四列的地图 2、为了便于观测&#xff0c;只对地…
阅读更多...
textattack报错：不能导入自定义search_methods (cannot import name ‘xxx‘ from ‘xxx‘)

textattack报错：不能导入自定义search_methods (cannot import name ‘xxx‘ from ‘xxx‘)

1. 报错信息 ImportError: cannot import name AAA from textattack.search_methods (/home/666/anaconda3/envs/textattack37_env/lib/python3.7/site-packages/textattack/search_methods/__init__.py)2. 出错简述 贴一段test1.py的模块导入 #建议使用&#xff01; import…
阅读更多...
时钟影响ADC性能不仅仅是抖动

时钟影响ADC性能不仅仅是抖动

时钟影响ADC性能除了抖动&#xff0c;还有占空比。 在高速AD采样中&#xff0c;时钟占空比是非常重要的一个参数。时钟信号的上升沿控制ADC的采样&#xff0c;而下降沿控制着信号的保持&#xff0c;在一个周期内才可以完成量化输出&#xff0c;所以必须保持时钟的占空比为50%&…
阅读更多...
Typora Markdown编辑器 for Mac v1.8.10 安装

Typora Markdown编辑器 for Mac v1.8.10 安装

Mac分享吧 文章目录 效果一、准备工作二、开始安装1、双击运行软件&#xff0c;将其从左侧拖入右侧文件夹中&#xff0c;等待安装完毕2. 应用程序显示软件图标&#xff0c;表示安装成功 三、运行调试1、修改主题2、显示文档列表&#xff0c;如下图3、查看版本信息 **安装完成&…
阅读更多...
AI智能体做高考志愿填报分析

AI智能体做高考志愿填报分析

关注公众号&#xff0c;赠送AI/Python/Linux资料&#xff0c;对AI智能体有兴趣的朋友也可以添加一起交流 高考正在进行时&#xff0c;学生焦虑考试&#xff0c;家长们焦虑的则是高考志愿怎么填。毕竟一个好的学校&#xff0c;好的专业是进入社会的第一个敲门砖 你看张雪峰老师…
阅读更多...
CvT（ICCV 2021）论文与代码解读

CvT（ICCV 2021）论文与代码解读

paper&#xff1a;CvT: Introducing Convolutions to Vision Transformers official implementation&#xff1a;https://github.com/microsoft/CvT 出发点 该论文的出发点是改进Vision Transformer (ViT) 的性能和效率。传统的ViT在处理图像分类任务时虽然表现出色&#xf…
阅读更多...
xilinx的Aurora8B10B的IP仿真及上板测试（高速收发器十七）

xilinx的Aurora8B10B的IP仿真及上板测试（高速收发器十七）

前文讲解了Aurora8B10B协议原理及xilinx相关IP&#xff0c;本文讲解如何设置该IP&#xff0c;并且通过示例工程完成该IP的仿真和上板。 1、生成Aurora8B10B IP 如下图所示&#xff0c;首先在vivado的IP catalog中输入Aurora 8B10B&#xff0c;双击该IP。 图1 查找Aurora 8B10…
阅读更多...
【Python】成功解决SyntaxError: invalid syntax

【Python】成功解决SyntaxError: invalid syntax

【Python】成功解决SyntaxError: invalid syntax 下滑即可查看博客内容 &#x1f308; 欢迎莅临我的个人主页 &#x1f448;这里是我静心耕耘深度学习领域、真诚分享知识与智慧的小天地&#xff01;&#x1f387; &#x1f393; 博主简介&#xff1a;985高校的普通本硕&am…
阅读更多...
cuda学习笔记（3）

cuda学习笔记（3）

一 CPU和GPU的区别 衡量处理器优劣的重要的两个指标&#xff1a; 延时性&#xff1a;同量的数据&#xff0c;所需要的处理时间 吞吐性&#xff1a;处理速度不快&#xff0c;但是每次处理量很大 GPU设计理念是最大化吞吐量&#xff0c;使用很小的控制单元对应很小的内存 cpu的设…
阅读更多...
类和对象（下+）_const成员、初始化列表、友元、匿名对象

类和对象（下+）_const成员、初始化列表、友元、匿名对象

类和对象&#xff08;下&#xff09; 文章目录 类和对象&#xff08;下&#xff09;前言一、const成员二、友元1.友元函数2.友元类 三、初始化列表四、explicit关键字五、匿名对象总结 前言 static成员、内部类、const成员、初始化列表、友元、匿名对象 一、const成员 将cons…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023