前言:在springboot 项目中一般默认的配置文件是application.properties,但是实际项目中我们一般会使用application.yml 文件,
下面就介绍一下在springboot 中读取 yml 配置的几种方式.
yml 文件规则
- yml文件的好处,天然的树状结构,一目了然,实质上跟properties是差不多的。
- 不支持tab缩进
- 可以使用 "-小写字母" 或 "_小写字母"来 代替 "大写字母",如 userName 与 user-name ,user_name 含义是一样的
key: value 格式书写
key 后面跟着冒号,再后面跟着一个空格,然后是值
几种数据格式的表示方式
- 1.普通的值(数字,字符串,布尔)
- 2.对象、Map (属性和值) (键值对)
- 3.数组 (List、Set)
普通的值(数字,字符串,布尔)
直接就是 key: value ,如:
age: 18
name: mysgk
注:
字符串默认不用加上单引号或者双引号;
"":双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
name: "zhangsan \n lisi":输出;zhangsan 换行 lisi
'':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据
name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi
对象、Map(属性和值)(键值对)
对象还是k: v的方式
k: v:在下一行来写对象的属性和值的关系;注意缩进(不支持tab,使用空格),如:
person:
age: 18
name: mysgk
数组(List、Set)
用- 值表示数组中的一个元素,如:
hands:
- left
- right
第一种读取方式@value
package com.aliyun.mq.service;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
/**
* 获取 yml 配置
*/
@Service("ymlService")
public class YmlService {
@Value("${server.port}")
private String port;
public String getPort() {
return port;
}
}
使用案例
@Resource(name = "ymlService")
private YmlService ymlService;
@GetMapping("/")
public String index(){
return "api.key : " + ymlService.getPort();
}
第二种读取方式@ConfigurationProperties
如果需要一个JavaBean 来专门映射配置的话,我们一般会使用@ConfigurationProperties来读取
第三种读取方式@Environment
这种方法好像用的比较少,基本没用过...
api:
key: 123456
代码:
package com.aliyun.mq.service;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Service;
/**
* 获取 yml 配置
*/
@Service("ymlProp")
public class YmlProp {
@Autowired
private Environment env;
public String getKey() {
return env.getProperty("api.key");
}
}
使用案例
@Resource(name = "ymlProp")
private YmlProp ymlProp;
@GetMapping("/")
public String index(){
return "api.key : " + ymlProp.getKey();
}
:使用 Profile 实现多环境配置
我们在项目发布之前,一般需要频繁地在开发环境、测试环境以及生产环境之间进行切换,这个时候大量的配置需要频繁更改(比如数据库配置、redis 配置、mongodb 配置等等)。
Spring Boot 的 Profile 就给我们提供了解决方案,它约定不同环境下的配置文件名称规则为:
- application-{profile}.yml,其中 {profile} 表示当前环境的名称。
1,创建配置文件
(1)首先在 resources 目录下创建两个配置文件:application-dev.yml 和 application-prod.yml 此时,分别表示开发环境中的配置和生产环境中的配置。
(2)它们两个分别设置不同的端口号。
#application-dev.yml
server:
port: 8080
#application-prod.yml
server:
port: 80
2,在 application.yml 中配置环境
(1)假设我们在 application.yml 中进行如下配置,则表示使用 application-dev.yml 配置文件启动项目。
spring:
profiles:
active: dev
(2)如果将 dev 改为 prod,则表示使用 application-prod.properties 启动项目。
spring:
profiles:
active: prod
(3)项目启动成功后,就可以通过相应的端口进行访问了。
3,在代码中配置环境
(1)除了像前面那样在 application.yml 中添加配置,我们也可以在代码中添加配置来完成。
(2)比如我们在启动类的 main 方法上添加如下代码,表示使用 application-dev.yml 配置文件启动项目。
package com.example.demo;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplicationBuilder builder = new SpringApplicationBuilder(DemoApplication.class);
builder.application().setAdditionalProfiles("dev");
builder.run(args);
}
}
4,在项目启动时配置环境
我们也可以在项目打包成 jar 包后启动时,在命令行中动态指定当前环境:
java -jar xxx.jar --spring.profiles.active=dev