Spring Cloud与微服务构建（四）开发框架Spring Boot 4.3 Spring Boot配置文件详解

Spring Boot采用了构建生产就绪Spring应用程序的观点，旨在让程序快速启动和运行。在一般情况下，不需要做太多的配置就能让Spring Boot程序正常运行。在一些特殊的情况下，我们需要修改一些配置，或者需要有自己的配置。

4.3.1 自定义属性

在用IDEA创建一个Spring Boot工程时，系统默认会在src/main/java/resources目录下创建一个配置文件application.properties。它也支持yml格式的文件，下面以yml格式的文件为例来讲解如何自定义属性。
在工程的配置文件application.yml自定义一组属性，如下：

my:
  name: mengzhitk
  age: 30

如果要读取配置文件application.yml的属性值，只需在变量上加@Value("${属性名}")注解，就可以将配置文件application.yml的一个属性值赋给一个变量。新建一个Controller，其代码清单如下：

@RestController
public class MiyaController {
    @Value("${my.name}")
    private String name;
    @Value("${my.age}")
    private int age;
    
    @RequestMapping(value = "/miya")
    public String miya(){
        return name+";"+age;
    }
}

启动工程SpringBoot，打开浏览器访问"http://localhost:8080/miya",浏览器显示如下：

mengzhitk;30

这说明配置文件application.yml的属性my.name和my.age已经成功读入应用程序中。

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

当有很多配置属性时，如果逐个地读取 属性会非常麻烦。通常的做法会把这些属性名作为变量名来创建一个JavaBean的变量，并将属性值赋给JavaBean变量的值。
在配置文件application.yml中添加如下属性：

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

其中，配置文件中用到了${random}，它可以用来生成各种不同类型的随机值。random.int随机生成一个int类型的值，random.uuid随机生成一个uuid，random.value随机生成一个值，random.int(10)随机生成一个小于10的整数。
怎么将这些属性赋给一个JavaBean呢？创建一个JavaBean，其代码清单如下：

package com.mengzhitk.springbootfirst.conf;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@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;


    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;
    }

    public int getNumber() {
        return number;
    }

    public void setNumber(int number) {
        this.number = number;
    }

    public String getUuid() {
        return uuid;
    }

    public void setUuid(String uuid) {
        this.uuid = uuid;
    }

    public int getMax() {
        return max;
    }

    public void setMax(int max) {
        this.max = max;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    public String getGreeting() {
        return greeting;
    }

    public void setGreeting(String greeting) {
        this.greeting = greeting;
    }
}

在上面的代码中，在ConfigBean类上加一个注解@ConfigurationProperties，表明该类为配置属性类，并加上配置的prefix,例如本案例的"my"。另外需要在ConfigBean类上加@Component注解，Spring Boot在启动时通过包扫描将该类作为一个Bean注入IoC容器中。

创建一个Controller，读取ConfigBean类的属性。在Controller类上，加@EnableConfigurationProperties注解，并指明ConfigBean类，其代码清单如下：

@RestController
@EnableConfigurationProperties({ConfigBean.class})
public class LucyController {
    @Autowired
    ConfigBean configBean;
    @RequestMapping(value = "/lucy")
    public String lucy(){
        return configBean.getGreeting()+"-"+configBean.getName()+"-"+configBean.getUuid()+"-"+configBean.getMax();
    }
}

启动工程，在浏览器上访问"http://localhost:8080/lucy"，浏览器会显示从配置文件读取的属性。

4.3.3 自定义配置文件

上面介绍了如何把配置属性写到application.yml配置文件中，并把配置属性读到到一个配置类中。有时属性太多，把所有的配置属性都写到application.yml配置文件中不太合适，这时需要自定义配置文件。例如在src/main/resources目录下自定义一个test.properties配置文件，其配置信息如下：

com.rock.name=rock
com.rock.age=12

如何将这个配置文件test.properties的属性和属性值给一个JavaBean呢？需要在类名上加@Configuration、@PropertySource和@ConfigurationProperties这3个注解需要注意的是，若Spring Boot版本为1.4或之前版本，则需要在@PropertySource注解上加location，并指明该配置文件的路径。本案例采用的Spring Boot版本为1.5，代码如下:

@Configuration
@PropertySource(value = "classpath:test.properties")
@ConfigurationProperties(prefix = "com.rock")
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;
    }
}

写一个LucyController的类，在类的方法上方加上@RestController注解，开启RestController的功能；加上@EnableConfigurationProperties注解，并指明需要引入的JavaBean的类，开启引用配置属性的功能，其代码清单如下：

@RestController
@EnableConfigurationProperties({ConfigBean.class,User.class})
public class LucyController {
    @Autowired
    ConfigBean configBean;
    @RequestMapping(value = "/lucy")
    public String lucy(){
        return configBean.getGreeting()+"-"+configBean.getName()+"-"+configBean.getUuid()+"-"+configBean.getMax();
    }

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

启动工程，在浏览器上访问“http://localhost:8080/user”。浏览器会显示

rock:12

说明自定义配置文件的属性被读取到了JavaBean中。

4.3.4 多个环境的配置文件

在实际开发中，可能有多个不同环境的配置文件，例如：开发环境、测试环境、生产环境等。Spring Boot支持程序启动时在配置文件application.yml中指定环境的配置文件，配置文件的格式为application-{profile}.properties，其中{profile}对应环境标识，例如：

• application-test.properties —— 测试环境
• application-dev.properties —— 开发环境
• application-prod.properties —— 生产环境。

如何指定这个环境配置文件呢？只需要在application.yml中加上spring.profiles.active的配置，该配置指定采用哪一个profiles。例如使用application-dev.properties，则配置代码如下：

spring:
  profiles:
    active: dev

其中，application-dev.yml的配置文件中指定程序启动端口，配置代码如下

server:
  port: 8082

启动工程，查看控制台打印的日志，程序启动端口为8082，而不是默认的8080，这说明配置文件生效了。

Tomcat started on port(s): 8082 (http)

另外，我们也可以通过java-jar这种方式启动程序，并指定程序的配置文件，启动命令如下：

java -jar springbootdemo.jar -- spring.profiles.active=dev