Spring Boot 自动配置之条件注解浅析

 更新时间:2019年02月20日 10:34:21   作者:来醉一场  
这篇文章主要介绍了Spring Boot 自动配置之条件注解浅析,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

Spring Boot 神奇的自动配置,主要依靠大量的条件注解来使用配置自动化。

根据满足某一个特定条件创建一个特定的Bean。比如说,在某些系统变量下创建Bean,或者只有在某个Bean创建后才去创建另外一个Bean. 就是根据条件来控制Bean的创建行为,可以利用该特性来进行一些自动配置。

一、常用的条件注解

  • @Conditional 依赖的条件
  • @ConditionalOnBean  在某个Bean存在的条件下
  • @ConditionalOnMissingBean 在某个Bean不存在的条件下
  • @ConditionalOnClass  在某个Class存在的条件下
  • @ConditionalOnMissingClass  在某个Class不存在的条件下

比较常见的是这些注解,还有其它的比如 @ConditionalOnWebApplication,@ConditionalOnProperty 等,可举一反三

二、特别说明 @Conditional 注解

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {

 /**
 * All {@link Condition Conditions} that must {@linkplain Condition#matches match}
 * in order for the component to be registered.
 */
 Class<? extends Condition>[] value();

}

使用@Conditional注解,对象需要实现Condition接口,Condition 接口是一个函数式接口

@FunctionalInterface
public interface Condition {

 boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

三、条件注解示例

示例场景:项目中动态的配置Mysql或者Oracle数据源

1. 定义配置文件

db-type=oracle

2. 定义Condition类

MySqlCondition.java

public class MySqlCondition implements Condition {

  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    return "mysql".equals(context.getEnvironment().getProperty("db-type"));
  }
}

OracleCondition.java

public class OracleCondition implements Condition {

  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    return "oracle".equals(context.getEnvironment().getProperty("db-type"));
  }
}

获取配置文件db-type的值

3. JdbcFactory接口

public interface JdbcFactory {

  void create();
}

4. 默认的Mysql和Oracle实现

Mysql

@ConditionalOnMissingBean(value = JdbcFactory.class, ignored = MySqlDefaultFactory.class)
@Conditional(MySqlCondition.class)
@Component
public class MySqlDefaultFactory implements JdbcFactory {

  @Override
  public void create() {
    System.out.println("Default MySql create ..");
  }

}

Oracle

@ConditionalOnMissingBean(value = JdbcFactory.class, ignored = OracleDefaultFactory.class)
@Conditional(OracleCondition.class)
@Component
public class OracleDefaultFactory implements JdbcFactory {

  @Override
  public void create() {
    System.out.println("Default oracle create..");
  }
}

5. 测试默认实现方式

@Resource
private JdbcFactory jdbcFactory;

@Test
public void conditionOnMissBean() {
  jdbcFactory.create();
}

结果:Default MySql create ..

6. 自定义实现方式

@Component
public class MysqlFactory implements JdbcFactory {

  @Override
  public void create() {
    System.out.println("mysql 。。 create");
  }
}

7. 测试

@Resource
private JdbcFactory jdbcFactory;

@Test
public void conditionOnMissBean() {
  jdbcFactory.create();
}

结果:mysql 。。 create

8.解析

当环境中不存在 JdbcFactory 的Bean时则使用默认的实现的方式,如例:没有自定义实现时,则默认使用MySqlDefaultFactory。这在自动化配置中会经常用到。比如redisTemplate 的默认实现

四、GitHub源码

源码地址

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • java文件复制代码片断(java实现文件拷贝)

    java文件复制代码片断(java实现文件拷贝)

    本文介绍java实现文件拷贝的代码片断,大家可以直接放到程序里运行
    2014-01-01
  • Linux下用java -jar运行可执行jar包的方法教程

    Linux下用java -jar运行可执行jar包的方法教程

    这篇文章主要给大家介绍了在Linux下用java -jar运行可执行jar包的方法教程,文中介绍的非常详细,相信对大家的工作或者学习具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
    2017-05-05
  • Spring中的ImportBeanDefinitionRegistrar接口详解

    Spring中的ImportBeanDefinitionRegistrar接口详解

    这篇文章主要介绍了Spring中的ImportBeanDefinitionRegistrar接口详解,ImportBeanDefinitionRegistrar接口是也是spring的扩展点之一,它可以支持我们自己写的代码封装成BeanDefinition对象,注册到Spring容器中,功能类似于注解@Service @Component,需要的朋友可以参考下
    2023-09-09
  • 解决Maven 项目报错 java.httpservlet和synchronized使用方法

    解决Maven 项目报错 java.httpservlet和synchronized使用方法

    下面小编就为大家带来一篇解决Maven 项目报错 java.httpservlet和synchronized使用方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • SpringBoot中@EnableAsync和@Async注解的使用小结

    SpringBoot中@EnableAsync和@Async注解的使用小结

    在SpringBoot中,可以通过@EnableAsync注解来启动异步方法调用的支持,通过@Async注解来标识异步方法,让方法能够在异步线程中执行,本文就来介绍一下,感兴趣的可以了解一下
    2023-11-11
  • Spring MVC简介_动力节点Java学院整理

    Spring MVC简介_动力节点Java学院整理

    Spring MVC属于SpringFrameWork的后续产品,已经融合在Spring Web Flow里面。今天先从写一个Spring MVC的HelloWorld开始,让我们看看如何搭建起一个Spring mvc的环境并运行程序,感兴趣的朋友一起学习吧
    2017-08-08
  • java注解的类型知识点总结

    java注解的类型知识点总结

    在本篇文章里小编给大家整理了一篇关于java注解的类型知识点总结内容,有兴趣的朋友们可以学习下。
    2021-03-03
  • spring循环注入异常问题的解决方案

    spring循环注入异常问题的解决方案

    今天小编就为大家分享一篇关于spring循环注入异常问题的解决方案,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Java Spring Security认证与授权及注销和权限控制篇综合解析

    Java Spring Security认证与授权及注销和权限控制篇综合解析

    Spring Security 是 Spring 家族中的一个安全管理框架,实际上,在 Spring Boot 出现之前,Spring Security 就已经发展了多年了,但是使用的并不多,安全管理这个领域,一直是 Shiro 的天下
    2021-10-10
  • Apache POI将PPT转换成图片实例代码

    Apache POI将PPT转换成图片实例代码

    这篇文章主要介绍了Apache POI将PPT转换成图片实例代码,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01

最新评论