Spring Boot 配置文件

Spring Boot 使用 ”习惯优于配置“（项目中存在大量的配置，此外还内置了一个习惯性的配置，让你无需手动进行配置）的理念让你的项目快速运行起来。一般情况下默认的配置足够满足日常开发所需，但在特殊的情况下，我们往往需要用到自定义属性配置、自定义文件配置、外部命令引导、多环境配置等一系列功能。

一、配置注入

配置文件application.properties：

#自定义属性配置
my1.age=22
my1.name=taiotiao

在要使用的地方通过注解@Value(value=”${config.name}”)就可以绑定到你想要的属性上面

@RequestMapping("/properties")
@RestController
public class PropertiesController {
    @Value("${my1.age}")
    private int age;

    @Value("${my1.name}")
    private String name;

    @GetMapping("/0")
    public String index() {
        return name +":"+ age;
    }
}

有时候属性太多了，一个个绑定到属性字段上太累，官方提倡绑定一个对象的bean，这里我们定义 MyProperties1.java 文件，用来映射我们在application.properties中的内容，这样一来我们就可以通过操作对象的方式来获得配置文件的内容了。
注意顶部需要使用注解@ConfigurationProperties(prefix = “my1”)来指明映射的属性，如果不指定prefix则表示映射整个配置文件。

@Component
@ConfigurationProperties(prefix = "my1")
public class MyProperties1 {

    private int age;
    private String name;

	//省略 get set
}

接下来就是在 PropertiesController中注入MyProperties1测试我们编写的代码，值得注意的是 Spring4.x 以后，推荐使用构造函数的形式注入属性：

@RequestMapping("/properties")
@RestController
public class PropertiesController {
	private MyProperties1 myProperties1;
	
	@Autowired
	public PropertiesController(MyProperties1 myProperties1) {
        this.myProperties1 = myProperties1;
    }
    
    @GetMapping("/1")
    public MyProperties1 myProperties1() {
    	return myProperties1.getAge() +":"+ myProperties1.getName();
    }
}

二、自定义配置注入

有时候我们不希望把所有配置都放在application.properties里面，这时候我们可以另外定义一个，这里我们取名为my2.properties，路径跟也放在src/main/resources下面。

my2.age=22
my2.name=tiaotiao
my2.email=7758521@qq.com

其次定义MyProperties2.java文件，用来映射我们在my2.properties中的内容。

注意要添加@PropertySource("classpath:my2.properties")注解来加载外部属性，前面不用添加因为映射的是默认配置文件。

@Component
@PropertySource("classpath:my2.properties")
@ConfigurationProperties(prefix = "my2")
public class MyProperties2 {

    private int age;
    private String name;
    private String email;

	//省略 get set
}

接下来在PropertiesController用来注入MyProperties2测试我们编写的代码`

    @GetMapping("/2")
    public String myProperties2() {
        return myProperties2.getName() +":"+ myProperties2.getAge()
                +":"+ myProperties2.getEmail();
    }

补充：关于 @EnableConfigurationProperties 注解

@EnableConfigurationProperties注解的作用是：使使用 @ConfigurationProperties 注解的类生效。
@Component注解表明一个类会作为组件类，然后spring会为该类创建bean。

如果一个配置类只配置@ConfigurationProperties注解，而没有使用@Component，那么在IOC容器中是获取不到properties 配置文件转化的bean。说白了 @EnableConfigurationProperties 相当于把使用 @ConfigurationProperties 的类进行了一次注入。

三、外部配置-命令行参数配置

前面几种方式都是基于配置文件层面的，那么有没有办法外部引导呢，假设这样的场景，我们对已经开发完成的代码打包发布，期间在测试环境测试通过了，那么即可发布上生产，这个时候是修改application.properties的配置方便还是直接在命令参数配置方便呢，毫无疑问是后者更有说服力。

Spring Boot是基于jar包运行的，打成jar包的程序可以直接通过下面命令运行：

java -jar xx.jar

可以以下命令修改tomcat端口号：

java -jar xx.jar --server.port=9090

可以看出，命令行中连续的两个减号--就是对application.properties中的属性值进行赋值的标识。
所以java -jar xx.jar --server.port=9090等价于在application.properties中添加属性server.port=9090。
如果你怕命令行有风险，可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。

实际上，Spring Boot应用程序有多种设置途径，Spring Boot能从多重属性源获得属性，包括如下几种：

• 根目录下的开发工具全局设置属性(当开发工具激活时为~/.spring-boot-devtools.properties)。
• 测试中的@TestPropertySource注解。
• 测试中的@SpringBootTest#properties注解特性。
• 命令行参数
• SPRING_APPLICATION_JSON中的属性(环境变量或系统属性中的内联JSON嵌入)。
• ServletConfig初始化参数。
• ServletContext初始化参数。
• java:comp/env里的JNDI属性
• JVM系统属性
• 操作系统环境变量
• 随机生成的带random.* 前缀的属性（在设置其他属性时，可以应用他们，比如${random.long}）
• 应用程序以外的application.properties或者appliaction.yml文件
• 打包在应用程序内的application.properties或者appliaction.yml文件
• 通过@PropertySource标注的属性源
• 默认属性(通过SpringApplication.setDefaultProperties指定).

这里列表按组优先级排序，也就是说，任何在高优先级属性源里设置的属性都会覆盖低优先级的相同属性，列如我们上面提到的命令行属性就覆盖了application.properties的属性。

四、配置文件的优先级

application.properties和application.yml文件可以放在一下四个位置：

• 外置，在相对于应用程序运行目录的/congfig子目录里。
• 外置，在应用程序运行的目录里
• 内置，在config包内
• 内置，在Classpath根目录

同样，这个列表按照优先级排序，也就是说，src/main/resources/config下application.properties覆盖src/main/resources下application.properties中相同的属性。

此外，如果你在相同优先级位置同时有application.properties和application.yml，那么application.yml里面的属性就会覆盖application.properties里的属性。

五、Profile-多环境配置

在真实的应用中，常常会有多个环境（如：开发，测试，生产等），不同的环境数据库连接都不一样，这个时候就需要用到spring.profile.active 的强大功能了，它的格式为 application-{profile}.properties，这里的 application 为前缀不能改，{profile} 是我们自己定义的。

想要使用对应的环境，只需要在application.properties中使用spring.profiles.active属性来设置，值对应上面提到的{profile}

#application-dev.properties
server.servlet.context-path=/dev
#application-test.properties
server.servlet.context-path=/test
#application-prod.properties
server.servlet.context-path=/prod

当然你也可以用命令行启动的时候带上参数：

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

在 application.properties 配置文件中写入 spring.profiles.active=dev，这个时候我们在次访问 http://localhost:8080/properties/1 就没用处了，因为我们设置了它的context-path=/dev，所以新的路径就是 http://localhost:8080/dev/properties/1 ，由此可以看出来我们激活不同的配置读取的属性值是不一样的。

除了可以用profile的配置文件来分区配置我们的环境变量，在代码里，我们还可以直接用@Profile注解来进行配置，例如数据库配置，这里我们先定义一个接口

public  interface DBConnector { public  void  configure(); }

分别定义俩个实现类来实现它

/**
  * 测试数据库
  */
@Component
@Profile("testdb")
public class TestDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("testdb");
    }
}
/**
 * 生产数据库
 */
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("devdb");
    }
}

通过在配置文件激活具体使用哪个实现类

spring.profiles.active=testdb

然后就可以这么用了

@RestController
@RequestMapping("/task")
public class TaskController {

    @Autowired DBConnector connector ;

    @RequestMapping(value = {"/",""})
    public String hellTask(){

        connector.configure(); //最终打印testdb     
        return "hello task !! myage is " + myage;
    }
}

除了spring.profiles.active来激活一个或者多个profile之外，还可以用spring.profiles.include来叠加profile

spring.profiles.active: testdb  
spring.profiles.include: proddb,prodmq