【Spring杂烩】初探Spring的条件装配

2024-01-14 12:38
文章标签 java 条件 spring 初探 装配 杂烩

本文主要是介绍【Spring杂烩】初探Spring的条件装配，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

初尝Spring的条件装配

为了了解SpringBoot自动化装配的机制，所以必须先了解Spring的一些基础，Spring的条件装配就是其中之一

  • 前提概要
    • 条件装配知识脑图
    • 条件装配的定义
    • 条件装配的实现
    • 条件装配的作用
    • 条件装配的应用
  • 条件装配的源码体现
    • 注解模式
    • 编程模式
  • 自定义条件装配
    • 注解模式
    • 编程模式
  • 参考资料

前提概要

条件装配知识脑图
条件装配的定义
  • Bean装配的前置条件判断
  • 简而言之就是根据条件来判断这个Bean是否要被Spring容器装配
条件装配的实现

条件装配有两种实现方式：

  • 注解模式：@Profile
  • 编程模式：@Conditional
条件装配的作用

可以根据条件来选择是否需要在Spring容器中装配这个Bean，比如说：

  • 当Servlet依赖没有的时候，不装配WebMvc的各种Bean
  • 当某个Bean已经不存在的时候，就不重复装配
  • 根据不同的系统环境，装配不同的Bean
  • …
条件装配的应用
  • Spring Framework
    @Profile
    …
  • Spring Boot
    @ConditionalOnMissingBean
    @ConditionalOnClass
    …

条件装配的源码体现

注解模式

…这个没什么好说的，@Profile貌似使用的比较少，但是我们通常也知道一个SpringBoot多环境配置的特性，可以通过注解模式实现。但是在Spring 4.0开始，@Profile模式被修改过，实际的底层实现依然是编程模式

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ProfileCondition.class)
public @interface Profile {/*** The set of profiles for which the annotated component should be registered.*/String[] value();}

从源码中，我们可以看到，它使用了编程模式的@Conditional注解，并指定了一个Condition接口的实现类ProfileCondition

编程模式

我们就从@ConditionalOnMissingBean（是否存在某个Bean）说起。

第一步，在IDE中寻找了一下，使用了@ConditionalOnMissingBean的地方，我们就从spring boot的webmvc的配置类开始说起 WebMvcAutoConfiguration

@Configuration
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,TaskExecutionAutoConfiguration.class, ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {}

我们看到 WebMvcAutoConfiguration配置类的定义，可以看到，类上是有@ConditionalOnMissingBean注解的声明，并且指定了一个类WebMvcConfigurationSupport，意思就是说当Spring容器中没有WebMvcConfigurationSupport这个Bean的时候，就会装配WebMvcAutoConfiguration 配置类

第二步，我们看check一下@ConditionalOnMissingBean注解的源码

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)
public @interface ConditionalOnMissingBean {Class<?>[] value() default {};String[] type() default {};Class<?>[] ignored() default {};String[] ignoredType() default {};Class<? extends Annotation>[] annotation() default {};String[] name() default {};SearchStrategy search() default SearchStrategy.ALL;Class<?>[] parameterizedContainer() default {};
}

嗯，成员属性还挺多的，但我们也注意到注解的声明中，存在@Conditional注解，其指定了一个Condition接口的实现类OnBeanCondition.

第三步,我们查看一下@Conditional注解指向的实现类OnBeanCondition. Oh~,它还蛮复杂的，所以我们只能简化一下，只看与Condition接口相关的方法，最后发现OnBeanCondition类，最终是通过继承SpringBootCondition去实现Condition方法的，为了方便理解，这里放了结构图：
在这里插入图片描述

第四步，寻找matchs()方法，发现是由SpringBootContidion实现的（SpringBootContidion就是SpringBoot对Condition的再封装）

	@Overridepublic final boolean matches(ConditionContext context,AnnotatedTypeMetadata metadata) {String classOrMethodName = getClassOrMethodName(metadata);try {//如何获取ConditionOutcome outcome = getMatchOutcome(context, metadata);logOutcome(classOrMethodName, outcome);recordEvaluation(context, classOrMethodName, outcome);//重点return outcome.isMatch();}catch (NoClassDefFoundError ex) {throw new IllegalStateException("Could not evaluate condition on " + classOrMethodName + " due to "+ ex.getMessage() + " not "+ "found. Make sure your own configuration does not rely on "+ "that class. This can also happen if you are "+ "@ComponentScanning a springframework package (e.g. if you "+ "put a @ComponentScan in the default package by mistake)",ex);}catch (RuntimeException ex) {throw new IllegalStateException("Error processing condition on " + getName(metadata), ex);}}

以上是SpringBootCondition实现的matches方法，OnBeanCondition继承了下来。我们可以看到这个方法的返回值是通过outcome.isMatch(),而这个outcome又是通过getMatchOutcome()方法获取的，这个方法又是谁的呢?是SpringBootCondition抽象类的抽象方法，最终是OnBeanCondition实现的

第五步，查看OnBeanCondition的getMatchOutcome()方法，发现…emmm，更加复杂了。那就再简化简化

  • 总之这个方法会判断传入的metadate是不是ConditionalOnMissingBean注解类型，类似switch的功能，判断好久跳转到对应的逻辑块执行.
  • 然后调用一个getMatchingBeans()方法，获取Bean然后调用一个getMatchingBeans()方法，获取Bean
  • 根据返回的matchResult判断是否有对应的Bean，返回一个matchMessage结果
  • 最后这个matchMessage就会被SpringBootCondition获取到，用于给matches方法判断是true,还是false

第六步,当matchs方法返回了true 或者false之后，Spring容器就会根据这个flag判断是否装配WebMvcAutoConfiguration配置类

小结：

  • 的确，内部的逻辑比较复杂，所以暂时就忽略了很多部分，有一些地方我自己也没有弄懂，所以就不能太详细的说明，所以如有错误，请指出
  • 虽然OnBeanCondition非常的复杂，那是因为SpringBoot本身就是一个复杂的东西，所以我们自己实现的时候，未必需要实现的跟它一样复杂。

自定义条件装配

注解模式
目录结构，总共四个类

在这里插入图片描述
这里要实现一个计算服务，根据不同的JDK版本，执行不同的代码

  • CalculateService
    计算服务接口
  • Java7CalculateService
    Java 7 计算服务实现类，通过for循环实现
  • Java8CalculateService
    Java 8 计算服务实现类，通过lambda和Stream实现
  • Demo2Application
    SpringBoot启动引导类
CalculateService
public interface CalculateService {Integer sum(Integer...values);
}
Java7CalculateService
*** Java7计算服务* @author liwenjie*/
@Profile("Java7")
@Service
@Slf4j
public class Java7CalculateService implements CalculateService {@Overridepublic Integer sum(Integer... values) {int sum = 0;for (Integer i : values){sum = sum + i;}log.error("Java7 Calculating");return sum;}
}
**Java8CalculateService
/*** Java8计算服务* @author liwenjie*/
@Profile("Java8")
@Service
@Slf4j
public class Java8CalculateService implements CalculateService {@Overridepublic Integer sum(Integer... values) {log.error("Java8 Calculating");return Stream.of(values).reduce(0,Integer::sum);}
}
Demo2Application
@Slf4j
@SpringBootApplication
public class Demo2Application {//获取计算服务实现类@AutowiredCalculateService calculateService;//通过SpringApplication的方式修改profiles//当然你也可以在application.properties中配置spring.profiles.active=Java7public static void main(String[] args) {new SpringApplicationBuilder(Demo2Application.class).profiles("Java7").run(args);}@PostConstructpublic void init(){calculateService.sum(1,2,3,4,5);}}
  • 最后就会实际运行的就是Java7的实现类
  • 要注意的是，我这里使用了lombok插件(强烈推荐)，所以没有的把log.error修改为System.out.println就好了

编程模式
目录结构，三个类
  • ConditionOnSystemProperty注解
    我们这里的作用就是判断系统的Property值是否跟注解的属性值相同，如果相同则装配该Bean
  • OnSystemPropertyCondition实现类
    具体的Condition实现类
  • Demo2Application类
    SpringBoot启动引导类
ConditionOnSystemProperty

模拟@ConditionalOnMissingBean注解

@Target({ElementType.TYPE,ElementType.METHOD})
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Conditional(OnSystemPropertyCondition.class)
public @interface ConditionOnSystemProperty {/***  系统名称,property的key* @return*/String name();/*** 系统属性值,property的value* @return*/String value();
}
OnSystemPropertyCondition
public class OnSystemPropertyCondition implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {//获取ConditionOnSystemProperty的成员属性，最终map有两个元素，name和valueMap<String ,Object> attributes = metadata.getAnnotationAttributes(ConditionOnSystemProperty.class.getName());//获取属性名称String propertyName = String.valueOf(attributes.get("name"));//获取属性值String propertyValue = String.valueOf(attributes.get("value"));//从系统的Property中传入key,获取valueString systemPropertyValue = System.getProperty(propertyName);//最后比较propertyValue 和 systemPropertyValue 是否相等，并返回return systemPropertyValue.equals(propertyValue);}
}
Demo2Application

@SpringBootApplication
public class Demo2Application {@Bean@ConditionOnSystemProperty(name="user.name",value = "xxxx")public String Hello(){return "Hello World";}public static void main(String[] args) {new SpringApplicationBuilder(Demo2Application.class).run(args);}}
  • 结果就是，如果系统的property中没有key为user.name的元素，或者key为user.name的值不为xxxx，那么Spring容器就不会装配hello这个Bean
小结：
  • 自定义条件判断注解，注解内部需要有@Conditional,并指向一个Condition接口的实现类
  • Condition接口的实现类需要实现matchs方法
  • Spring会根据matchs方法返回flag来决定是否装配被自定义条件判断注解修饰的Bean

参考资料

  • SpringBoot2 | 条件注解 @ConditionalOnBean 原理源码分析（七）- 作者：张书康

这篇关于【Spring杂烩】初探Spring的条件装配的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/605191。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
在cscode中通过maven创建java项目

在cscode中通过maven创建java项目

在cscode中创建java项目 可以通过博客完成maven的导入 建立maven项目 使用快捷键 Ctrl + Shift + P 建立一个 Maven 项目 1 Ctrl + Shift + P 打开输入框2 输入 "> java create"3 选择 maven4 选择 No Archetype5 输入 域名6 输入项目名称7 建立一个文件目录存放项目，文件名一般为项目名8 确定
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2