摘要：背景學習的自動配置對于了解整個后端代碼運行流程非常重要只有在了解是如何配置的情況下才能在項目的配置中不那么舉步維艱假如我們編寫了一個用于處理文件信息的工具類那么我們可以如下操作工具步驟創建一個普通的項目注意其中的和這兩項將對應以后使用的依賴

學習spring boot的自動配置對于了解整個后端代碼運行流程非常重要,只有在了解spring boot是如何配置的情況下,才能在項目的配置中不那么舉步維艱.

假如我們編寫了一個用于處理文件信息的工具類,那么我們可以如下操作

IntelliJ IDEA 2018

1.創建一個普通的spring boot項目

注意其中的Group和Artifact,這兩項將對應以后使用的依賴參數

            xyz.crabapple
            begonia
            0.0.1-SNAPSHOT

2.項目的目錄結構

3.現在我們主要代碼需要寫在begonia目錄下

4.代碼解釋

BegoniaApplication 為spring boot自己生成的入口類所在的java文件.

Tool 是我的工具類具體實現

public class Tool {
    public String prefix;
    public Tool(String prefix) {
        this.prefix = prefix;
    }
    /**
     * 計算時間戳
     * @return 時間戳+五位隨機大寫字母
     */
    public  String getStamp() {
        String prefix = String.valueOf(new Date().getTime());
        prefix=prefix.substring(2,prefix.length());
        char[] arr = new char[5];
        Random random = new Random();
        for (int i = 0; i < 5; i++)
            arr[i] = (char) (65 + random.nextInt(26));
        String Suffix = String.valueOf(arr);
        return prefix + Suffix;
    }

ToolProperties充當配置類和application.properties的橋,即它從application.properties中取具體的配置信息,而真正的配置類需要再到ToolProperties去取.

@ConfigurationProperties(prefix = "Tool")
public class ToolProperties {
   private String prefix;

    public String getPrefix() {
        return prefix;
    }

    public void setPrefix(String path) {
        this.prefix = path;
    }
}

ToolAutoConfiguration是我的具體配置類

@Configuration
@EnableConfigurationProperties(ToolProperties.class)
@ConditionalOnClass(Tool.class)
@ConditionalOnProperty(prefix = "Tool", name="open" ,havingValue="true")
public class ToolAutoConfiguration {
    @Autowired
    ToolProperties toolProperties;
    @Bean
    public Tool autoConfiger(){
        System.out.println("Tool工具已啟動");
        System.out.println(toolProperties.getPrefix());
        return new Tool(toolProperties.getPrefix());
    }
}

1.@Configuration 表示這是一個配置類,作用等同于@Component.
以下三個注解都是條件注解,如果有一個不滿足條件,自動配置就不會運行.
2.@EnableConfigurationProperties(ToolProperties.class)
表示配置類的自動配置必須要求ToolProperties.class的存在
3.@ConditionalOnClass(Tool.class)
要求功能類存在.
4.@ConditionalOnProperty(prefix = "Tool", name="open" ,havingValue="true")
查看@ConditionOnProperty

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {

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

    /**
     * A prefix that should be applied to each property. The prefix automatically ends
     * with a dot if not specified.
     * @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 fully key would be
     * {@code app.config.my-value}
     * 

     * 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
     */
    String[] name() default {};

    /**
     * The string representation of the expected value for the properties. If not
     * specified, the property must not be equals to {@code false}.
     * @return the expected value
     */
    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;

    /**
     * If relaxed names should be checked. Defaults to {@code true}.
     * @return if relaxed names are used
     */
    boolean relaxedNames() default true;

}

prefix和name拼湊起來表示application.properties的配置信息key,例如我的配置信息為Tool.open=true,那么@ConditionalOnProperty(prefix = "Tool", name="open" ,havingValue="true")就表示配置信息中有這個key就為true,即滿足條件,在此條件下若等于注解中havingValue的值,則該注解最終的結果為true.

在/src/main目錄下創建META-INF目錄,并其下創建spring.factories文件,其實spring.factories文件就是一個.properties文件.

新建好后,在其中按如下方式書寫

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
  xyz.crabapple.begonia.ToolAutoConfiguration

第一行的org.springframework.boot.autoconfigure.EnableAutoConfiguration就是一個key,第二行的xyz.crabapple.begonia.ToolAutoConfiguration就是我們的自動配置類,即value.配置類還可以按需添加.例如我們找一個依賴看一看

找到一個spring boot自帶的依賴,可以看到其書寫方式,供大家參考.

# Initializers
org.springframework.context.ApplicationContextInitializer=
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,
org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer