SpringBoot读取自定义配置文件方式(properties,yaml)

下面就详细讲解SpringBoot读取自定义配置文件的方式(properties,yaml)的完整攻略。

准备工作

在开始之前，需要先准备好SpringBoot项目并确保已经引入了spring-boot-starter相关依赖（如果是其他版本的依赖包，请自行查看对应的文档）。

读取properties配置文件

步骤

1. 在项目的src/main/resources路径下创建一个自定义的.properties文件，例如myconfig.properties，并在文件中添加自定义的配置信息，如下：

properties
# 数据库连接信息
jdbc.username=root
jdbc.password=123456
jdbc.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai

1. 在SpringBoot的配置文件中进行配置，使其能够读取到自定义的.properties文件。在application.properties中添加如下配置信息：

properties
# 指定要读取的配置文件的位置和名称，可以使用多个
spring.config.location=classpath:myconfig.properties

1. 在代码中使用注解@Value("${配置项名称}")来读取自定义配置文件中的配置信息，如下所示：

```java
@RestController
public class HelloWorldController {

   @Value("${jdbc.username}")
   private String username;

   @Value("${jdbc.password}")
   private String password;

   @Value("${jdbc.url}")
   private String url;

   @GetMapping("/hello")
   public String hello() {
       return "Hello, Spring Boot! My username is " + username + ",password is " + password + ",and url is " + url;
   }

}
```

示例

下面是一个简单的示例，展示如何读取自定义.properties配置文件中的配置信息。

创建配置文件

在项目的src/main/resources路径下创建一个自定义的.properties文件，例如myconfig.properties，添加如下配置信息：

# 数据库连接信息
jdbc.username=root
jdbc.password=123456
jdbc.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai

读取配置文件

在代码中使用注解@Value("${配置项名称}")来读取自定义配置文件中的配置信息，示例如下：

@RestController
public class HelloWorldController {

   @Value("${jdbc.username}")
   private String username;

   @Value("${jdbc.password}")
   private String password;

   @Value("${jdbc.url}")
   private String url;

   @GetMapping("/hello")
   public String hello() {
       return "Hello, Spring Boot! My username is " + username + ",password is " + password + ",and url is " + url;
   }
}

读取yaml配置文件

步骤

1. 在项目的src/main/resources路径下创建一个自定义的.yml或.yaml文件，例如myconfig.yml，并在文件中添加自定义的配置信息，如下：

yaml
# 数据库连接信息
jdbc:
username: root
password: 123456
url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai

1. 在代码中使用注解@ConfigurationProperties(prefix="配置项前缀")来读取自定义配置文件中的配置信息，如下所示：

java
@Data
@Component
@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
private String username;
private String password;
private String url;
}

示例

下面是一个简单的示例，展示如何读取自定义.yaml配置文件中的配置信息。

创建配置文件

在项目的src/main/resources路径下创建一个自定义的.yaml或.yml文件，例如myconfig.yml，添加如下配置信息：

# 数据库连接信息
jdbc:
  username: root
  password: 123456
  url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai

读取配置文件

在代码中使用注解@ConfigurationProperties(prefix="配置项前缀")来读取自定义配置文件中的配置信息，示例如下：

@Data
@Component
@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
   private String username;
   private String password;
   private String url;
}

@RestController
public class HelloWorldController {

   @Autowired
   private JdbcProperties jdbcProperties;

   @GetMapping("/hello")
   public String hello() {
       return "Hello, Spring Boot! My username is " + jdbcProperties.getUsername() + ",password is " + jdbcProperties.getPassword() + ",and url is " + jdbcProperties.getUrl();
   }
}

以上是完整的攻略，希望能够对你有所帮助。