1、读取application.yml/properties中的配置
这里以application.yml为示例进行说明
application.yml文件中既可以有系统相关的配置，也可以有自定义的配置，假设我们的application.yml文件中的内容如下：
# 系统相关的配置
server:
port: 8081
# 自定义配置
# 1、简单变量
name: Kobe Bryant
age: 33
# 引用其他变量
playerInfo: "name:${name},age:${age}"
# 2、有层次关系的
player:
name: 科比
club: 湖人
age: 33
1.1 直接读取application.yml文件中的配置
只需要在给变量添加@Value("${属性名}")注解即可，例如
@Value("${name}")
private String name;
如果是多层次的，例如上面配置文件中的player节点，则按照类似Java包的形式
@Value("${player.name}")
private String h_name;
完整的示例代码：
@RestController
@RequestMapping("/app_var")
public class AppVarController {
@Value("${name}")
private String name;
@Value("${age}")
private int age;
@Value("${playerInfo}")
private String playerInfo;
/**
* 有层次关系的变量读取
*
* @return
*/
@Value("${player.name}")
private String h_name;
@Value("${player.club}")
private String h_club;
@GetMapping("/info")
public String getCustomConfigInfo() {
return name + " " + age + " " + playerInfo;
}
@GetMapping("/hier")
public String getHierachyInfo() {
return h_name + "所在的俱乐部是：" + h_club;
}
}
1.2 读取application.yml文件中的配置到一个实体类中
当配置信息比较多时，这样写就比较凌乱了，最好是使用一个实体类来承载这些配置信息。
首先定义一个实体类，然后添加如下的注解，其中prefix就是层级关系的前缀
@ConfigurationProperties(prefix = "player")
完整的代码如下，其中@Component注解是可以不加的，但是不加在IDEA开发环境下会有红色警告。
/**
* 球员信息的实体类
*
* @author xiaozhao
* @date 2018/10/19上午10:09
*/
@ConfigurationProperties(prefix = "player")
@Component // 此注解可加可不加
public class Player {
private String name;
private String club;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getClub() {
return club;
}
public void setClub(String club) {
this.club = club;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
然后在调用的地方添加注解，例如在控制器或者服务中
@EnableConfigurationProperties({Player.class})
完整的代码如下：
/**
* 把application.yml/properties 中的自定义配置，读取到一个实体类中
*
* @author xiaozhao
* @date 2018/10/19上午10:14
*/
@RestController
@RequestMapping("/app_bean")
@EnableConfigurationProperties({Player.class})
public class AppBeanController {
@Autowired
private Player player;
@GetMapping("/info")
public String getPlayerInfo() {
return "app_bean: " + player.getName() + " " + player.getClub() + " " + player.getAge();
}
}
2、读取自定义配置文件中的信息，例如XX.properties
有时候我们一般不会把太多的自定义信息放到application.yml中，而是单独定义一些配置文件，这样比较好维护和切割配置。
假设在src>main>resources下有一个文件夹config，里面有一个settings.properties文件，内容如下：
com.test.name=Jim
com.test.age=30
1.1 直接读取自定义配置文件中的值
需要使用到 @PropertySource 注解和 Environment接口。
使用比较简单，就是给@PropertySource指定配置文件的路径，然后使用Environment的getProperty方法读取。
代码如下：
/**
* 直接读取自定义配置文件中的值
*
* @author xiaozhao
* @date 2018/10/19上午10:20
*/
@RestController
@RequestMapping("/cus_var")
@PropertySource("classpath:config/settings.properties")
public class CustomVarController {
@Autowired
private Environment environment;
@GetMapping("/info")
public String getInfo() {
String name = environment.getProperty("com.test.name");
int age = Integer.valueOf(environment.getProperty("com.test.age"));
return name + ":" + age;
}
}
1.2 读取自定义配置文件中的值到一个实体类中
首先需要定义一个实体类，需要用到如下3个注解，分别指定前缀，文件路径
@Configuration
@ConfigurationProperties(prefix = "com.test")
@PropertySource("classpath:config/settings.properties")
完整代码：
/**
* 自定义配置实体类
*
* @author xiaozhao
* @date 2018/10/18下午4:59
*/
@Configuration
@ConfigurationProperties(prefix = "com.test")
@PropertySource("classpath:config/settings.properties")
public class Setting {
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;
}
}
然后在使用的地方把实体类进行注入即可
/**
* 把自定义配置文件读取到一个实体类中
*
* @author xiaozhao
* @date 2018/10/19上午10:31
*/
@RestController
@RequestMapping("/cus_bean")
public class CustomBeanController {
@Autowired
private Setting setting;
@GetMapping("/info")
public String getInfo() {
return setting.getName() + ":" + setting.getAge();
}
}
最后补充一下，在IDEA中提示需要spring-boot-configuration-processor依赖，但是不添加的话也是可以正常运行的，但是会有一个红色的警告提示。
项目代码
https://github.com/xiaozhaowen/spring-boot-in-action/tree/master/springboot-config
