Java配置管理：Spring Boot整合yaml配置文件示例

原创曾经终败给现在 2024-11-12 11:48 14阅读 0赞

在Spring Boot中，使用YAML配置文件是一种常见的做法，因为它提供了一种简洁、易于阅读的配置格式。以下是如何在Spring Boot项目中整合YAML配置文件的示例。

###1.引入依赖首先，确保你的`pom.xml`（如果是Maven项目）或`build.gradle`（如果是Gradle项目）中包含了Spring Boot的起步依赖，它默认包含了对YAML的支持。

对于Maven，添加如下依赖：

```xml<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
```对于Gradle，添加如下依赖：

```gradleimplementation 'org.springframework.boot:spring-boot-starter'
```###2. 创建YAML配置文件在`src/main/resources`目录下创建`application.yml`文件（或者`application.yaml`，两者都可以）。

```yamlserver:
port:8080spring:
 datasource:
url: jdbc:mysql://localhost:3306/mydbusername: user password: pass driver-class-name: com.mysql.cj.jdbc.Drivermy:
 custom:
 setting: true```###3.访问配置你可以使用`@Value`注解或者创建配置类来访问YAML文件中的配置。

#### 使用`@Value`注解```javaimport org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Componentpublic class MyComponent {

@Value("${server.port}")
 private int serverPort;

@Value("${my.custom.setting}")
 private boolean customSetting;

// Getters and setters}
```#### 创建配置类```javaimport org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component@ConfigurationProperties(prefix = "my")
public class MyProperties {

private Custom custom;

// Getters and setters public static class Custom {
 private boolean setting;

// Getters and setters }
}
```然后在你的组件中注入这个配置类：

```javaimport org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Componentpublic class MyComponent {

private final MyProperties myProperties;

@Autowired public MyComponent(MyProperties myProperties) {
 this.myProperties = myProperties;
 }

public boolean isCustomSettingEnabled() {
 return myProperties.getCustom().isSetting();
 }
}
```###4.运行和测试启动你的Spring Boot应用，Spring Boot会自动加载`application.yml`或`application.yaml`文件中的配置，并根据配置创建相应的Bean。

这就是在Spring Boot中整合YAML配置文件的基本步骤。你可以根据需要添加更多的配置项，并使用上述方法来访问它们。