Spring Boot入门(二)：获取配置文件值

2019 年 10 月 28 日
笔记

本篇博客主要讲解下在Spring Boot中如何获取配置文件的值。

1. 使用yaml配置文件

Spring Boot默认生成的配置文件为application.properties，不过它也支持yaml语言的配置文件，

两者之间的差别并不是很大，只是yaml语言的配置文件层次结构更明显，可读性更强，因此目前使用的更多一些。

我们假设本来application.properties的配置为：

spring.main.banner-mode=off

那么如何将配置文件切换为application.yml呢？

首先删除掉原来的配置文件application.properties，新增配置文件application.yml，新增方式如下：

然后修改application.yml为：

spring:    main:      banner-mode: "off"

运行结果和原来使用properties配置文件时一致。

2. 使用@Value注解获取配置文件值

首先在application.yml中添加如下配置：

book:    author: wangyunfei    name: spring boot

然后修改启动类的代码为：

package com.zwwhnly.springbootaction;    import org.springframework.beans.factory.annotation.Value;  import org.springframework.boot.SpringApplication;  import org.springframework.boot.autoconfigure.SpringBootApplication;  import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RestController;    @RestController  @SpringBootApplication  public class SpringbootActionApplication {      @Value("${book.name}")      private String bookName;        @Value("${book.author}")      private String bookAuthor;        @RequestMapping("/")      public String index() {          return "book name is:" + bookName + " and book author is:" + bookAuthor;      }        public static void main(String[] args) {          SpringApplication.run(SpringbootActionApplication.class, args);      }  }

运行项目，在浏览器中输入http://localhost:8080/，会看到如下信息：

这种方式和在Spring项目中的使用方式一样，更多的细节，可以查看我之前总结的博客：

Spring入门(九)：运行时值注入。

3. 使用@ConfigurationProperties注解获取配置文件值

Spring Boot还提供了@ConfigurationProperties注解来获取配置文件值，该种方式可把配置文件值和一个Bean自动关联起来，使用起来更加方便而且类型安全，建议使用这种方式。

首先，在application.yml中添加如下配置：

author:    name: wangyunfei    age: 32

然后，新建类AuthorSettings，添加@Component注解和@ConfigurationProperties注解：

package com.zwwhnly.springbootaction;    import org.springframework.boot.context.properties.ConfigurationProperties;  import org.springframework.stereotype.Component;    @Component  @ConfigurationProperties(prefix = "author")  public class AuthorSettings {      private String name;      private Integer age;        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;      }  }

这里的重点是@ConfigurationProperties注解，它的prefix属性用来指定配置的前缀，如本例中的author。

然后修改启动类的代码为：

package com.zwwhnly.springbootaction;    import org.springframework.beans.factory.annotation.Autowired;  import org.springframework.boot.SpringApplication;  import org.springframework.boot.autoconfigure.SpringBootApplication;  import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RestController;    @RestController  @SpringBootApplication  public class SpringbootActionApplication {      @Autowired      private AuthorSettings authorSettings;        @RequestMapping("/")      public String index() {          return "author name is " + authorSettings.getName() + " and author age is " + authorSettings.getAge();      }        public static void main(String[] args) {          SpringApplication.run(SpringbootActionApplication.class, args);      }  }

运行项目，在浏览器中输入http://localhost:8080/，会看到如下信息：