spring的@ConditionalOnMissingBean和@ConditionalOnBean两个注解的使用

  • 顾名思义两个注解作用是为了有条件的注入启用一些配置文件,动态生成一些bean,也可以理解为springBean A 要依赖于springBean的存在而存在.
  • 两个注解是相反的,所以只需要解释一个,第二个也就明白了.

ConditionalOnMissingBean

1.源码介绍
/*
 * Copyright 2012-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure.condition;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.context.annotation.Conditional;

/**
 * {@link Conditional} that only matches when no beans of the specified classes and/or
 * with the specified names are already contained in the {@link BeanFactory}.
 * 

* When placed on a {@code @Bean} method, the bean class defaults to the return type of * the factory method: * *

 * @Configuration
 * public class MyAutoConfiguration {
 *
 *     @ConditionalOnMissingBean
 *     @Bean
 *     public MyService myService() {
 *         ...
 *     }
 *
 * }
*

* In the sample above the condition will match if no bean of type {@code MyService} is * already contained in the {@link BeanFactory}. *

* The condition can only match the bean definitions that have been processed by the * application context so far and, as such, it is strongly recommended to use this * condition on auto-configuration classes only. If a candidate bean may be created by * another auto-configuration, make sure that the one using this condition runs after. * * @author Phillip Webb * @author Andy Wilkinson */ @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented @Conditional(OnBeanCondition.class) public @interface ConditionalOnMissingBean { /** * The class types of beans that should be checked. The condition matches when no bean * of each class specified is contained in the {@link BeanFactory}. * @return the class types of beans to check */ Class[] value() default {}; /** * The class type names of beans that should be checked. The condition matches when no * bean of each class specified is contained in the {@link BeanFactory}. * @return the class type names of beans to check */ String[] type() default {}; /** * The class types of beans that should be ignored when identifying matching beans. * @return the class types of beans to ignore * @since 1.2.5 */ Class[] ignored() default {}; /** * The class type names of beans that should be ignored when identifying matching * beans. * @return the class type names of beans to ignore * @since 1.2.5 */ String[] ignoredType() default {}; /** * The annotation type decorating a bean that should be checked. The condition matches * when each annotation specified is missing from all beans in the * {@link BeanFactory}. * @return the class-level annotation types to check */ Class[] annotation() default {}; /** * The names of beans to check. The condition matches when each bean name specified is * missing in the {@link BeanFactory}. * @return the names of beans to check */ String[] name() default {}; /** * Strategy to decide if the application context hierarchy (parent contexts) should be * considered. * @return the search strategy */ SearchStrategy search() default SearchStrategy.ALL; /** * Additional classes that may contain the specified bean types within their generic * parameters. For example, an annotation declaring {@code value=Name.class} and * {@code parameterizedContainer=NameRegistration.class} would detect both * {@code Name} and {@code NameRegistration}. * @return the container types * @since 2.1.0 */ Class[] parameterizedContainer() default {}; }

2.个人理解

仅在该注解规定的类不存在于 spring容器中时,使用该注解的config或者bean声明才会被实例化到容器中

3.属性详解
  • Class[] value : 需要作为条件的类的Class对象数组
  • String[] type : 需要作为条件的类的Name,Class.getName()
  • Class[] annotation : (用指定注解修饰的bean)条件所需的注解类
  • String[] name : spring容器中bean的名字
  • SearchStrategy search:搜索容器层级,当前容器,父容器
  • Class[] parameterizedContainer :可能在其泛型参数中包含指定bean类型的其他类

你可能感兴趣的:(spring的@ConditionalOnMissingBean和@ConditionalOnBean两个注解的使用)