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

相关文章

Java编译生成多个.class文件的原理和作用

《Java编译生成多个.class文件的原理和作用》作为一名经验丰富的开发者,在Java项目中执行编译后,可能会发现一个.java源文件有时会产生多个.class文件,从技术实现层面详细剖析这一现象... 目录一、内部类机制与.class文件生成成员内部类(常规内部类)局部内部类(方法内部类)匿名内部类二、

SpringBoot实现数据库读写分离的3种方法小结

《SpringBoot实现数据库读写分离的3种方法小结》为了提高系统的读写性能和可用性,读写分离是一种经典的数据库架构模式,在SpringBoot应用中,有多种方式可以实现数据库读写分离,本文将介绍三... 目录一、数据库读写分离概述二、方案一:基于AbstractRoutingDataSource实现动态

Springboot @Autowired和@Resource的区别解析

《Springboot@Autowired和@Resource的区别解析》@Resource是JDK提供的注解,只是Spring在实现上提供了这个注解的功能支持,本文给大家介绍Springboot@... 目录【一】定义【1】@Autowired【2】@Resource【二】区别【1】包含的属性不同【2】@

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

Java枚举类实现Key-Value映射的多种实现方式

《Java枚举类实现Key-Value映射的多种实现方式》在Java开发中,枚举(Enum)是一种特殊的类,本文将详细介绍Java枚举类实现key-value映射的多种方式,有需要的小伙伴可以根据需要... 目录前言一、基础实现方式1.1 为枚举添加属性和构造方法二、http://www.cppcns.co

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

Java中的String.valueOf()和toString()方法区别小结

《Java中的String.valueOf()和toString()方法区别小结》字符串操作是开发者日常编程任务中不可或缺的一部分,转换为字符串是一种常见需求,其中最常见的就是String.value... 目录String.valueOf()方法方法定义方法实现使用示例使用场景toString()方法方法

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

Java实现文件图片的预览和下载功能

《Java实现文件图片的预览和下载功能》这篇文章主要为大家详细介绍了如何使用Java实现文件图片的预览和下载功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... Java实现文件(图片)的预览和下载 @ApiOperation("访问文件") @GetMapping("

Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

《SpringBoot+MyBatisPlus高效开发实战从入门到进阶优化(推荐)》本文将详细介绍SpringBoot+MyBatisPlus的完整开发流程,并深入剖析分页查询、批量操作、动... 目录Spring Boot + MyBATis Plus 高效开发实战:从入门到进阶优化1. MyBatis