SpringBoot | 第二十七章：SpringBoot属性配置文件详解
springboot采纳了建立生产就绪Spring应用程序的观点。 Spring Boot优先于配置的惯例，旨在让您尽快启动和运行。在一般情况下，我们不需要做太多的配置就能够让spring boot正常运行。在一些特殊的情况下，我们需要做修改一些配置，或者需要有自己的配置属性。
一、创建SpringBoot项目springboot-config，引入pom依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.thinkingcao</groupId>
<artifactId>springboot-config</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot-config</name>
<description>Spring Boot配置文件详解</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
二、自定义属性
当我们创建一个springboot项目的时候，系统默认会为我们在src/main/java/resources目录下创建一个application.properties。个人习惯，我会将application.properties改为application.yml文件，两种文件格式都支持。
在application.yml自定义一组属性：
my:
name: thinkingcao
age: 24
如果你需要读取配置文件的值只需要加@Value(“${属性名}”)：
@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;
}
}
启动工程，访问：localhost:8080/miya,浏览器显示：
thinkingcao:24
二、将配置文件的属性赋给实体类
当我们有很多配置属性的时候，这时我们会把这些属性作为字段来创建一个javabean，并将属性值赋予给他们,比如：
my:
name: thinkingcao
age: 24
number: ${random.int}
uuid : ${random.uuid}
max: ${random.int(10)}
value: ${random.value}
greeting: hi,i'm ${my.name}
其中配置文件中用到了${random} ，它可以用来生成各种不同类型的随机值。
怎么讲这些属性赋于给一个javabean 呢，首先创建一个javabean ：
package com.thinkingcao.springbootconfig.entity;
import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
* <pre>
* @Description:
* @Aouth: cao_wencao
* @Date: 2019-02-19 14:52
* </pre>
*/
@Data
@ToString
@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;
}
需要加个注解@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();
}
启动工程，访问localhost:8080/lucy,我们会发现配置文件信息读到了。
三、自定义配置文件
上面介绍的是我们都把配置文件写到application.yml中。有时我们不愿意把配置都写到application配置文件中，这时需要我们自定义配置文件，比如test.properties:
com.thinkingcao.name=thinkingcao
com.thinkingcao.age=24怎么将这个配置文件信息赋予给一个javabean呢？
package com.thinkingcao.springbootconfig.entity;
import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
/**
* <pre>
* @Description:
* @Aouth: cao_wencao
* @Date: 2019-02-19 15:17
* </pre>
*/
@Data
@ToString
@Configuration
@PropertySource(value = "classpath:test.properties")
@ConfigurationProperties(prefix = "com.thinkingcao")
public class User {
private String name;
private int age;
}
在最新版本的springboot，需要加这三个注解。@Configuration @PropertySource(value = “classpath:test.properties”) @ConfigurationProperties(prefix = “com.forezp”);在1.4版本需要 PropertySource加上location。
package com.thinkingcao.springbootconfig.web;
import com.thinkingcao.springbootconfig.entity.ConfigBean;
import com.thinkingcao.springbootconfig.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@EnableConfigurationProperties({ConfigBean.class})
public class LucyController {
@Autowired
private ConfigBean configBean;
@Autowired
private User user;
@RequestMapping(value = "/lucy")
public String miya() {
return configBean.getGreeting() + " >>>>" + configBean.getName() + " >>>>" + configBean.getUuid() + " >>>>" + configBean.getMax();
}
@RequestMapping(value = "/user")
public String user() {
return user.getName() + user.getAge();
}
}
启动工程，打开localhost:8080/user;浏览器会显示：
thinkingcao 24
四、多个环境配置文件
在现实的开发环境中，我们需要不同的配置环境；格式为application-{profile}.properties，其中{profile}对应你的环境标识，比如：
- application-test.properties：测试环境
- application-dev.properties：开发环境
- application-prod.properties：生产环境
怎么使用？只需要我们在application.yml中加：
spring:
profiles:
active: dev
其中application-dev.yml:
server:
port: 8082
启动工程，发现程序的端口不再是8080,而是8082。
五、项目完成结构图
六、参考文献
https://www.fangzhipeng.com/springboot/2017/05/02/sb2-config-file.html
spring-boot-reference-guide-zh