關於@PropertySource設定的用法解析

2022-03-25 16:01:23

@PropertySource設定用法

功能

載入指定的屬性檔案（*.properties）到 Spring 的 Environment 中。可以配合 @Value 和@ConfigurationProperties 使用。

@PropertySource 和 @Value組合使用，可以將自定義屬性檔案中的屬性變數值注入到當前類的使用@Value註解的成員變數中。

@PropertySource 和 @ConfigurationProperties組合使用，可以將屬性檔案與一個Java類繫結，將屬性檔案中的變數值注入到該Java類的成員變數中。

原始碼

package org.springframework.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.io.support.PropertySourceFactory;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(PropertySources.class)
public @interface PropertySource {
    /**
     * 屬性源的名稱
     */
    String name() default "";
    /**
     * 屬性檔案的存放路徑
     */
    String[] value();
    /**
     * 如果指定的屬性源不存在，是否要忽略這個錯誤
     */
    boolean ignoreResourceNotFound() default false;
    /**
     * 屬性源的編碼格式
     */
    String encoding() default "";
    /**
     * 屬性源工廠
     */
    Class<? extends PropertySourceFactory> factory() default PropertySourceFactory.class;
}

使用範例

屬性檔案：demo.properties

demo.name=huang
demo.sex=1
demo.type=demo

範例一：@PropertySource + @Value

package com.huang.pims.demo.props;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@PropertySource(value = {"demo/props/demo.properties"})
public class ReadByPropertySourceAndValue {
    @Value("${demo.name}")
    private String name;
    @Value("${demo.sex}")
    private int sex;
    @Value("${demo.type}")
    private String type;
    @Override
    public String toString() {
        return "ReadByPropertySourceAndValue{" +
                "name='" + name + ''' +
                ", sex=" + sex +
                ", type='" + type + ''' +
                '}';
    }
}

範例二：@PropertySource 和 @ConfigurationProperties

package com.huang.pims.demo.props;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@PropertySource(value = {"demo/props/demo.properties"})
@ConfigurationProperties(prefix = "demo")
public class ReadByPropertySourceAndConfProperties {
    private String name;
    private int sex;
    private String type;
    public void setName(String name) {
        this.name = name;
    }
    public void setSex(int sex) {
        this.sex = sex;
    }
    public void setType(String type) {
        this.type = type;
    }
    public String getName() {
        return name;
    }
    public int getSex() {
        return sex;
    }
    public String getType() {
        return type;
    }
    @Override
    public String toString() {
        return "ReadByPropertySourceAndConfProperties{" +
                "name='" + name + ''' +
                ", sex=" + sex +
                ", type='" + type + ''' +
                '}';
    }
}

範例測試

package com.huang.pims.demo.runners;
import com.huang.pims.demo.props.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class OutputPropsRunner implements CommandLineRunner {
    private static final Logger LOGGER = LoggerFactory.getLogger(OutputPropsRunner.class);
    @Autowired
    private ReadByPropertySourceAndValue readByPropertySourceAndValue;
    @Autowired
    private ReadByPropertySourceAndConfProperties readByPropertySourceAndConfProperties;
    @Override
    public void run(String... args) throws Exception {
        LOGGER.info(readByPropertySourceAndValue.toString());
        LOGGER.info(readByPropertySourceAndConfProperties.toString());
    }
}

啟動專案即可看到效果。

從截圖中可以看出，需要讀取的屬性設定，都已經成功讀取出來了。

@PropertySource註解

@PropertySource是Spring boot為了方便引入properties組態檔提供的一個註解，可以標註在SpringBoot的啟動類上，還可以標註在設定類（使用@Configuration標註的類）上。

例如

@PropertySource(value = {"classpath:box.properties"})

將classpath下的box.properties，注入到Spring環境中，使用@Value（"${key}"）取值。

範例

box.properties檔案：

# 工具箱設定 
preserveFilePath=/box/webserver/uploadfile/preservefile/

注入：

@SpringBootApplication
@PropertySource(value = {"classpath:box.properties"})
public class ToolboxApiApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(ToolboxApiApplication.class, args);
    } 
}

取值：

@RestController
public class DeleteFileController {
    @Value("${preserveFilePath}")
    private String preserveFilePath;
 
    @GetMapping("/deleteFile")
    public void test(){
        System.out.println(preserveFilePath);
    }
}

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。

關於@PropertySource設定的用法解析

目錄

@PropertySource設定用法

功能

原始碼

使用範例

範例測試

@PropertySource註解

例如

範例

熱門文章