Spring Boot 教程

@ConditionalOnMissingBean 注解

在 Spring Boot 中,@ConditionalOnMissingBean 注解用来判断指定的类是否在 BeanFactory 中存在:

  • 如果你指定的类在 BeanFactory 中存在,则匹配失败;

  • 如果在 BeanFactory 中不存在,则匹配成功;

示例

本实例将创建 InitUser 和 InitOrder 类,在 InitUser 类上添加了 @Component 注解,InitUser 会注入到 Spring 容器。而 InitOrder 类上面没有使用任何注解,因此没有注入到 Spring 容器中。

(1)创建 InitUser 和 InitOrder 类,代码如下:

a、InitUser.java

package com.huangx.springboot.autoconfig.init;

import org.springframework.stereotype.Component;

@Component
public class InitUser {

}

b、InitOrder.java

package com.huangx.springboot.autoconfig.init;

public class InitOrder {

}

(2)创建 UserService 和 OrderService 服务,代码如下:

a、UserService.java

package com.huangx.springboot.autoconfig.service;

public class UserService {
    // 什么也不做
}

b、OrderService.java

package com.huangx.springboot.autoconfig.service;

public class OrderService {
    // 什么也不做
}

(3)创建 User 和 Order 配置类,代码如下:

a、UserConfig.java

package com.huangx.springboot.autoconfig.config;

import com.huangx.springboot.autoconfig.init.InitUser;
import com.huangx.springboot.autoconfig.service.UserService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
// 判断 InitUser 是否在 BeanFactory 中存在
// 如果在 BeanFactory 中存在 InitUser,则匹配失败
// 如果在 BeanFactory 中不存在 InitUser,则匹配成功,实例化 UserService
@ConditionalOnMissingBean(InitUser.class)
public class UserConfig {

    @Bean
    public UserService userService() {
        System.out.println("UserService -> userService()");
        return new UserService();
    }

}

b、OrderConfig.java

package com.huangx.springboot.autoconfig.config;

import com.huangx.springboot.autoconfig.init.InitOrder;
import com.huangx.springboot.autoconfig.service.OrderService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
// 判断 InitOrder 是否在 BeanFactory 中存在
// 如果 BeanFactory 中不存在 InitOrder,则匹配成功,实例化 OrderService
// 如果 BeanFactory 中存在 InitOrder,则匹配失败,不进行实例化
@ConditionalOnMissingBean(InitOrder.class)
public class OrderConfig {

    @Bean
    public OrderService orderService() {
        System.out.println("OrderConfig -> orderService()");
        return new OrderService();
    }

}

(4)客户端,验证 UserService 和 OrderService 实例是否被创建。代码如下:

package com.huangx.springboot.autoconfig;

import com.huangx.springboot.autoconfig.service.OrderService;
import com.huangx.springboot.autoconfig.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@SpringBootApplication
public class Demo7Application {

    @Autowired
    private ApplicationContext applicationContext;

    public static void main(String[] args) {
        SpringApplication.run(Demo7Application.class, args);
    }

    @GetMapping("/")
    public String index() {
        UserService userService = null;
        try {
            userService = applicationContext.getBean(UserService.class);
        } catch (Exception e) {
            System.err.println(e.getMessage());
        }

        OrderService orderService = null;
        try {
            orderService = applicationContext.getBean(OrderService.class);
        } catch (Exception e) {
            System.err.println(e.getMessage());
        }

        return "userService=" + userService + "<br/>" +
                "orderService=" + orderService;
    }

}

运行上面程序,在浏览器中访问 http://localhost:8080 地址,如下图:

说说我的看法
全部评论(
没有评论
关于
本网站专注于 Java、数据库(MySQL、Oracle)、Linux、软件架构及大数据等多领域技术知识分享。涵盖丰富的原创与精选技术文章,助力技术传播与交流。无论是技术新手渴望入门,还是资深开发者寻求进阶,这里都能为您提供深度见解与实用经验,让复杂编码变得轻松易懂,携手共赴技术提升新高度。如有侵权,请来信告知:hxstrive@outlook.com
公众号