springboot（2）SpringBoot配置文件

一、自定义属性

创建一个springboot项目的时候，系统默认会为我们在src/main/java/resources目录下创建一个application.properties。将application.properties改为application.yml文件，两种文件格式都支持。
在application.yml自定义一组属性：
需要注意的是：
编辑yml文件时不能使用TAB键来缩进，否则启动会报错。
键值之间需要一个空格，比如enabled: true 即true前面其实是有一个空格的，否则会报错。

my:
 name: 
   first: zhang
   second: san
 age: 12

如果你需要读取配置文件的值只需要加@Value(“${属性名}”)：

@RestController
@RequestMapping("my") //url中的前缀
public class MiyaController {

    @Value("${my.name.first}")
    private String firstName;
    @Value("${my.age}")
    private int age;

    @RequestMapping(value = "/miya")
    public String miya(){
        return firstName+":"+age;
    }

}

启动工程，访问：localhost:8080/my/miya,浏览器显示：

zhang:12

二、将配置文件的属性赋给实体类

当我们有很多配置属性的时候，这时我们会把这些属性作为字段来创建一个javabean，并将属性值赋予给他们,比如：

my:
 name: forezp
 age: 12
 number:  ${random.int}
 uuid : ${random.uuid}
 max: ${random.int(10)}
 value: ${random.value}
 greeting: hi,i'm  ${my.name}

配置文件中用到了 ${random} ，它可以用来生成各种不同类型的随机值。$ {my.name}:获取配置中的值。

将这些属性赋于给一个javabean ，首先创建一个javabean ：

@ConfigurationProperties(prefix = "my")
@Component
public class ConfigBean {

    private String name;
    private int age;
    private int number;
    private String uuid;
    private int max;
    private String value;
    private String greeting;

    省略了getter setter....

需要加个注解@ConfigurationProperties，并加上它的prrfix。另外@Component可加可不加。另外spring-boot-configuration-processor依赖可加可不加，具体原因不详。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

另外需要在应用类或者application类，加EnableConfigurationProperties注解（引入实体类）。

@RestController
//引入实体类
@EnableConfigurationProperties({ConfigBean.class})
public class LucyController {
    @Autowired//自动检测引入该类
    ConfigBean configBean;

    @RequestMapping(value = "/lucy")
    public String miya(){
        return configBean.getGreeting()+" >>>>"+configBean.getName()+" >>>>"+ configBean.getUuid()+" >>>>"+configBean.getMax();
    }
}

注解 @Autowired ：它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。通过 @Autowired的使用来消除 set ，get方法。进行自动注入时，spring容器中匹配的候选Bean数目必须有且仅有一个。

访问localhost:8080/lucy,我们会发现配置文件信息读到了.

三、自定义配置文件

有时我们不愿意把配置都写到application配置文件中，这时需要我们自定义配置文件，比如test.properties:

com.forezp.name=forezp
com.forezp.age=12

@Configuration
@PropertySource(value = "classpath:test.properties")
@ConfigurationProperties(prefix = "com.forezp")
public class User {
    private String name;
    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

在最新版本的springboot，需要加这三个注解。@Configuration
@PropertySource(value = “classpath:test.properties”)
@ConfigurationProperties(prefix = “com.forezp”);在1.4版本需要
PropertySource加上location。

@RestController
@EnableConfigurationProperties({ConfigBean.class,User.class})
public class LucyController {
    @Autowired
    ConfigBean configBean;

    @RequestMapping(value = "/lucy")
    public String miya(){
        return configBean.getGreeting()+" >>>>"+configBean.getName()+" >>>>"+ configBean.getUuid()+" >>>>"+configBean.getMax();
    }

    @Autowired
    User user;
    @RequestMapping(value = "/user")
    public String user(){
        return user.getName()+user.getAge();
    }

}

启动工程，打开localhost:8080/user;浏览器会显示：

forezp12

四、多个环境配置文件

在现实的开发环境中，我们需要不同的配置环境；格式为application-{profile}.properties，其中{profile}对应你的环境标识，比如：

application-test.properties：测试环境
application-dev.properties：开发环境
application-prod.properties：生产环境

怎么使用？只需要我们在application.yml中加：

#配置激活的配置文件为dev
spring:
  profiles:
    active: dev

其中application-dev.yml:

#配置端口号
server:
  port: 8082