【Spring高级】条件注解-程序员宅基地

技术标签: spring  # Spring高级  java  

Spring框架中的条件注解(Conditional Annotations)是一种强大的机制,它允许开发者根据特定的条件来决定是否创建某个bean。这种机制为Spring容器提供了更多的灵活性和控制力,使得开发者能够根据不同的环境或配置来动态地调整bean的创建。

条件注解的原理主要基于Spring的IoC容器和条件判断机制。当Spring容器启动时,它会扫描所有的bean定义,并检查是否存在条件注解。如果存在条件注解,Spring容器会根据注解中定义的条件来判断是否应该创建该bean。

具体来说,条件注解通常与一些条件类一起使用,这些条件类实现了Condition接口,并定义了具体的条件判断逻辑。在条件注解中,通过指定条件类的类名或使用其他条件表达式来定义条件。

当Spring容器扫描到带有条件注解的bean定义时,它会创建一个条件上下文(Condition Context),并将该上下文传递给条件类。条件类使用上下文中的信息来判断条件是否满足。如果条件满足,Spring容器就会创建该bean;否则,bean将不会被创建。

下面我们自己来创建一个条件注解。

首先创建我们自定义的注解:

@Retention(RetentionPolicy.RUNTIME)
@Target({
    ElementType.METHOD, ElementType.TYPE})
@Conditional(MyCondition.class)
@interface ConditionalOnClass {
    
    boolean exists(); // true 判断存在 false 判断不存在

    String className(); // 要判断的类名
}

创建条件类,它实现了Condition接口,以及他的matches方法:

static class MyCondition implements Condition {
    
        @Override
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    
            // 获取ConditionalOnClass的所有属性
            Map<String, Object> attributes = metadata.getAnnotationAttributes(ConditionalOnClass.class.getName());
            // 获取参数className
            String className = attributes.get("className").toString();
            // 获取参数exists
            boolean exists = (boolean) attributes.get("exists");
            // 检查类路径下是否存在指定类
            boolean present = ClassUtils.isPresent(className, null);
            // 如果要判断存在,返回上面的检查结果,否咋取反
            return exists ? present : !present;
        }
    }

上面的条件类,主要用来检查类路径下是否含有指定类名className。

然后使用的时候,在配置类上使用自定义注解即可,完整示例:

package com.cys.spring.chapter17;

import org.springframework.context.annotation.*;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.util.ClassUtils;

import java.io.IOException;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;

/**
 * @author Ethan
 * @date 2024/3/10
 * @description
 */
public class TestCondition {
    

    @SuppressWarnings("all")
    public static void main(String[] args) throws IOException {
    
        GenericApplicationContext context = new GenericApplicationContext();
        context.registerBean("config", Config.class);
        context.registerBean(ConfigurationClassPostProcessor.class);
        context.refresh();

        for (String name : context.getBeanDefinitionNames()) {
    
            System.out.println(name);
        }
    }

    @Configuration // 本项目的配置类
    @Import(MyImportSelector.class)
    static class Config {
    
    }

    static class MyImportSelector implements DeferredImportSelector {
    
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    
            return new String[]{
    AutoConfiguration1.class.getName(), AutoConfiguration2.class.getName()};
        }
    }

    /**
     * 条件类
     */
    static class MyCondition implements Condition {
     // 存在 Druid 依赖
        @Override
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    
            // 获取ConditionalOnClass的所有属性
            Map<String, Object> attributes = metadata.getAnnotationAttributes(ConditionalOnClass.class.getName());
            // 获取参数className
            String className = attributes.get("className").toString();
            // 获取参数exists
            boolean exists = (boolean) attributes.get("exists");
            // 检查类路径下是否存在指定类
            boolean present = ClassUtils.isPresent(className, null);
            // 如果要判断存在,返回上面的检查结果,否咋取反
            return exists ? present : !present;
        }
    }

    /**
     * 自定义条件注解
     */
    @Retention(RetentionPolicy.RUNTIME)
    @Target({
    ElementType.METHOD, ElementType.TYPE})
    @Conditional(MyCondition.class)
    @interface ConditionalOnClass {
    
        boolean exists(); // true 判断存在 false 判断不存在

        String className(); // 要判断的类名
    }

    @Configuration // 第三方的配置类
    @ConditionalOnClass(className = "com.alibaba.druid.pool.DruidDataSource", exists = false)
    static class AutoConfiguration1 {
    
        @Bean
        public Bean1 bean1() {
    
            return new Bean1();
        }
    }

    @Configuration // 第三方的配置类
    @ConditionalOnClass(className = "com.alibaba.druid.pool.DruidDataSource", exists = true)
    static class AutoConfiguration2 {
    
        @Bean
        public Bean2 bean2() {
    
            return new Bean2();
        }
    }

    static class Bean1 {
    

    }

    static class Bean2 {
    

    }


}

运行结果如下:

config
org.springframework.context.annotation.ConfigurationClassPostProcessor
com.cys.spring.chapter17.TestCondition$AutoConfiguration2
bean2

因为在Bean2的条件注解中,exists = true,且类路径下确实存在DruidDataSource,所以AutoConfiguration2可以自动装配,Bean2被创建。

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/qq_43745578/article/details/137800203

智能推荐

c# 调用c++ lib静态库_c#调用lib-程序员宅基地

文章浏览阅读2w次,点赞7次,收藏51次。四个步骤1.创建C++ Win32项目动态库dll 2.在Win32项目动态库中添加 外部依赖项 lib头文件和lib库3.导出C接口4.c#调用c++动态库开始你的表演...①创建一个空白的解决方案,在解决方案中添加 Visual C++ , Win32 项目空白解决方案的创建:添加Visual C++ , Win32 项目这......_c#调用lib

deepin/ubuntu安装苹方字体-程序员宅基地

文章浏览阅读4.6k次。苹方字体是苹果系统上的黑体,挺好看的。注重颜值的网站都会使用,例如知乎:font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, PingFang SC, Microsoft YaHei, Source Han Sans SC, Noto Sans CJK SC, W..._ubuntu pingfang

html表单常见操作汇总_html表单的处理程序有那些-程序员宅基地

文章浏览阅读159次。表单表单概述表单标签表单域按钮控件demo表单标签表单标签基本语法结构<form action="处理数据程序的url地址“ method=”get|post“ name="表单名称”></form><!--action,当提交表单时,向何处发送表单中的数据,地址可以是相对地址也可以是绝对地址--><!--method将表单中的数据传送给服务器处理,get方式直接显示在url地址中,数据可以被缓存,且长度有限制;而post方式数据隐藏传输,_html表单的处理程序有那些

PHP设置谷歌验证器(Google Authenticator)实现操作二步验证_php otp 验证器-程序员宅基地

文章浏览阅读1.2k次。使用说明:开启Google的登陆二步验证(即Google Authenticator服务)后用户登陆时需要输入额外由手机客户端生成的一次性密码。实现Google Authenticator功能需要服务器端和客户端的支持。服务器端负责密钥的生成、验证一次性密码是否正确。客户端记录密钥后生成一次性密码。下载谷歌验证类库文件放到项目合适位置(我这边放在项目Vender下面)https://github.com/PHPGangsta/GoogleAuthenticatorPHP代码示例://引入谷_php otp 验证器

【Python】matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距-程序员宅基地

文章浏览阅读4.3k次,点赞5次,收藏11次。matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距

docker — 容器存储_docker 保存容器-程序员宅基地

文章浏览阅读2.2k次。①Storage driver 处理各镜像层及容器层的处理细节,实现了多层数据的堆叠,为用户 提供了多层数据合并后的统一视图②所有 Storage driver 都使用可堆叠图像层和写时复制(CoW)策略③docker info 命令可查看当系统上的 storage driver主要用于测试目的,不建议用于生成环境。_docker 保存容器

随便推点

网络拓扑结构_网络拓扑csdn-程序员宅基地

文章浏览阅读834次,点赞27次,收藏13次。网络拓扑结构是指计算机网络中各组件(如计算机、服务器、打印机、路由器、交换机等设备)及其连接线路在物理布局或逻辑构型上的排列形式。这种布局不仅描述了设备间的实际物理连接方式,也决定了数据在网络中流动的路径和方式。不同的网络拓扑结构影响着网络的性能、可靠性、可扩展性及管理维护的难易程度。_网络拓扑csdn

JS重写Date函数,兼容IOS系统_date.prototype 将所有 ios-程序员宅基地

文章浏览阅读1.8k次,点赞5次,收藏8次。IOS系统Date的坑要创建一个指定时间的new Date对象时,通常的做法是:new Date("2020-09-21 11:11:00")这行代码在 PC 端和安卓端都是正常的,而在 iOS 端则会提示 Invalid Date 无效日期。在IOS年月日中间的横岗许换成斜杠,也就是new Date("2020/09/21 11:11:00")通常为了兼容IOS的这个坑,需要做一些额外的特殊处理,笔者在开发的时候经常会忘了兼容IOS系统。所以就想试着重写Date函数,一劳永逸,避免每次ne_date.prototype 将所有 ios

如何将EXCEL表导入plsql数据库中-程序员宅基地

文章浏览阅读5.3k次。方法一:用PLSQL Developer工具。 1 在PLSQL Developer的sql window里输入select * from test for update; 2 按F8执行 3 打开锁, 再按一下加号. 鼠标点到第一列的列头,使全列成选中状态,然后粘贴,最后commit提交即可。(前提..._excel导入pl/sql

Git常用命令速查手册-程序员宅基地

文章浏览阅读83次。Git常用命令速查手册1、初始化仓库git init2、将文件添加到仓库git add 文件名 # 将工作区的某个文件添加到暂存区 git add -u # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,不处理untracked的文件git add -A # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,包括untracked的文件...

分享119个ASP.NET源码总有一个是你想要的_千博二手车源码v2023 build 1120-程序员宅基地

文章浏览阅读202次。分享119个ASP.NET源码总有一个是你想要的_千博二手车源码v2023 build 1120

【C++缺省函数】 空类默认产生的6个类成员函数_空类默认产生哪些类成员函数-程序员宅基地

文章浏览阅读1.8k次。版权声明:转载请注明出处 http://blog.csdn.net/irean_lau。目录(?)[+]1、缺省构造函数。2、缺省拷贝构造函数。3、 缺省析构函数。4、缺省赋值运算符。5、缺省取址运算符。6、 缺省取址运算符 const。[cpp] view plain copy_空类默认产生哪些类成员函数

推荐文章

热门文章

相关标签