聊聊SpringBoot自动装配的魔力


Posted in Java/Android onNovember 17, 2021

一、 springBoot自动配置的好处

1、 回想一下当你在使用spring来搭建一个项目的时候

你需要编写很多的有关spring的xml。例如读取属性配置的bean、数据源bean、事务管理工厂bean、mybatis与spring整个的bean等等。再次利用该框架搭建项目的时候,又是周而复始的操作。

但是现在当你使用springBoot搭建项目的时候,你会发现所有的配置你都不用去编写就可以帮你去实现(仅仅需要在连接外部数据库的时候需要进行配置,其实如果使用内嵌数据库h2 则你完全不必需要application.properties配置文件)。

你可以在你的具体的业务代码中使用@AutoWried @Resource注解将数据源,事务工厂等注入到业务层,像是你自己配置那样。

2、这时我们会有一个疑问

springBoot到底做了什么让我们可以不用配置,而使用那些功能对象。

其实springBoot使用基于条件的自动注入原理,即为当满足某个条件的时候,spring会实例化该注解对应的bean,将其放入到Srping上下文中,让你可以轻松的使用。SpringBoot实现条件配置离不开它的核心组件@Conditional。

下面我们慢慢的来揭开springBoot自动配置的神秘面纱。

二、@Conditional注解相关介绍

1、@Conditional小demo

@Conditional 是个什么鬼,不解释来个小的demo大致了解一下

描述一下demo场景 :Life实体bean在特定条件(@Conditional)下,被springBoot初始化,并放置到spring上下文环境中。

1.1、 Life 实体类

/**
 * 梦想存在,生命才有意义
 */
public class Life {
    //工作 
    private String work;
    //学习
    private String study
    //爱
    private String love;
 
  //省略seter /geter
 
}

1.2、 编写我们自己的条件匹配规则

/**
 * 实现ConfigurationCondition(该接口继承了Condition)
 */
public class MyTestConditional implements ConfigurationCondition {
    /**
     * 设置使用该类进行解析的时机
     * 1、REGISTER_BEAN:会在注册Bean的时候进行condition的解析
     *  即为在对应的@Bean注解和@condition注解组合使用的时候 进行条件的判断
     *  @Bean注解对应spring 的xml的<bean/>标签
     * 2、PARSE_CONFIGURATION:会在解析@Configuration时进行condition的解析
     *    即为在对应的@Configuration注解和@condition注解组合使用的时候 进行条件的判断
     *    @Configuration注解对应spring 的xml的<beans/>标签
     * @return
     */
    @Override
    public ConfigurationPhase getConfigurationPhase() {
        return ConfigurationPhase.REGISTER_BEAN;
    }
    /**
     * 该方法为条件判断的核心 只有该方法返回为true 则表示其条件成立 ,执行相应的配置
     * @param conditionContext
     * @param annotatedTypeMetadata
     * @return
     */
    @Override
    public boolean matches(ConditionContext conditionContext, 
    AnnotatedTypeMetadata annotatedTypeMetadata) {
              return false;  //表示验证不通过
    }

该类实现了ConfigurationCondition 有如下两个方法

1、 getConfigurationPhase() 该条件规则起作用的时候

2、 matches()条件匹配规则 这里为了演示不做具体的逻辑条件的处理

返回一个布尔值,如果为ture 则表示条件成立 配置生效

反之不生效。

1.3、编写我们的java实例bean自动配置

@Configuration
//@Configuration标注在类上,相当于把该类作为spring的xml配置文件中的<beans>,
// 作用为:配置spring容器(应用上下文)
public class ServerAutoConfiguration {
 
    @Configuration  //spring的xml配置文件中的<beans>
    //使用该注解表明,在springBoot启动的时候只有满足MyTestConditional.class 才生成对应的Life 对象
    //即 MyTestConditional中的match()返回true @Bean生效
    @Conditional(MyTestConditional.class)
    public static class StudentAutoConfiguration {
        @Bean
        public Life create() {
            System.out.println("life start....");
            return new Life("努力工作","不断的学习","敢爱敢恨");
        }
    }
}

1.4、 springBoot的单元测试

//使用Spring的单元测试环境
@RunWith(SpringRunner.class)
//将SpringBoot的上下文环境加载进入单元测试中
@SpringBootTest(classes = AutoApplication.class)
public class AutoApplicationTests {
   //注入springBoot 基于条件的实例化bean
   @Autowired
   private Life life;
   @Test
   public void showlife() {
      System.out.println("生命的全部:"+life.toString());
   }
}

启动springBoot项目,在控制台中没有发现Life对象被创建 且单元测试中无法注入Life

在修改了MyTestConditional中的match() 返回true 再次启动则Life对象被创建

聊聊SpringBoot自动装配的魔力

同时使用SpringBoot的单元测试来使用springBoot为我们设置的Life实体

该实体创建流程如下:当springBoot项目启动的时候,会加载@Configuration(srping的xml配置)下的所有bean,当遇到@Conditional(MyTestConditional.class) 会调用该方法的Match,并根据其返回值来判断是否实例化该注解下的所有使用@Bean @Import 注解下的类

三、自定义一个条件配置类/springBoot自定义注解

1、简单解释@Condition注解家族

(1)、@Conditional

官方文档定义:

“Indicates that a component is only eligible for registration when all specified conditions match”

意思是只有满足一些列条件之后创建一个bean。 并注册到spring的上下文环境中

(2)、SpringBoot提供的

  • @ConditionalOnWebApplication 该应用必须为web应用
  • @ConditionalOnMissingBean 该应用上下文中如果没有指定的bean
  • @ConditionalOnBean 该应用上下文中如果有指定的bean
  • @ConditionalOnProperty(name,value) 只有存在对应name的value的配置文件才加载该注解下的bean
  • @ConditionalOnCloudPlatform 匹配当处于云平台环境中时后
  • @ConditionalOnClass 该classpath中如果有指定的bean @ConditionalOnExpression 如果对应的表达式成立 成功
  • @ConditionalOnJava 根据应用程序运行的JVM版本进行匹配 成功
  • @ConditionalOnRepositoryType 当特定类型的spring Data JPA启用的时候 成功
  • @ConditionalOnSingleCandidate 当特定的class对应的bean存在且唯一确定的时候
  • @ConditionalOnJndi 通过JNDI查找制定的条件
  • @Profile 通过特定的条件触发 (生产环境使用该配置,非生产环境则不是使用)
  • @ConditionalOnResource 从资源文件中查询
  • @ConditionalOnEnabledResourceChain 从资源链中中查询
  • @ConditionalOnNotWebApplication 如果改应用不是web应用,则该条件起作用
  • @ConditionalOnMissingClass 如果不存在对应的class则创建该对应的bean

满足条件后则加载该注解作用下的类起作用

(3)、所谓该注解作用下的类起作用是指

这些注解都有如下两种使用方式

1、作用在类上,则该类下的所有@Bean注解起作用 (条件成立,加载该注解下的所有@Bean的实体类 存放在spring上下文中)

2、作用在方法上 则该方法下对应的@bean注解起作用 (条件成立,加载该注解下使用@Bean的实体类 存放在spring上下文中)

与@Configuration或者@Bean配合使用,当和@Configuration配合使用时,

那么该类下所有@Bean方法 或者@Import 或者 @ComponentScan都会受到其配置条件的影响

  • @Configuration 相当于spring的xml配置文件的<beans>标签
  • @Bean 注解相当于spring的xml配置文件的<bean>标签
  • @Import(Xxx.class)将指定的class 实例注入到spring的上下文中
  • @Configuration标注在类上,相当于把该类作为spring的xml配置文件中的<beans>,作用为:配置spring容器(应用上下文)

2、自定义条件注解

结合demo 来设置一个自定义注解

(1)、 自定义注解

/*
  自定义的Conditional 条件注解
 */
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(MyTestConditional.class)
public @interface ConditionalOnLife {
    Class<?>[] value() default {};
    String[] name() default {};}

(2)、进行配置使用

@Configuration  //spring的xml配置文件中的<beans>
//使用该注解表明,在springBoot启动的时候只有满足MyTestConditional.class 才生成对应的Life 对象
//自定义的条件注解
@ConditionalOnLife
//@Conditional(MyTestConditional.class)
public static class DreamAutoConfiguration {
    @Bean
    public Dream createDream() {
        //life.toString();
        System.out.println("dream start....");
        return new Dream();
    }
}

后台调用成功创建了Dream实体 并放入spring上下文环境中

以上为个人经验,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Java/Android 相关文章推荐
浅谈Java实现分布式事务的三种方案
Jun 11 Java/Android
Java多条件判断场景中规则执行器的设计
Jun 26 Java/Android
Spring整合Mybatis的全过程
Jun 28 Java/Android
详解Java七大阻塞队列之SynchronousQueue
Sep 04 Java/Android
MyBatis-Plus 批量插入数据的操作方法
Sep 25 Java/Android
JAVA API 实用类 String详解
Oct 05 Java/Android
MybatisPlus EntityWrapper如何自定义SQL
Mar 22 Java/Android
spring注解 @PropertySource配置数据源全流程
Mar 25 Java/Android
Java8 Stream API 提供了一种高效且易于使用的处理数据的方式
Apr 13 Java/Android
MyBatis在注解上使用动态SQL方式(@select使用if)
Jul 07 Java/Android
IDEA中sout快捷键无效问题的解决方法
Jul 23 Java/Android
Springboot如何同时装配两个相同类型数据库
Nov 17 #Java/Android
OpenCV实现普通阈值
聊聊Lombok中的@Builder注解使用教程
Nov 17 #Java/Android
springboot 多数据源配置不生效遇到的坑及解决
Nov 17 #Java/Android
深入解读Java三大集合之map list set的用法
详解JAVA的控制语句
Nov 11 #Java/Android
Java 实战项目之家居购物商城系统详解流程
Nov 11 #Java/Android
You might like
PHP连接SQLServer2005方法及代码
2013/12/26 PHP
php实现与erlang的二进制通讯实例解析
2014/07/23 PHP
php实现的微信红包算法分析(非官方)
2015/09/25 PHP
PHP文件下载实例代码浅析
2016/08/17 PHP
谈谈php对接芝麻信用踩的坑
2016/12/01 PHP
php异步:在php中使用fsockopen curl实现类似异步处理的功能方法
2016/12/10 PHP
php输出反斜杠的实例方法
2019/09/19 PHP
JQuery Tips(3) 关于$()包装集内元素的改变
2009/12/14 Javascript
基于jquery的图片幻灯展示源码
2012/07/15 Javascript
JavaScript实现拼音排序的方法
2012/11/20 Javascript
JS在TextArea光标位置插入文字并实现移动光标到文字末尾
2013/06/21 Javascript
jquery实现邮箱自动补全功能示例分享
2014/02/17 Javascript
Seajs的学习笔记
2014/03/04 Javascript
纯JavaScript实现获取onclick、onchange等事件的值
2014/12/29 Javascript
javascript实现全角半角检测的方法
2015/07/23 Javascript
Bootstrap组件系列之福利篇几款好用的组件(推荐)
2016/06/23 Javascript
移动端点击图片放大特效PhotoSwipe.js插件实现
2016/08/25 Javascript
js实现点击每个li节点,都弹出其文本值及修改
2016/12/15 Javascript
微信小程序 wx.login解密出现乱码的问题解决办法
2017/03/10 Javascript
bootstrap3使用bootstrap datetimepicker日期插件
2017/05/24 Javascript
详解vue.js之绑定class和style的示例代码
2017/08/24 Javascript
JS实现简单的浮动碰撞效果示例
2017/12/28 Javascript
Python实现拼接多张图片的方法
2014/12/01 Python
详谈python http长连接客户端
2017/06/12 Python
浅谈Python对内存的使用(深浅拷贝)
2018/01/17 Python
Python序列循环移位的3种方法推荐
2018/04/09 Python
APIStar:一个专为Python3设计的API框架
2018/09/26 Python
对python中字典keys,values,items的使用详解
2019/02/03 Python
Tensorflow分类器项目自定义数据读入的实现
2019/02/05 Python
html5使用canvas画空心圆与实心圆
2014/12/15 HTML / CSS
实例讲解使用SVG制作loading加载动画的方法
2016/04/05 HTML / CSS
解释一下抽象方法和抽象类
2016/08/27 面试题
大学四年个人自我小结
2014/03/05 职场文书
本科应届生求职信
2014/08/05 职场文书
机关作风建设工作总结
2014/10/23 职场文书
Vue全局事件总线你了解吗
2022/02/24 Vue.js