springboot原理实战(7)--使用Conditional实现按条件注入bean

简介: springboot原理实战(7)--使用Conditional实现按条件注入bean

目录


本系列博客第一篇就是如何利用spring4+注解方式注入bean,在springboot中提供了按照条件方式注入,我们可以按照条件选择注入或者不注入bean。

本篇博客的内容概要:

1dc618a0ed9580ce8bfa6facb208c08f.png


一、Conditional按照条件注入bean原理


看下Conditional注解源码,它有个value属性类型就是condition的。

5d4c6812c8535adbb050f4ddf2e1bce8.png

看下Condition接口源码:

46a9d80a6e05e4e3b19d57a0ee70bcdf.png

这个接口只有一个方法,是否匹配的matches方法,返回boolean类型。


所以Conditional注解 能够提供基于条件的自动配置,一般配合Condition接口(1个或多个)一起使用,只有接口的实现类都返回true,才装配,否则不装配.。

现在我们自定义一个condition实现类来,结合conditional注解,来切换是否能注入bean。


二、自定义condition接口注入bean


案例:根据代码的字符集。 判断是否注入我们自己定义的bean。

字符集转换接口:


public interface EncodingConvert {
}


有2个实现类:


public class GbkEncodinConvert implements EncodingConvert{
}


public class Utf8EncodingConvert implements EncodingConvert {
}


然后分别写2个condition条件,来切换是否能注入bean的实现类:


public class GbkCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String encoding = System.getProperty("file.encoding");
        if (encoding != null){
            return "gbk".equals(encoding.toLowerCase());
        }
        return false;
    }
}


public class Utf8Condition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String encoding = System.getProperty("file.encoding");
        if (encoding != null){
            return "utf-8".equals(encoding.toLowerCase());
        }
        return false;
    }
}


写个配置类,在配置类里装载bean:


@SpringBootConfiguration
public class EncodingConvertConfiguration {
    @Bean
    @Conditional(Utf8Condition.class)
    public EncodingConvert createUtf8EncodingConvert(){
        return new Utf8EncodingConvert();
    }
    @Bean
    @Conditional(GbkCondition.class)
    public EncodingConvert createGbkEncodinConvert(){
        return new GbkEncodinConvert();
    }
}


可以看到上面的装载方式都加了个条件,@Conditional,参数内容为

根据System.getProperty("file.encoding")的值来判断,是否装载,如果是utf-8就装载createUtf8EncodingConvert类,如果是gbk就装载createGbkEncodinConvert这个类。


我们进入入口函数测试下:


@SpringBootApplication
public class Demo4Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(Demo4Application.class, args);
        System.out.println(System.getProperty("file.encoding"));
        System.out.println(context.getBeansOfType(EncodingConvert.class));
        context.close();
    }
}


打印结果:

1dc618a0ed9580ce8bfa6facb208c08f.png

显示注入了bean,因为编码字符集是UTF-8。

我们切换下参数:再试下:

5d4c6812c8535adbb050f4ddf2e1bce8.png

打印结果:

46a9d80a6e05e4e3b19d57a0ee70bcdf.png


同时我们也可以将@Conditional条件放在类上,因为@Conditional的value是个集合,所以可以指定多个,这些条件都满足才能装载类里面的bean:


@SpringBootConfiguration
@Conditional({Utf8Condition.class,GbkCondition.class})
public class EncodingConvertConfiguration {
    @Bean
    public EncodingConvert createUtf8EncodingConvert(){
        return new Utf8EncodingConvert();
    }
    @Bean
    public EncodingConvert createGbkEncodinConvert(){
        return new GbkEncodinConvert();
    }
}


打印结果,因为类的条件为false,所以没有装载bean。

1dc618a0ed9580ce8bfa6facb208c08f.png

我们改成类的条件为true的情况:


@SpringBootConfiguration
@Conditional({Utf8Condition.class})
public class EncodingConvertConfiguration {
    @Bean
    public EncodingConvert createUtf8EncodingConvert(){
        return new Utf8EncodingConvert();
    }
    @Bean
    public EncodingConvert createGbkEncodinConvert(){
        return new GbkEncodinConvert();
    }
}


再次运行入口函数,发现类下的2个bean都被注入了:

5d4c6812c8535adbb050f4ddf2e1bce8.png


三、springboot提供的@Conditional工具类


上面是我们自己定义的@Conditional参数中的condition实现类,其实springboot也提供了很多的实用的@Conditional工具类,我们可以直接去使用就可以。

在里面有很多的condition实现类:

46a9d80a6e05e4e3b19d57a0ee70bcdf.png

注解 说明

@ConditionalOnSingleCandidate 当给定类型的bean存在并且指定为Primary的给定类型存在时,返回true

@ConditionalOnMissingBean 当给定的类型、类名、注解、昵称在beanFactory中不存在时返回true.各类型间是or的关系

@ConditionalOnBean 与上面相反,要求bean存在

@ConditionalOnMissingClass 当给定的类名在类路径上不存在时返回true,各类型间是and的关系

@ConditionalOnClass 与上面相反,要求类存在

@ConditionalOnCloudPlatform 当所配置的CloudPlatform为激活时返回true

@ConditionalOnExpression spel表达式执行为true

@ConditionalOnJava 运行时的java版本号是否包含给定的版本号.如果包含,返回匹配,否则,返回不匹配

@ConditionalOnProperty 要求配置属性匹配条件

@ConditionalOnJndi 给定的jndi的Location 必须存在一个.否则,返回不匹配

@ConditionalOnNotWebApplication web环境不存在时

@ConditionalOnWebApplication web环境存在时

@ConditionalOnResource 要求制定的资源存在

现在我们使用几个测试下


1.@ConditionalOnProperty


某个属性等于某个值的时候才装配。


@SpringBootConfiguration
public class UserConfiguration {
    //某个属性等于某个值的时候才装配
    @Bean
    @ConditionalOnProperty(name="runable.enabled",havingValue = "true")
    public Runnable createRunable(){
        return  () -> {};
    }
 }


这个例子是 如果有runable.enabled这个属性,并且值为true就注入,我们测试下:


@SpringBootApplication
public class Demo4Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(Demo4Application.class, args);
        System.out.println(context.getBeansOfType(Runnable.class));
        context.close();
    }
}


运行结果:显示没有装载。


我们在application.properties添加runable.enabled=true


runable.enabled=true

再次测试,显示已经装载进来了:


@ConditionalOnProperty还有个属性matchIfMissing,没有这个属性的时候,让条件变为true或false。


我们做个测试,让其他变为true,同时删除配置文件中的runable.enabled=false这行代码:


@SpringBootConfiguration
public class UserConfiguration {
    //某个属性等于某个值得时候才装配
    @Bean
    @ConditionalOnProperty(name="runable.enabled",havingValue = "true",matchIfMissing = true)
    public Runnable createRunable(){
        return  () -> {};
    }
 }


测试下,在缺少配置文件属性的情况下也注入进来了:

1dc618a0ed9580ce8bfa6facb208c08f.png


2.@ConditionalOnClass


@SpringBootConfiguration
public class UserConfiguration {
    //表示 classpath中存在某个class的时候才装配
    @Bean
    @ConditionalOnClass(name="com.google.gson.Gson")
    public Runnable createGsonRunable(){
        return  () -> {};
    }
 }


我们判断如果项目有这个Gson类就加载否则不加载,现在项目jar里面没有的,应该不注入,我们看下效果:


@SpringBootApplication
public class Demo4Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(Demo4Application.class, args);
        System.out.println(context.getBeansOfType(Runnable.class));
        context.close();
    }
}


1dc618a0ed9580ce8bfa6facb208c08f.png运行结果:的确没注入进来。


现在我们让他注入进来,在pom.xml中引入gson包

<dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.6</version>
        </dependency>


再次运行,显示已经注入进来了:


1dc618a0ed9580ce8bfa6facb208c08f.png


3.@ConditionalOnBean


根据容器中是否存在某个bean来进行装配


@SpringBootConfiguration
public class UserConfiguration {
    //根据容器中是否存在某个bean来进行装配
    @Bean
    @ConditionalOnBean(name="user")
    public Runnable createUserRunable(){
        return  () -> {};
    }
 }


目前项目中没有名字为user的bean,我们打印测试下:

1dc618a0ed9580ce8bfa6facb208c08f.png

的确没注入。

我们写个user的bean:


@Component
public class User {
}


再次测试,显示注入了。

5d4c6812c8535adbb050f4ddf2e1bce8.png

本文的所有内容已经完毕,主要就是按照条件转载bean,可以自定义和使用springboot提供的一些实用的工具类来为我所用。在以后的工作中,具体的类再具体了解吧。


相关文章
|
4天前
|
Dart 前端开发 JavaScript
springboot自动配置原理
Spring Boot 自动配置原理:通过 `@EnableAutoConfiguration` 开启自动配置,扫描 `META-INF/spring.factories` 下的配置类,省去手动编写配置文件。使用 `@ConditionalXXX` 注解判断配置类是否生效,导入对应的 starter 后自动配置生效。通过 `@EnableConfigurationProperties` 加载配置属性,默认值与配置文件中的值结合使用。总结来说,Spring Boot 通过这些机制简化了开发配置流程,提升了开发效率。
38 17
springboot自动配置原理
|
2月前
|
XML Java 开发者
Spring Boot开箱即用可插拔实现过程演练与原理剖析
【11月更文挑战第20天】Spring Boot是一个基于Spring框架的项目,其设计目的是简化Spring应用的初始搭建以及开发过程。Spring Boot通过提供约定优于配置的理念,减少了大量的XML配置和手动设置,使得开发者能够更专注于业务逻辑的实现。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,为开发者提供一个全面的理解。
49 0
|
1月前
|
Java 数据库连接 Maven
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
自动装配是现在面试中常考的一道面试题。本文基于最新的 SpringBoot 3.3.3 版本的源码来分析自动装配的原理,并在文未说明了SpringBoot2和SpringBoot3的自动装配源码中区别,以及面试回答的拿分核心话术。
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
|
1月前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
113 14
|
2月前
|
Java Spring
SpringBoot自动装配的原理
在Spring Boot项目中,启动引导类通常使用`@SpringBootApplication`注解。该注解集成了`@SpringBootConfiguration`、`@ComponentScan`和`@EnableAutoConfiguration`三个注解,分别用于标记配置类、开启组件扫描和启用自动配置。
69 17
|
2月前
|
Java 容器
springboot自动配置原理
启动类@SpringbootApplication注解下,有三个关键注解 (1)@springbootConfiguration:表示启动类是一个自动配置类 (2)@CompontScan:扫描启动类所在包外的组件到容器中 (3)@EnableConfigutarion:最关键的一个注解,他拥有两个子注解,其中@AutoConfigurationpackageu会将启动类所在包下的所有组件到容器中,@Import会导入一个自动配置文件选择器,他会去加载META_INF目录下的spring.factories文件,这个文件中存放很大自动配置类的全类名,这些类会根据元注解的装配条件生效,生效
|
2月前
|
前端开发 Java 数据格式
SpringBoot中定义Bean的几种方式
本文介绍了Spring Boot中定义Bean的多种方式,包括使用@Component、@Bean、@Configuration、@Import等注解及Java配置类。每种方式适用于不同的场景,帮助开发者高效管理和组织应用组件。
|
1天前
|
JavaScript Java 测试技术
基于SpringBoot+Vue实现的留守儿童爱心网站设计与实现(计算机毕设项目实战+源码+文档)
博主是一位全网粉丝超过100万的CSDN特邀作者、博客专家,专注于Java、Python、PHP等技术领域。提供SpringBoot、Vue、HTML、Uniapp、PHP、Python、NodeJS、爬虫、数据可视化等技术服务,涵盖免费选题、功能设计、开题报告、论文辅导、答辩PPT等。系统采用SpringBoot后端框架和Vue前端框架,确保高效开发与良好用户体验。所有代码由博主亲自开发,并提供全程录音录屏讲解服务,保障学习效果。欢迎点赞、收藏、关注、评论,获取更多精品案例源码。
27 10
|
1天前
|
JavaScript Java 测试技术
基于SpringBoot+Vue实现的家政服务管理平台设计与实现(计算机毕设项目实战+源码+文档)
面向大学生毕业选题、开题、任务书、程序设计开发、论文辅导提供一站式服务。主要服务:程序设计开发、代码修改、成品部署、支持定制、论文辅导,助力毕设!
20 8
|
1天前
|
JavaScript 搜索推荐 Java
基于SpringBoot+Vue实现的家乡特色推荐系统设计与实现(源码+文档+部署)
面向大学生毕业选题、开题、任务书、程序设计开发、论文辅导提供一站式服务。主要服务:程序设计开发、代码修改、成品部署、支持定制、论文辅导,助力毕设!
19 8