网站模仿算侵权吗,名字找备案网站,北京网站定制,企业一站式网站建设文章目录 条件注解是什么有哪些条件注解类条件注解Bean条件注解属性条件注解资源条件注解web应用条件注解SpEL( Spring Expression Language )表达式条件注解其他条件注解 总结 前些天发现了一个巨牛的人工智能学习网站#xff0c;通俗易懂#xff0c;风趣幽默#xff0c;忍… 文章目录 条件注解是什么有哪些条件注解类条件注解Bean条件注解属性条件注解资源条件注解web应用条件注解SpEL( Spring Expression Language )表达式条件注解其他条件注解 总结 前些天发现了一个巨牛的人工智能学习网站通俗易懂风趣幽默忍不住分享一下给大家。点击跳转到网站。 上篇文章我们在自定义starter中使用到了条件注解 ConditionalOnMissingBean那什么是条件注解呢
条件注解是什么
条件注解是一种基于条件的注解用于在应用程序中根据特定条件自动配置或排除某些组件。条件注解可以根据应用程序的环境、配置属性或其他条件来控制某些组件的注册和初始化。
有哪些条件注解
Springboot 提供了许多条件注解主要分为7类
类条件注解
类条件注解指的是根据指定的类来决定是否创建某个Bean的注解 这类注解有两个分别为
ConditionalOnClass当类路径上存在指定的类时创建Bean。ConditionalOnMissingClass当指定的类在类路径上不存在时创建Bean。
ConditionalOnClass 注解具有以下属性
value 要检查的类的Class类型数组。当数组中的类型存在时条件成立。name与 value属性类似指定要检查的类或接口的全限定名。当指定的类或接口存在时条件成立。
ConditionalOnMissingClass只有一个value属性和ConditionalOnClass 的value属性作用相反。
用法如下
AutoConfiguration
public class MyAutoConfiguration {BeanConditionalOnMissingClass(com.example.MyClass)public SomeService someService() {return new SomeService();}
}在上述示例中通过ConditionalOnMissingClass注解当类com.example.MyClass不存在时才会创建SomeService实例。
Bean条件注解
Bean条件注解指的是根据指定的Bean来决定是否创建某个Bean 这类注解有两个分别为
ConditionalOnBean: 当指定的 Bean 在容器中存在时条件才会成立创建某个Bean。ConditionalOnMissingBean当容器中不存在指定类型的Bean时创建某个Bean。
ConditionalOnBean 注解具有以下属性 value指定匹配的Bean 类型。可以使用单个Class对象作为值或者使用一个Class数组来指定多个类。如果容器中存在其中任何一个 Bean则条件满足。 type和value属性类似不同的是value属性传的是Class类型数组 type传的是对应的全限定名或者类名。 name指定匹配的Bean 名称。可以使用单个 Bean 名称字符串也可以使用一个名称字符串数组来指定多个 Bean 名称。如果容器中存在其中任何一个 Bean则条件满足。 parameterizedContainer指定一个参数化类型的容器在检查 Bean 是否存在时会检查容器中是否存在泛型类型的实现类的 Bean。例如ConditionalOnBean(parameterizedContainer List.class) 会检查容器中是否存在类型为 java.util.List 的 Bean。 annotation指定一个注解类型在检查 Bean 是否存在时会检查容器中是否存在被该注解标注的 Bean。 match指定匹配类型。默认为 MatchType.ALL表示需要检查所有指定的 Bean 是否都存在。如果设置为 MatchType.ANY则只要存在任何一个指定的 Bean就可以满足条件。
其中value 和 name 二选一value 和 name 两个属性是互斥的只能选择其中一个来指定需要检查是否存在的 Bean。
ConditionalOnMissingBean 注解除了有ConditionalOnBean 注解所有的属性外另外还多了两个属性
ignored匹配时要忽略的Class类型数组。ignoredType匹配时要忽略的Class类型数组名称。
用法如下
AutoConfiguration
public class MyAutoConfiguration {BeanConditionalOnMissingBeanpublic SomeService someService() {return new SomeService();}
}在这段代码示例中如果Spring容器中不包含 SomeService的Bean实例ApplicationContext应用上下文才会创建名为 someService的Bean。
属性条件注解
属性条件注解指的是根据配置属性的值来决定是否创建某个Bean的注解 这类注解只有一个
ConditionalOnProperty当配置文件中指定属性存在或不存在时创建某个Bean。
ConditionalOnProperty 注解有以下属性
name要匹配的属性的名称必填属性字符串数组可以指定多个属性。通常是读取 application.properties 或 application.yml 文件中的属性值。havingValue要检查的属性的期望值如果要检查的属性的值与该值相等则条件成立可选属性默认为 “”。matchIfMissing要检查的属性不存在时是否也要认为条件成立可选属性默认为 false。prefix要检查的属性的前缀即只有以指定前缀开头的属性才会被检查可选属性默认为空字符串。value要检查的属性的值可以用来代替 name 和 havingValue 属性可选属性默认为空字符串数组 value可以同时指定多个要检查的属性的值如果其中任意一个要检查的属性的值与期望值相等则条件成立。
用法如下
ConditionalOnProperty(prefix spring, name {example.value} , matchIfMissing true , havingValue suncodernote)
class ExampleAutoConfiguration {
}上面的示例的意思是在启动时检查配置文件中前缀为spring名称为 example.value的属性名并且该属性的值是否是suncodernote 即使没有匹配成功也可以加载类。
资源条件注解
资源条件注解指的是根据是否包含指定资源来决定是否创建某个Bean的注解 这类注解只有下面一个
ConditionalOnResource根据类路径上是否存在指定资源文件来决定是否创建某个Bean。
ConditionalOnResource 注解只有一个属性
resources指定需要检查的资源路径必填可以是相对于类路径的相对路径或绝对路径。
用法如下
ConditionalOnResource(resources {file:D:\\javassist-3.29.2-GA.jar , application.yml})
class ExampleAutoConfiguration {
}上面的示例的意思是在启动时检查D盘是否有javassist-3.29.2-GA.jar和classpath下是否有application.yml有的话就创建类。
web应用条件注解
web应用条件注解包括以下4个注解
ConditionalOnWebApplication 当应用程序是一个 Web 应用程序时会创建某个Bean。ConditionalOnNotWebApplication当应用程序不是一个 Web 应用程序时会创建某个Bean。ConditionalOnWarDeployment当应用程序以war包的形式部署时会创建某个Bean。使用内嵌服务器时会返回false也就是不会创建某个Bean。ConditionalOnNotWarDeployment当应用程序不以war包的形式部署时会创建某个Bean。
上面4个注解中只有ConditionalOnWebApplication有属性并且只有一个属性
typeweb应用程序类型有ANY、SERVLET、REACTIVE3个值可选默认为ANY。
SpEL( Spring Expression Language )表达式条件注解
SpEL表达式条件注解只有一个注解那就是ConditionalOnExpression它表示当指定的 SpEL 表达式结果为 true 时条件才会成立。
ConditionalOnExpression只有一个属性
valueSpEL表达式默认值true。如果条件满足表达式应该返回true否则返回false。
其他条件注解
除了以上这些注解外还有一些其他的条件注解这些注解都在 org.springframework.boot.autoconfigure.condition 包下 ConditionalOnJava判断当前运行的JVM版本是否符合指定的版本要求当JVM版本为指定的版本范围时将会触发实例化。 ConditionalOnCheckpointRestore用于指示一个配置类只在基于检查点的恢复可用时才会被加载。SpringBoot 在启动时检查是否启用了基于检查点的恢复。如果启用了基于检查点的恢复那么带有该注解的配置类将会被加载并应用。否则该配置类将不会被加载。在分布式系统中检查点Checkpoint 是一种保存系统状态的方法以便在系统故障或失败时可以恢复到之前的状态。 ConditionalOnCloudPlatform只有在指定的云平台运行程序时才会加载指定的Bean。 ConditionalOnJndi只有在 JNDIJava Naming and Directory Interface 存在的情况下才会加载指定的 Bean。 ConditionalOnSingleCandidate当使用ConditionalOnSingleCandidate注解标记一个Bean时它会根据容器中是否存在指定类型的Bean来决定是否注册这个Bean。如果在容器中存在且只存在一个指定类型的Bean则被ConditionalOnSingleCandidate注解标记的Bean将会被注册如果不存在或存在多个指定类型Bean则不会注册该Bean。这个注解在一些情况下非常有用例如在多个实现类中选择一个默认的实现类或者在只有一个数据源时配置默认的数据源等。通过使用ConditionalOnSingleCandidate注解可以避免歧义性的自动装配问题并确保只有在特定条件下才注册相关的Bean。 ConditionalOnThreadingSpringBoot 3.2新增的一个注解只有在使用特定类型的线程时创建 Bean。 特定类型的线程包括平台线程和虚拟线程。
总结
通过使用条件注解可以轻松地根据应用程序的需求自定义配置。通常情况下SpringBoot提供的条件注解已经足够使用如果不满足的话我们可以自定义一个条件注解下篇文章将介绍一下如何自定义一个条件注解。
