注解之spring @ConditionalOnProperty

包路径：org.springframework.boot.autoconfigure.condition

作用：根据某个配置变量值来控制否需要加载，常与@Configuration或@Bean配合使用

源码解析：

/*
 * Copyright 2012-2019 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
 *
 *      https://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.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Conditional;
import org.springframework.core.env.Environment;

/**
 * {@link Conditional @Conditional} that checks if the specified properties have a
 * specific value. By default the properties must be present in the {@link Environment}
 * and <strong>not</strong> equal to {@code false}. The {@link #havingValue()} and
 * {@link #matchIfMissing()} attributes allow further customizations.
 * <p>
 * The {@link #havingValue} attribute can be used to specify the value that the property
 * should have. The table below shows when a condition matches according to the property
 * value and the {@link #havingValue()} attribute:
 *
 * <table border="1">
 * <caption>Having values</caption>
 * <tr>
 * <th>Property Value</th>
 * <th>{@code havingValue=""}</th>
 * <th>{@code havingValue="true"}</th>
 * <th>{@code havingValue="false"}</th>
 * <th>{@code havingValue="foo"}</th>
 * </tr>
 * <tr>
 * <td>{@code "true"}</td>
 * <td>yes</td>
 * <td>yes</td>
 * <td>no</td>
 * <td>no</td>
 * </tr>
 * <tr>
 * <td>{@code "false"}</td>
 * <td>no</td>
 * <td>no</td>
 * <td>yes</td>
 * <td>no</td>
 * </tr>
 * <tr>
 * <td>{@code "foo"}</td>
 * <td>yes</td>
 * <td>no</td>
 * <td>no</td>
 * <td>yes</td>
 * </tr>
 * </table>
 * <p>
 * If the property is not contained in the {@link Environment} at all, the
 * {@link #matchIfMissing()} attribute is consulted. By default missing attributes do not
 * match.
 * <p>
 * This condition cannot be reliably used for matching collection properties. For example,
 * in the following configuration, the condition matches if {@code spring.example.values}
 * is present in the {@link Environment} but does not match if
 * {@code spring.example.values[0]} is present.
 *
 * <pre class="code">
 * &#064;ConditionalOnProperty(prefix = "spring", name = "example.values")
 * class ExampleAutoConfiguration {
 * }
 * </pre>
 *
 * It is better to use a custom condition for such cases.
 *
 * @author Maciej Walkowiak
 * @author Stephane Nicoll
 * @author Phillip Webb
 * @since 1.1.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {

	/**
	 * Alias for {@link #name()}.
	 * @return the names
	 * 和name一个含义
	 */
	String[] value() default {};

	/**
	 * A prefix that should be applied to each property. The prefix automatically ends
	 * with a dot if not specified. A valid prefix is defined by one or more words
	 * separated with dots (e.g. {@code "acme.system.feature"}).
	 * @return the prefix
	 * 前缀，至少得有一个点
	 * 如果没有点，则会自动在最后面添加一个点
	 */
	String prefix() default "";

	/**
	 * The name of the properties to test. If a prefix has been defined, it is applied to
	 * compute the full key of each property. For instance if the prefix is
	 * {@code app.config} and one value is {@code my-value}, the full key would be
	 * {@code app.config.my-value}
	 * <p>
	 * Use the dashed notation to specify each property, that is all lower case with a "-"
	 * to separate words (e.g. {@code my-long-property}).
	 * @return the names
	 * 属性名称，会和prefix一起组成一个最终属性的key值
	 */
	String[] name() default {};

	/**
	 * The string representation of the expected value for the properties. If not
	 * specified, the property must <strong>not</strong> be equal to {@code false}.
	 * @return the expected value
	 * 判断值，如果最终属性的key值等于havingValue的值，则进行加载
	 */
	String havingValue() default "";

	/**
	 * Specify if the condition should match if the property is not set. Defaults to
	 * {@code false}.
	 * @return if should match if the property is missing
	 * 当没有找到对应属性时是否进行加载。默认不加载
	 */
	boolean matchIfMissing() default false;

}

代码实战：

1、当类上没有任何注解时，只有@Configuration时，会输出“开始加载类”

@Configuration
public class TestClassConfig {

    @PostConstruct
    public void init(){
        System.out.println("开始加载类");
    }

}

2、当加上@ConditionalOnProperty，不同情况下是否进行打印

​ 场景1： 不输出

@Configuration
// 当root.print为true时，进行输出
@ConditionalOnProperty(name = "root.print", havingValue = "true")
public class TestClassConfig {

    @PostConstruct
    public void init(){
        System.out.println("开始加载");
    }

}

场景2： 不输出

@Configuration
// 当root.print为false时，进行输出
@ConditionalOnProperty(name = "root.print", havingValue = "false")
public class TestClassConfig {

    @PostConstruct
    public void init(){
        System.out.println("开始加载");
    }

}

场景3：输出

@Configuration
// 当root.print为false时，进行输出. 如果没有找到root.print，也进行输出
@ConditionalOnProperty(name = "root.print", havingValue = "false", matchIfMissing = true)
public class TestClassConfig {

    @PostConstruct
    public void init(){
        System.out.println("开始加载");
    }

}

加入配置文件后：

server.port=8888
root.print=false

场景4：输出

@Configuration
// 当root.print为false时，进行输出
@ConditionalOnProperty(name = "root.print", havingValue = "false")
public class TestClassConfig {

    @PostConstruct
    public void init(){
        System.out.println("开始加载");
    }

}

场景5：不输出

@Configuration
// 当root.print为false时，进行输出
@ConditionalOnProperty(name = "root.print", havingValue = "true")
public class TestClassConfig {

    @PostConstruct
    public void init(){
        System.out.println("开始加载");
    }

}