@ConditionalOnWebApplication 作用

写在@ControllerAdvice中

@ConditionalOnWebApplication 是Spring Framework中的一个条件注解,用于根据当前应用程序是否是一个Web应用程序来决定是否创建一个bean或者配置一个类。这个注解在Spring Boot应用程序中非常有用,特别是在需要根据应用程序环境加载特定配置或bean的场景下。

主要功能

Web特定配置:当应用程序需要根据是否是Web应用程序来加载特定的配置或bean时,可以使用@ConditionalOnWebApplication来进行条件化配置。

Web和非Web环境兼容性:在一个库或模块中,可能会同时支持Web和非Web环境,可以利用该注解来分别适配不同的环境。

使用示例

假设有一个Spring Boot应用程序,我们希望根据当前应用程序是否是Web应用程序来创建不同的bean:

复制代码
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
@Configuration
@ConditionalOnWebApplication
public class WebConfiguration {
   @Bean
   public MyWebBean myWebBean() {
       // 创建一个Web应用程序专用的bean
       return new MyWebBean();
   }
}
@Configuration
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
public class ServletConfiguration {
   @Bean
   public MyServletBean myServletBean() {
       // 如果是Servlet类型的Web应用程序,则创建一个特定的Servlet bean
       return new MyServletBean();
   }
}

在上面的示例中:

WebConfiguration 类使用了 @ConditionalOnWebApplication 注解,这意味着其中的 myWebBean 方法只有在当前应用程序是Web应用程序时才会创建。

ServletConfiguration 类使用了 @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) 注解,这意味着其中的 myServletBean 方法只有在当前应用程序是Servlet类型的Web应用程序时才会创建。

注意事项

type属性:@ConditionalOnWebApplication注解可以通过type属性来指定具体的Web应用程序类型,包括Type.SERVLET(传统的Servlet应用程序)和Type.REACTIVE(响应式Web应用程序)。如果未指定type属性,默认情况下,@ConditionalOnWebApplication表示适用于任何类型的Web应用程序。

条件不满足时:当条件不满足时,与@ConditionalOnWebApplication注解关联的bean将不会被创建。

通过使用@ConditionalOnWebApplication注解,可以有效地控制Spring Boot应用程序中bean的加载顺序和条件,从而提高应用程序的灵活性和性能。

相关推荐
二月夜5 小时前
剖析Java正则表达式回溯问题
java·正则表达式
xuhaoyu_cpp_java6 小时前
项目学习(三)分页查询
java·经验分享·笔记·学习
程序员二叉6 小时前
【Java】集合面试全套精讲|HashMap/ArrayList高频考点完整版
java·面试·哈希算法
cfm_29146 小时前
JVM GC垃圾回收初步了解
java·开发语言·jvm
心之伊始7 小时前
LangChain4j RAG 实战:Java 后端如何把本地文档接入 Embedding 检索链路
java·架构·源码分析·csdn
许彰午7 小时前
17_synchronized关键字深度解析
java·开发语言
Xzh04238 小时前
AI Agent 学习路线(Java 后端方向)
java·人工智能·学习
艾利克斯冰9 小时前
Java 设计模式-行为型模式(更新中)
java·开发语言·设计模式
倒霉蛋小马9 小时前
Java新特性:record关键字
java·开发语言
折哥的程序人生 · 物流技术专研10 小时前
《Java 100 天进阶之路》第95篇:消息队列基础(RocketMQ/Kafka)(2026版)
java·面试·kafka·rocketmq·java-rocketmq·求职招聘