@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的加载顺序和条件,从而提高应用程序的灵活性和性能。

相关推荐
爱笑的源码基地20 小时前
小微企业ERP源码,采用SpringBoot+Vue+ElementUI+UniAPP技术架构,支持二次开发及商用授权
java·源码·二次开发·erp·源代码·mrp生产计划
happymaker062620 小时前
Spring学习日记——DAY03(yml文件)
java·spring boot·spring
凯瑟琳.奥古斯特20 小时前
操作系统核心结构解析
java·开发语言·c++·python·职场和发展
ZC跨境爬虫20 小时前
跟着 MDN 学CSS day_2:(连接样式表与选择器的实战艺术)
java·前端·css·ui·html·媒体
敖正炀20 小时前
AQS-钩子方法
java
郭郭的柳柳在学FPGA20 小时前
千兆以太网@——帧格式
java·开发语言·网络
真恋寄语枫秋20 小时前
【Java零基础入门20】Java Stream流超全详解:中间操作、终结操作、集合数据处理
java
段ヤシ.20 小时前
回顾Java知识点,面试题汇总Day10(持续更新)
java·开发语言·spring
Dicky-_-zhang20 小时前
Elasticsearch聚合查询优化实战
java·jvm