美文网首页
SpringBoot-property属性设置

SpringBoot-property属性设置

作者: lazyguy | 来源:发表于2017-09-27 16:54 被阅读0次
    1. Spring的devtools的全局配置(~/.spring-boot-devtools.properties文件)(当使用了devtools时)
    2. Test类上通过@TestPropertySource声明的属性文件
    3. Test类上通过@SpringBootTest#properties声明的属性
      命令行参数 : java -jar xxx.jar -DyourProperty=yourValue
    4. SPRING_APPLICATION_JSON属性, 环境变量或系统属性中的JSON
    5. ServletConfig初始化参数
    6. ServletContext初始化参数
    7. 来自于java:comp/env的JNDI属性
    8. Java系统属性(System.getProperties())
    9. 操作系统环境变量
    10. 通过RandomValuePropertySource生成的random.*属性
    11. jar包外的profile配置文件(application-{profile}.properties和YAML配置)
    12. jar包内的profile配置文件(application-{profile}.properties和YAML配置)
    13. jar包外的应用程序配置文件(application.properties和YAML配置)
    14. jar包内的应用程序配置文件(application.properties和YAML配置)
    15. 配置类(@Configuration类)上的通过@PropertySource注解声明的属性文件
    16. 通过SpringApplication.setDefaultProperties声明的默认属性

    properties属性使用方法

    通常在spring中最简单的使用注入到spring中的属性的方法是使用@Value注解。

    @Value("${yourProperty}")
    private String yourProperty
    

    另外可以使用@ConfigurationProperties和@EnableConfigurationProperties注解,可以将spring环境中的属性注入到此类中,结构化的使用一组有关联的属性,同时可以利用JSR-303 @Validated @NotNull 这样的注解。

    需要属性被注入的Property类:
    可以为其写上前缀,“t”代表我们要注入的属性的前缀。比如
    good这个属性就需要spring的上下文环境有属性名为 t.good 才能被注入。
    如果使用jsr303的注解验证,相应属性在不符合条件的时候就会在启动时报错。

    @ConfigurationProperties(prefix = "t")
    public class TestProperties {
        private Boolean good;
        @NotEmpty
        private String name;
        @NotNull
        private Integer age;
        private Map<String,String> map;
    
        public Map<String, String> getMap() {
            return map;
        }
    
        public void setMap(Map<String, String> map) {
            this.map = map;
        }
    
        public static class Inner{
           private Integer level;
    
            public Integer getLevel() {
                return level;
            }
    
            public void setLevel(Integer level) {
                this.level = level;
            }
    
            @Override
            public String toString() {
                return "Inner{" +
                        "level=" + level +
                        '}';
            }
        }
        public Inner getInner(){
            return inner;
        }
        private final Inner inner = new Inner();
    
    
        public Boolean getGood() {
            return good;
        }
    
        public void setGood(Boolean good) {
            this.good = good;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public Integer getAge() {
            return age;
        }
    
        public void setAge(Integer age) {
            this.age = age;
        }
    
        @Override
        public String toString() {
            return "TestProperties{" +
                    "good=" + good +
                    ", name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }
    

    然后在spring的配置源文件上写上@EnableConfigurationProperties({TestProperties.class}),TestProperties就会被注册为一个bean,同时相关的属性就会被注入到此类中。这个Bean的名字默认为属性类的那个前缀和其全类名,如上的属性类就会是:t-org.yyf.springBootDemo.propDemo.TestProperties

    如果是gradle构建,加入:

    dependencies {
      //为@ConfigurationProperties属性生成spring-configuration-metadata.json,需要配合compileJava.dependsOn(processResources)
      compileOnly 'org.springframework.boot:spring-boot-configuration-processor'
    }
    compileJava.dependsOn(processResources)//没有这句,不会生成 additional-spring-configuration-metadata.json
    

    可以在生成的jar中生成 /META-INF/spring-configuration-metadata.json 文件
    这个文件的作用是为源文件中被标记了@ConfigurationProperties的属性类生成相应的提示,这样IDE就可以自动为你在使用该jar的时候提供智能提示。
    如果你想提供额外的信息放入json文件,就自己构建 /META-INF/additional-spring-configuration-metadata.json文件,其中的信息会被合并入生成的json文件中。

    相关文章

      网友评论

          本文标题:SpringBoot-property属性设置

          本文链接:https://www.haomeiwen.com/subject/cyzrextx.html