Spring Boot 配置文件

朴灿烈づ我的快乐病毒、 2023-05-30 10:52 28阅读 0赞

一 配置文件类型

  1. Spring Boot默认支持propertiesyml两种格式的配置文件。yml格式是天然的树状接口,相对于propertiesyml更加的一目了然。这也是我们推荐的配置文件格式。

properties 格式举例

  1. server.port=8090
  2. server.session-timeout=30
  3. server.tomcat.max-threads=0
  4. server.tomcat.uri-encoding=UTF-8
  5. spring.datasource.url=jdbc:mysql://localhost:3306/newbirds
  6. spring.datasource.username=root
  7. spring.datasource.password=mymysql
  8. spring.datasource.driverClassName=com.mysql.jdbc.Driver
  9. spring.jpa.database=MYSQL
  10. spring.jpa.show-sql=true
  11. spring.jpa.hibernate.ddl-auto=update
  12. spring.jpa.hibernate.naming-strategy=org.hibernate.cfg.ImprovedNamingStrategy
  13. spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

yml 格式举例

  1. server:
  2. port: 8090
  3. session-timeout: 30
  4. tomcat.max-threads: 0
  5. tomcat.uri-encoding: UTF-8
  6. spring:
  7. datasource:
  8. url: jdbc:mysql://localhost:3306/newbirds
  9. username: root
  10. password: mymysql
  11. driverClassName: com.mysql.jdbc.Driver
  12. jpa:
  13. database: MYSQL
  14. show-sql: true
  15. hibernate:
  16. ddl-auto: update
  17. naming-strategy: org.hibernate.cfg.ImprovedNamingStrategy
  18. properties:
  19. hibernate:
  20. dialect : org.hibernate.dialect.MySQL5Dialect

二 配置文件

2.1 核心配置文件

  1. Spring Boot默认支持两种核心配置文件:bootstrap.yml(bootstrap.properties)、application.yml(application.properties)。bootsrap先加载。

2.1.1 bootstrap.yml(bootstrap.properties)

  1. bootstrap.yml用于应用程序上文的引导节点,由父Spring ApplicationContext加载。我们可以简单的把bootstrap里面的配置信息理解成系统级别的参数。这些参数轻易是不会改变的。
  2. bootstrap配置文件有以下几个应用场景。
  • 使用Spring Cloud Config的时候,需要将spring.application.name和spring.cloud.config.server.git.uri写入bootstrap.yml。
  • 一些固定的不能被覆盖的属性。
  • 一些加密/解密的场景。会把encryption/decryption(加密/解密)存储在bootstrap.yml里面。

    一旦bootStrap.yml 被加载,则内容不会被覆盖,即便后期加载的application.yml的内容标签与bootstrap的标签一致,application 也不会覆盖bootstrap。

2.1.2 application.yml(application.properties)

  1. application.yml是我们用的最多的一个配置文件.一般配置应用级别的配置,比如数据库的连接配置,如果我们用到了redis可能会写一些redis相关的配置等等。

2.2 自定义配置文件

  1. 为了不破坏核心文件的原生态,但又需要有自定义的配置信息存在,一般情况下会选择自定义配置文件来放这些自定义信息,比如我们在resource目录下创建一个product.properties文件.

resources/product.properties文件内容如下

  1. ppid = 1000
  2. mmid = 1
  3. ccid = 10

三 配置文件读取

3.1 读取核心配置文件信息

  1. 读取核心配置文件信息值的是读取bootstrap.yml(bootstrap.properties)、application.yml(application.properties)文件里面的信息.

3.1.1 Environment方式

  1. 这种方式是依赖注入Evnironment来完成,在创建的成员变量private Environment env上加上@Autowired注解即可完成依赖注入,然后使用env.getProperty(“键名”)即可读取出对应的值。比如如下的代码.

application.yml文件里面添加我们自定义的属性

  1. # 自定义的一些属性
  2. user:
  3. info:
  4. name: tuacy
  5. age: 27

Environment方式读取配置信息

  1. @RunWith(SpringRunner.class)
  2. @SpringBootTest()
  3. public class PropertiesTest {
  4. private Environment environment;
  5. @Autowired
  6. public void setEnvironment(Environment environment) {
  7. this.environment = environment;
  8. }
  9. @Test
  10. public void test() {
  11. String name = environment.getProperty("user.info.name");
  12. Integer age = environment.getProperty("user.info.age", Integer.class);
  13. System.out.println("name = " + name + "; age = " + age);
  14. }
  15. }

3.1.2 @Value方式

  1. @Value$\{\}中包含的是核心配置文件中的键名就可以得到对应的值.
  2. @RunWith(SpringRunner.class)
  3. @SpringBootTest()
  4. public class PropertiesTest {
  5. @Value("${user.info.name}")
  6. private String name;
  7. @Value("${user.info.age}")
  8. private int age;
  9. @Test
  10. public void test() {
  11. System.out.println("name = " + name + "; age = " + age);
  12. }
  13. }

3.1.3 @ConfigurationProperties方式

  1. @ConfigurationProperties使用的时候对应的属性类一定要记得加上@Configuration或者在任何一个配置类(推荐启动类上)通过@EnableConfigurationProperties注解指定自定义的属性类.推荐直接在属性类上添加@Configuration注解.
  2. @Configuration
  3. @ConfigurationProperties(prefix = "user.info")
  4. public class UserInfo {
  5. private int age;
  6. private String name;
  7. public String getName() {
  8. return name;
  9. }
  10. public void setName(String name) {
  11. this.name = name;
  12. }
  13. public int getAge() {
  14. return age;
  15. }
  16. public void setAge(int age) {
  17. this.age = age;
  18. }
  19. }

3.2 读取自定义配置文件信息

3.2.1 @PropertySource + @Value

  1. @PropertySource + @Value使用于读取property根式配置文件的信息.@PropertySource指定配置文件路径和编码格式,@Value指定配置文件里面的key值.

自定义的配置文件 product.properties

  1. ppid = 1000
  2. mmid = 1
  3. ccid = 10

对应的读取方式

  1. @Configuration
  2. @PropertySource(value = "classpath:product.properties", encoding = "utf-8")
  3. public class ProductInfo {
  4. @Value("${ppid}")
  5. private int pid;
  6. @Value("${mmid}")
  7. private int mid;
  8. @Value("${ccid}")
  9. private int cid;
  10. public int getPid() {
  11. return pid;
  12. }
  13. public void setPid(int pid) {
  14. this.pid = pid;
  15. }
  16. public int getMid() {
  17. return mid;
  18. }
  19. public void setMid(int mid) {
  20. this.mid = mid;
  21. }
  22. public int getCid() {
  23. return cid;
  24. }
  25. public void setCid(int cid) {
  26. this.cid = cid;
  27. }
  28. }

3.2.2 @ConfigurationProperties + @PropertySource + @Value

  1. @ConfigurationProperties + @PropertySource + @Value适用于读取yml格式配置文件信息.@PropertySource指定配置文件路径和编码格式,@ConfigurationProperties@Value指定配置文件里面的key值.

配置文件

  1. admin:
  2. user:
  3. name: tuacy
  4. age: 25

对应配置文件的读取方式

  1. @Configuration
  2. @PropertySource(value = "classpath:role.yml")
  3. @ConfigurationProperties(prefix = "admin.user")
  4. public class RoleUserInfo {
  5. @Value("${name}")
  6. private String name;
  7. @Value("${age}")
  8. private int age;
  9. public String getName() {
  10. return name;
  11. }
  12. public void setName(String name) {
  13. this.name = name;
  14. }
  15. public int getAge() {
  16. return age;
  17. }
  18. public void setAge(int age) {
  19. this.age = age;
  20. }
  21. }

四 配置文件的加载顺序

  1. 优先级由高到底,高优先级的配置会覆盖低优先级的配置,

全部加载配置文件并互补配置.

4.1 项目内部配置文件加载顺序

  1. SpringBoot配置文件可以放置在多种路径下,不同路径下的配置优先级有所不同。可放置目录(优先级从高到低)
  • 当前项目根目录下的config目录下。
  • 当前项目根目录下。
  • resources目录下的config目录下。
  • resource目录下。

4.2 项目外部配置文件加载顺序

  1. 优先级由高到低.
  • 命令行参数
  • 来自java:comp/env的JNDI属性
  • Java系统属性(System.getProperties())
  • 操作系统环境变量
  • RandomValuePropertySource配置的random.*属性值
  • jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
  • jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
  • jar包外部的application.properties或application.yml(不带spring.profile)配置文件
  • jar包内部的application.properties或application.yml(不带spring.profile)配置文件
  • @Configuration注解类上的@PropertySource
  • 通过SpringApplication.setDefaultProperties指定的默认属性

发表评论

表情:
评论列表 (有 0 条评论,28人围观)

还没有评论,来说两句吧...

相关阅读