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提供的一些实用的工具类来为我所用。在以后的工作中,具体的类再具体了解吧。


相关文章
|
2天前
|
Java 开发者 Spring
Springboot中的@Bean用法以及常见问题
【5月更文挑战第27天】@Bean 注解是Spring框架中用于声明Spring应用上下文中的bean的一种方式。在Spring Boot中,@Bean注解通常与@Configuration注解一起使用,在配置类(Configuration class)中定义bean。
16 2
|
13天前
|
Java 开发者 Spring
springboot @RequiredArgsConstructor @Lazy解决循环依赖的原理
【5月更文挑战第16天】在Spring Boot中,@RequiredArgsConstructor 和 @Lazy 是两个有用的注解,它们分别用于简化构造函数的生成和控制Bean的加载时间。下面详细解析这两个注解的概念、优缺点以及在实际应用中的示例。
35 1
|
13天前
|
Java 开发者 Spring
springboot DDD的概念以及实战
【5月更文挑战第15天】领域驱动设计(Domain-Driven Design,简称DDD)是一种软件设计方法论,它强调基于业务领域的复杂性来构建软件
37 2
|
14天前
|
开发框架 监控 Java
深入探索Spring Boot的监控、管理和测试功能及实战应用
【5月更文挑战第14天】Spring Boot是一个快速开发框架,提供了一系列的功能模块,包括监控、管理和测试等。本文将深入探讨Spring Boot中监控、管理和测试功能的原理与应用,并提供实际应用场景的示例。
21 2
|
14天前
|
XML Java 开发者
springboot 启动原理、启动过程、启动机制的介绍
【5月更文挑战第13天】Spring Boot 是一种基于 Java 的框架,用于创建独立的、生产级别的 Spring 应用程序。它的主要目标是简化 Spring 应用的初始搭建和开发过程,同时提供一系列大型项目常见的非功能性特征(如嵌入式服务器、安全性、度量、健康检查和外部化配置)。
30 3
|
14天前
|
Java 应用服务中间件 测试技术
深入探索Spring Boot Web应用源码及实战应用
【5月更文挑战第11天】本文将详细解析Spring Boot Web应用的源码架构,并通过一个实际案例,展示如何构建一个基于Spring Boot的Web应用。本文旨在帮助读者更好地理解Spring Boot的内部工作机制,以及如何利用这些机制优化自己的Web应用开发。
41 3
|
14天前
|
安全 Java 开发者
深入理解Spring Boot配置绑定及其实战应用
【4月更文挑战第10天】本文详细探讨了Spring Boot中配置绑定的核心概念,并结合实战示例,展示了如何在项目中有效地使用这些技术来管理和绑定配置属性。
21 1
|
14天前
|
Java Spring 容器
深入理解Spring Boot启动流程及其实战应用
【5月更文挑战第9天】本文详细解析了Spring Boot启动流程的概念和关键步骤,并结合实战示例,展示了如何在实际开发中运用这些知识。
27 2
|
14天前
|
JavaScript Java 开发者
Spring Boot中的@Lazy注解:概念及实战应用
【4月更文挑战第7天】在Spring Framework中,@Lazy注解是一个非常有用的特性,它允许开发者控制Spring容器的bean初始化时机。本文将详细介绍@Lazy注解的概念,并通过一个实际的例子展示如何在Spring Boot应用中使用它。
27 2
|
14天前
|
XML Java 数据库
【SpringBoot:详解Bean装配】
【SpringBoot:详解Bean装配】
12 3