问：SpringBoot核心配置文件都有啥，怎么配？

原创已于 2024-11-24 20:03:19 修改 · 1.2k 阅读

20 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #后端 #java

于 2024-11-23 10:46:39 首次发布

掌柜‘面筋’ 专栏收录该内容

119 篇文章

订阅专栏

在这里插入图片描述
在SpringBoot的开发过程中，核心配置文件扮演着至关重要的角色。这些文件用于配置应用程序的各种属性和环境设置，使得开发者能够灵活地定制和管理应用程序的行为。本文将探讨SpringBoot的核心配置文件，包括它们的作用、区别，并通过一些小例子进行说明。

一、核心配置文件的类型

SpringBoot支持两种类型的核心配置文件：application.properties和application.yml（或application.yaml）。尽管这两种文件都可以用来配置应用程序的属性，但它们在语法和风格上有所不同。

1. `application.properties` 文件

application.properties是一种基于键值对的配置文件格式。它使用简单的文本形式，每行一个配置项，格式为key=value。这种格式简单明了，易于理解和编辑。

示例：

# 设置内嵌的Tomcat的端口号
server.port=8080

# 配置项目的上下文根
server.servlet.context-path=/myapp

# 配置数据库连接信息
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=secret

# 设置日志级别
logging.level.org.springframework=DEBUG

2. `application.yml` 文件

application.yml（或application.yaml）采用YAML（YAML Ain’t Markup Language）格式。YAML以其简洁的语法和对层次结构的良好支持而受到青睐。它使用缩进表示层级关系，使得配置文件在表达复杂配置时更加清晰。

示例：

server:
  port: 8080
  servlet:
    context-path: /myapp

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret

logging:
  level:
    org.springframework: DEBUG

二、核心配置文件的作用

核心配置文件在SpringBoot中起着至关重要的作用，它们定义了应用程序的各种属性和行为，包括但不限于以下几个方面：

服务器配置：如端口号、上下文路径等。
数据库配置：如数据库连接URL、用户名、密码等。
日志配置：如日志级别、日志文件路径等。
第三方服务配置：如Redis、RabbitMQ等中间件的连接信息。
自定义配置：开发者可以定义自己的配置属性，并在应用程序中使用。

三、核心配置文件的区别

1. 语法风格

application.properties使用键值对的形式，简单直观，但不适合表达复杂的层次结构。
application.yml使用缩进表示层级关系，适合表达复杂的配置结构，但需要注意缩进的一致性。

2. 可读性和维护性

application.properties由于格式简单，适合快速编辑和查看，但在处理复杂配置时可能显得冗长。
application.yml通过缩进和层级结构使得配置更加清晰，易于阅读和维护，特别是在配置复杂的应用程序时。

3. 数据类型支持

application.properties主要支持简单的键值对，对于列表、映射等复杂数据类型的支持不够直观。
application.yml天然支持列表、映射等复杂数据类型，使得配置更加灵活和强大。

四、基于示例的说明

示例一：服务器和数据库配置

application.properties：

server.port=8080
server.servlet.context-path=/myapp

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=secret

application.yml：

server:
  port: 8080
  servlet:
    context-path: /myapp

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret

在这个示例中，两种配置文件都配置了服务器的端口号和上下文路径，以及数据库的连接信息。可以看出，application.yml通过缩进和层级结构使得配置更加清晰。

示例二：日志配置

application.properties：

logging.level.root=INFO
logging.level.com.example.myapp=DEBUG

application.yml：

logging:
  level:
    root: INFO
    com.example.myapp: DEBUG

在这个示例中，两种配置文件都配置了日志级别。application.yml通过层级结构使得配置更加直观和易于理解。

示例三：自定义配置

假设我们需要配置一个邮件服务的发件人地址和SMTP服务器地址。

application.properties：

mail.from=no-reply@example.com
mail.smtp.host=smtp.example.com

application.yml：

mail:
  from: no-reply@example.com
  smtp:
    host: smtp.example.com

在这个示例中，两种配置文件都配置了邮件服务的自定义属性。application.yml通过缩进和层级结构使得配置更加清晰和易于管理。

五、在应用程序中使用配置文件

在SpringBoot应用程序中，可以使用@Value注解或@ConfigurationProperties注解来读取配置文件中的属性。

1. 使用`@Value`注解

@Value注解用于读取单个配置属性值。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MailService {

    @Value("${mail.from}")
    private String from;

    @Value("${mail.smtp.host}")
    private String smtpHost;

    // 其他方法...
}

2. 使用`@ConfigurationProperties`注解

@ConfigurationProperties注解用于批量读取配置属性值，并将它们绑定到一个Java对象上。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "mail")
public class MailProperties {

    private String from;
    private String smtpHost;

    // getter和setter方法...
}

在SpringBoot应用程序的主类中，需要启用@ConfigurationProperties注解的支持：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
@EnableConfigurationProperties(MailProperties.class)
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

六、总结

SpringBoot的核心配置文件application.properties和application.yml在语法风格、可读性和维护性、数据类型支持等方面存在差异。开发者可以根据项目需求和个人偏好选择合适的配置文件格式。同时，通过@Value注解和@ConfigurationProperties注解，可以方便地在应用程序中使用配置文件中的属性。掌握这些核心配置文件的使用方法和区别，对于提高SpringBoot应用程序的开发效率和可维护性具有重要意义。