SpringBoot-property属性设置

  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文件中。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容