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

相关推荐
二哈喇子!2 小时前
基于SSM框架的公交车查询系统的设计与实现
java·数据库·ssm
二哈喇子!2 小时前
基于JavaSE的淘宝卖鞋后端管理系统的设计与实现
java·spring boot·spring
小冷coding2 小时前
【Java】Dubbo 与 OpenFeign 的核心区别
java·开发语言·dubbo
Coder_Boy_2 小时前
基于SpringAI的在线考试系统-智能考试系统-学习分析模块
java·开发语言·数据库·spring boot·ddd·tdd
cdut_suye2 小时前
解锁函数的魔力:Python 中的多值传递、灵活参数与无名之美
java·数据库·c++·人工智能·python·机器学习·热榜
逍遥德3 小时前
java Map Set List 扩容机制
java·开发语言·list
高山上有一只小老虎3 小时前
mybatisplus实现分页查询
java·spring boot·mybatis
nbsaas-boot3 小时前
基于 Java 21 ScopedValue 的多租户动态数据源完整实践
java·开发语言
2301_780669863 小时前
线程安全、线程同步(三种加锁方式)、线程池(两种创建线程池方式、线程池处理Runnable任务、线程池处理Callable任务)、并发/并行
java