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

相关推荐
xcl09259 小时前
商超智能运营实战:数据驱动提升门店效率与体验指南
java·mfc·宠物
Flynt11 小时前
OpenJDK禁AI代码半年了,现在执行得怎么样?答案是:全靠自觉
java·开源·ai编程
古法安卓16 小时前
Android-日志系统源码解析
android·java·android studio
小夏coding17 小时前
从"一把梭"到"精妙拆解" —— 滑动窗口计时框架的设计演进
java·后端
MacroZheng18 小时前
同事问我:"Claude Code经常失忆,不怕它把项目搞炸?",我:"怕,三个Markdown文件给它装个永不丢失的外置大脑!"
java·人工智能·后端
十年Java程序媛20 小时前
深度实战:JDK21 虚拟线程 + HikariCP 生产正确配比、坑点、监控全套
java·spring boot
xiaoqiMikko20 小时前
有人在搜一个不存在的 Tomcat 版本
java·tomcat
用户3126874877201 天前
ConcurrentHashMap 怎么保证线程安全?从分段锁到 CAS+synchronized
java
vipxieliang1 天前
ValidX vs Apache Commons Validator:功能与性能对比
java·spring boot
SimonKing1 天前
升级Spring Boot 4后,从 Jackson 2 到 3,到底有哪些变化
java·后端·程序员