idea yml文件没有提示_SpringBoot 配置文件详解（告别XML）

最新推荐文章于 2024-05-10 15:14:49 发布

weixin_39917090

最新推荐文章于 2024-05-10 15:14:49 发布

阅读量370

点赞数

文章标签： idea yml文件没有提示 java读取classpath配置文件如何配置properties

学习目标

快速学会和掌握 SpringBoot 的核心配置文件的使用。

快速查阅

外部配置： Externalized Configuration
默认属性列表：Common Application properties
智能提示：IDEA With Yaml Plugin

学习目录

一、基本介绍
二、快速添加属性
四、快速读取属性(基于注解)
五、默认加载路径
六、使用YAML代替Properties(推荐)
七、命令行参数

一、基本介绍

SpringBoot 提供了丰富的外部配置，常见的有：

核心配置文件
application.properties
application.yml
命令行参数
OS环境变量
Dev属性

其中核心配置文件我们并不陌生，主要以Key-Value的形式进行配置，其中属性Key主要分为两种：

默认属性：根据《默认属性列表》填写，SpringBoot将自动读取配置和进行初始化。
自定义属性：根据需求任意填写，但需要自行读取配置和进行初始化。
如图所示：

二、添加默认属性

在 application.properties 添加配置如下：

① 添加数据源信息

spring.datasource.url=jdbc:oracle:thin:@localhost:1521:XE

spring.datasource.username=admin

spring.datasource.password=admin

spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver

温馨提示：有小伙伴反馈说上面的默认属性容易写错，这里推荐大家使用IDEA开发工具，因为其内置插件可自动提示并识别《默认属性列表》，免除查阅资料的烦恼。PS：初学者可查阅《IntelliJ IDEA 使用教程(2019图文版) -- 从入门到上瘾》快速上手。

三、添加自定义属性

在 application.propertis 添加配置如下：

① 添加认证信息，其中 socks.indentity.* 是自定义的属性前缀。

socks.identity.number=441881199610245710

socks.identity.name=socks

socks.identity.address=beijing load

② 添加随机值，其中spring.test.* 是自定义的属性前缀。

spring.test.my-id1=${random.int}

spring.test.my-id2=${random.int(10)}

spring.test.my-id3=${random.int[10,20]}

spring.test.my-id4=${random.long}

spring.test.my-name= ${random.value}

spring.test.my-uuid=${random.uuid} #生成UUID

注：核心配置文件Properties和Yaml 两者都支持使用属性占位符${param}来填值，例如${random.int}就是在Environment预先定义的属性值，详情可查阅 RandomValuePropertySource。

四、读取属性

1. 使用@ConfigurationProperties 读取多个属性

使用方法：@ConfigurationProperties(prefix = "spring.datasource")

使用说明：提供 Setter方法和标记组件 Component

@Component

@ConfigurationProperties(prefix = "spring.datasource")

public class MyDataSource {

private String url;

private String username;

private String password;

private String driverClassName;

// 提供Setter 和 Getter 方法

}

如何验证是否成功读取配置？答：这里可以简单做个验证，注入MyDataSource，使用Debug模式可以看到如下信息：

读取配置成功

注：嘿嘿，你现在能大概猜到为什么SpringBoot 应用能够根据默认属性来自动配置数据源了吧？因为内置的数据源类DataSourceProperties通过@ConfigurationProperties(prefix = "spring.datasource")读取到了我们在配置文件填写的数据源信息，然后通过DataSourceAutoConfiguration 创建了数据源Bean和进行了相关初始化配置。

2. 使用@Value 读取单个属性

使用方法：@Value("spring.datasource.*")

使用说明：提供 Setter方法和标记组件 Component

@Component

public class MyDataSource {

@Value("spring.datasource.url")

private String url;

@Value("spring.datasource.username")

private String username;

@Value("spring.datasource.password")

private String password;

@Value("spring.datasource.driver-class-name")

private String driverClassName;

// 提供Setter 和 Getter 方法

}

注意事项：@Value不支持注入静态变量，可间接通过Setter注入来实现。

private static String siteUrl;

@Value("${my.url}")

public void setSiteUrl(String myUrl) {

System.out.println(myUrl);

siteUrl = myUrl;

}

3. 关于@ConfigurationProperties和@Value的区别

关于两者的简单功能对比：

显然，前者支持松绑定的特性更强大，所以在实际开发中建议使用@ConfigurationProperties来读取自定义属性。

五、默认加载路径

SpringBoot 默认会加载这些路径加载核心配置文件，按优先级从高到低进行排列：具体规则详见 ConfigFileApplicationListener

工程根目录的config目录：file:./config/
工程根目录：file:./
类路径的config目录：classpath:/config/
类路径：classpath:/ (推荐使用)

如果存在多个配置文件，则严格按照优先级进行覆盖，最高者胜出：

举个简单的例子，例如再上述位置都有一个application.properties ，并且每个文件都写入了server.port=xx (xx分别是9001，9002，9003，9004)，在启动成功之后，最终应用的端口为：9004。图例：

如果想修改默认的加载路径或者调改默认的配置文件名，我们可以借助命令行参数进行指定，例如：

java -jar demo.jar --spring.config.name=app --spring.config.location=classpath:/myconfig/

注：不管 spring.config.location 配置什么值，默认总会按照 classpath:,classpath:/config,file:,file:config/ 的顺序进行搜索，优先级由低到高，也就是 file:config/ 获胜。如果你指定自己的位置，它们会优先于所有的默认位置，并使用相同的由低到高的优先级顺序。详见SpringBoot Custom-Config

六、使用YAML代替Properties

1. 基本介绍

YAML是JSON的一个超集，是一种可轻松定义层次结构的数据格式。

2. 为什么推荐YAML？

答：因为配置文件这东西，结构化越早接触越规范越好。这里推荐阅读阮一峰老师写的YAML语言教程，写的很简单明了。

3. 如何使用YAML

引入依赖：在POM文件引入snakeyaml 的依赖。

注：spring-boot-starter-xxx 会自动引入该依赖。

使用说明：直接在类路径添加application.yml 即可。

4. YAML和Properties的使用对比

例如下面这两段配置是完全等价的：

① 在application.yml 配置数据源:

spring:

datasource:

url: jdbc:oracle:thin:@localhost:1521:XE

username: admin

password: admin

driver-class-name: oracle.jdbc.driver.OracleDriver

② 在application.properties 配置数据源：

spring.datasource.url=jdbc:oracle:thin:@localhost:1521:XE

spring.datasource.username=admin

spring.datasource.password=admin

spring.datasource.driver-class-name=oracle.jdbc.driver.OracleDriver

注：虽然application.yml和application.properties语法上存在差异，但实际效果相同，因为内置的YamlPropertySourceLoader 会将application.yml 的属性通过PropertySource导入到Environment上下文。

5. Yaml支持多环境配置

在项目的实际开发中，我们往往需要根据不同的环境来加载不同的配置文件。例如生产环境，测试环境和开发环境等。此时，我们可以借助Profiles来指定加载哪些配置文件。例如：

application.yml 配置如下：

spring:

profiles:

active: test # 选择加载文件application-{test}.yml

application-prod.yml 配置如下：

server:

port: 9001 #生产环境端口

application-test.yml 配置如下：

server:

port: 8081 #测试环境端口

温馨提示：如果spring.profiles.active指定了多个配置文件，则按顺序加载，其中最后的优先级最高，也就是最后的会覆盖前者。

七、命令行参数

使用方法：

使用Maven插件打包好项目，然后在当前路径，执行DOS命令： java -jar demo.jar --server.port=8081，在控制台可看到应用端口变成了8081。

实现原理：

默认情况下，SpringBoot会将这些命令行参数转化成一个 Property ，并将其添加到Environment上下文。

温馨提示：

由于命令行参数优先级非常之高，基本高于所有常见的外部配置，所以使用的时候要谨慎。详见PropertySource 执行顺序。

关闭方法：

如果想禁用命令行属性，可以设置如下操作：springApplication.setAddCommandLineProperties(false)