Spring 自动配置 condition

2024-06-10 00:36

本文主要是介绍Spring 自动配置 condition,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

前言

1. 自定义condition加载bean

 1.1. 自定义一个condition注解

1.2. 实现自定义注解对应的实现类 

 1.3. 使用如上注解

1.4. 使用Spring上下文获取一下改bean

 2. 我们来看看Spring是如何加载redisTemplate的。

 2.1. 找到Spring的autoconfigure的jar包,我们从中可以看到有很多对应的condition注解及他们的实现类:​编辑

2.2. 要初始化出来redisTemplate出来有很多条件,其中一个就是要有redis对应的依赖中的字节码文件。​编辑

3. Spring自动切换Web服务器(Tomcat/Netty/Jetty ...)

总结Spring Condition


前言

 我们都知道,当我们创建一个基于Spring的项目的时候,我们都需要在Applicaiton启动引导类上加上@ComponentScan("com.acom.springdemo.*")注解,用于引导Spring指定扫描范围。如果我们不写的话Spring默认扫描的就只有Application启动类所在的根目录及其子目录。Spring为什么呢一定要指定扫描范围。试想一下我们有一个大项目,它依赖了很多的jar包,拿到要Spring启动时都将他们扫描一次,Spring又如何知道当前项目有哪些jar包,如果把所有的jar都扫描一次,很多jar是没有bean的,是不是会引起Spring项目启动很慢等问题。

有的时候我们需要引用外部jar包如Redis,显然这个外部jar包不在我们@ComponentScan所指定的范围内,那么Spring是如何自动加载它的呢?今天我们就来学些Spring condition在其中的作用。

1. 自定义condition加载bean

 假设我们有这样一个需求,我们自定义一个user类的bean,但是这个bean需要在我们的pom中引用了Jedis和FastJson这两个jar包之后才能加载该bean,否则不能加载。
因此我们就需要自定义一个codition 用于限制bean的加载。
自定义bean的示意图如下:

 1.1. 自定义一个condition注解

package com.mycompany.condition;import org.springframework.context.annotation.Conditional;
import java.lang.annotation.*;@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassConditionImpl.class)
public @interface MyConditionOnClass {String[] value();
}

自定义一个condition注解类MyConditionOnClass,其中@Conditional(ClassConditionImpl.class)是说明当前注解是一个Condition注解,且该注解的具体实现类是ClassConditionImpl.class。这里我们需要明白的是,注解的本质其实就是一个标记,标记在方法或类上等,标记了之后它的实现类才能知道哪些方法需要做对应的处理,因而注解本身是不包含什么逻辑的,它只是一个标记。

1.2. 实现自定义注解对应的实现类 

public class ClassConditionImpl implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {Map<String, Object> map = metadata.getAnnotationAttributes(MyConditionOnClass.class.getName());String[] value = (String[]) map.get("value");try {for (String className : value){Class<?> cls = Class.forName(className);}return true;}catch (ClassNotFoundException ex){return false;}}
}

自定义注解的实现类必须实现Spring的 Condition接口,因为Spring需要通过该接口传入Spring的上下文,以及自定义注解定义的参数信息,以便我们的实现类使用。详细如下:

  • ConditionContext context:
    上下文对象。用于获取环境,IOC容器,ClassLoader对象等。
  • AnnotatedTypeMetadata metadata
    注解的元对象,可以用于获取注解定义的元属性值

 1.3. 使用如上注解

@Configuration
public class UserConfig {@Bean@MyConditionOnClass({"redis.clients.jedis.Jedis","com.alibaba.fastjson.JSON"})public User user(){return new User();}
}

1.4. 使用Spring上下文获取一下改bean

@SpringBootApplication
@ComponentScan
public class SpringbootConditionApplication {public static void main(String[] args) {ConfigurableApplicationContext context = SpringApplication.run(SpringbootConditionApplication.class,args);Object user = context.getBean("user");System.out.println(user);}
}

测试当我们没有引用如上的jar包时:
Exception in thread "main" org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'user' available
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBeanDefinition(DefaultListableBeanFactory.java:874)


当我们引用了如上的jar包时:
com.mycompany.domain.User@7c71c889
 

 2. 我们来看看Spring是如何加载redisTemplate的。

 2.1. 找到Spring的autoconfigure的jar包,我们从中可以看到有很多对应的condition注解及他们的实现类:

2.2. 要初始化出来redisTemplate出来有很多条件,其中一个就是要有redis对应的依赖中的字节码文件。

3. Spring自动切换Web服务器(Tomcat/Netty/Jetty ...)

我们都知道基于Spring的项目默认使用的是Tomcat web服务器。那么我们如何切换为其他web服务器呢?我们可以看到对应服务器的加载也是基于@ConditionalOnClass注解的。

所以如果我们要不使用Tomcat而是要使用其他的web服务器,我们只需要排除Tomcat然后再加载对应的web服务器依赖就可以了
 

       <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><exclusions><exclusion><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-tomcat</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-jetty</artifactId></dependency>

启动日志

2024-06-09 18:06:58.223  INFO 15600 --- [           main] o.s.b.web.embedded.jetty.JettyWebServer  : Jetty started on port(s) 8080 (http/1.1) with context path '/'
2024-06-09 18:06:58.231  INFO 15600 --- [           main] c.m.SpringbootConditionApplication       : Started SpringbootConditionApplication in 3.385 seconds (JVM running for 3.972)

 

总结Spring Condition

Spring Condition的作用主要是根据特定条件来控制Bean的创建和注册行为。这种机制使得Spring框架在进行依赖注入时能够更加灵活和智能化。具体来说,其作用可以归纳为以下几点:

  • 条件化Bean的注册:通过@Conditional注解,可以指定Bean注册到Spring IOC容器中的条件。只有当这些条件满足时,相应的Bean才会被创建和注册。这种动态注册Bean的方式提高了Spring应用的灵活性和可配置性。
  • 实现自动化配置:Spring Condition机制常用于Spring Boot等框架中,以实现自动化配置。根据应用环境的不同,例如开发环境、测试环境和生产环境,可以自动地选择性地注册Bean,从而简化了配置工作。
  • 整合环境和配置:通过ConditionContext对象,可以获取到当前的环境信息,如操作系统类型、Java版本等。这使得我们可以根据这些环境信息来动态地决定是否注册某个Bean。
  • 扩展性和灵活性:由于Condition是一个函数式接口,开发者可以自定义实现类来重写matches()方法,以定义自己的条件判断逻辑。这种设计使得Spring Condition具有极高的扩展性和灵活性。

总的来说,Spring Condition的作用在于提供了一种根据特定条件动态注册Bean的机制,使得Spring框架在进行依赖注入时能够根据实际情况做出更智能的决策。这种机制在Spring Boot等框架中得到了广泛应用,极大地简化了应用的配置和部署工作。

这篇关于Spring 自动配置 condition的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1046748

相关文章

一文详解MySQL如何设置自动备份任务

《一文详解MySQL如何设置自动备份任务》设置自动备份任务可以确保你的数据库定期备份,防止数据丢失,下面我们就来详细介绍一下如何使用Bash脚本和Cron任务在Linux系统上设置MySQL数据库的自... 目录1. 编写备份脚本1.1 创建并编辑备份脚本1.2 给予脚本执行权限2. 设置 Cron 任务2

SpringBoot整合Flowable实现工作流的详细流程

《SpringBoot整合Flowable实现工作流的详细流程》Flowable是一个使用Java编写的轻量级业务流程引擎,Flowable流程引擎可用于部署BPMN2.0流程定义,创建这些流程定义的... 目录1、流程引擎介绍2、创建项目3、画流程图4、开发接口4.1 Java 类梳理4.2 查看流程图4

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热

Java对异常的认识与异常的处理小结

《Java对异常的认识与异常的处理小结》Java程序在运行时可能出现的错误或非正常情况称为异常,下面给大家介绍Java对异常的认识与异常的处理,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参... 目录一、认识异常与异常类型。二、异常的处理三、总结 一、认识异常与异常类型。(1)简单定义-什么是

Redis Cluster模式配置

《RedisCluster模式配置》:本文主要介绍RedisCluster模式配置,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录分片 一、分片的本质与核心价值二、分片实现方案对比 ‌三、分片算法详解1. ‌范围分片(顺序分片)‌2. ‌哈希分片3. ‌虚

SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志

《SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志》在SpringBoot项目中,使用logback-spring.xml配置屏蔽特定路径的日志有两种常用方式,文中的... 目录方案一:基础配置(直接关闭目标路径日志)方案二:结合 Spring Profile 按环境屏蔽关

Java使用HttpClient实现图片下载与本地保存功能

《Java使用HttpClient实现图片下载与本地保存功能》在当今数字化时代,网络资源的获取与处理已成为软件开发中的常见需求,其中,图片作为网络上最常见的资源之一,其下载与保存功能在许多应用场景中都... 目录引言一、Apache HttpClient简介二、技术栈与环境准备三、实现图片下载与保存功能1.

Maven 配置中的 <mirror>绕过 HTTP 阻断机制的方法

《Maven配置中的<mirror>绕过HTTP阻断机制的方法》:本文主要介绍Maven配置中的<mirror>绕过HTTP阻断机制的方法,本文给大家分享问题原因及解决方案,感兴趣的朋友一... 目录一、问题场景:升级 Maven 后构建失败二、解决方案:通过 <mirror> 配置覆盖默认行为1. 配置示

SpringBoot排查和解决JSON解析错误(400 Bad Request)的方法

《SpringBoot排查和解决JSON解析错误(400BadRequest)的方法》在开发SpringBootRESTfulAPI时,客户端与服务端的数据交互通常使用JSON格式,然而,JSON... 目录问题背景1. 问题描述2. 错误分析解决方案1. 手动重新输入jsON2. 使用工具清理JSON3.

java中long的一些常见用法

《java中long的一些常见用法》在Java中,long是一种基本数据类型,用于表示长整型数值,接下来通过本文给大家介绍java中long的一些常见用法,感兴趣的朋友一起看看吧... 在Java中,long是一种基本数据类型,用于表示长整型数值。它的取值范围比int更大,从-922337203685477