Spring配置文件全解析：从零开始掌握yml、yaml、xml和properties

最新推荐文章于 2025-04-19 00:15:00 发布

Leaton Lee

最新推荐文章于 2025-04-19 00:15:00 发布

阅读量1.5k

点赞数 16

文章标签： spring xml java

本文链接：https://blog.csdn.net/2301_78858041/article/details/145883429

版权

引言

在Spring框架中，配置文件是应用的核心组成部分。无论是简单的Web应用还是复杂的微服务架构，配置文件都扮演着至关重要的角色。它们决定了应用的行为、连接的数据库、第三方服务的集成以及其他关键设置。

作为一名刚接触Spring的新手，你可能会被各种配置文件类型（如application.properties 、application.yml 、XML等）搞得一头雾水。别担心！本文将为你详细解析Spring中常用的配置文件类型、它们的使用场景以及如何在项目中共存和加载。

第一部分：什么是Spring配置文件？

在Spring应用中，配置文件的作用类似于“说明书”，告诉应用如何运行。通过配置文件，我们可以：

设置数据库连接参数。
配置第三方服务（如Redis、Kafka）。
定义Bean的属性。
配置日志级别。
等等。

Spring支持多种配置文件格式，每种都有其独特的优点和适用场景。

第二部分：Spring支持的主流配置文件类型

1. Properties文件

Properties文件是最经典的Spring配置文件格式。它的特点是简单易懂，适合配置少量的键值对。

示例：application.properties

# 数据库配置 
spring.datasource.url=jdbc:mysql://localhost:3306/test  
spring.datasource.username=root  
spring.datasource.password=123456  
 
# 应用信息 
app.name=My  Spring App 
app.version=1.0.0

优点

简单直观。
文件扩展名为.properties。

缺点

不支持复杂的嵌套结构。
书写格式较为僵硬。

2. YAML/YML文件

YAML是一种轻量级的数据序列化语言，广泛应用于Spring Boot项目中。它的语法简洁，支持嵌套结构，非常适合复杂的配置场景。

示例：application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test 
    username: root 
    password: 123456 
 
app:
  name: My Spring App 
  version: 1.0.0 
 
# 配置列表 
servers:
  - name: server1 
    port: 8080 
  - name: server2 
    port: 8081

优点

支持嵌套结构。
语法简洁，可读性强。
文件扩展名为.yml或.yaml。

缺点

对新手来说，语法可能稍显陌生（如缩进和冒号的使用）。

3. XML配置文件

XML是Spring早期的主要配置方式。虽然现在YAML和Properties更受欢迎，但XML仍然在某些企业级应用中被广泛使用。

示例：application.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xsi:schemaLocation="http://www.springframework.org/schema/beans  
                           http://www.springframework.org/schema/beans/spring-beans.xsd"> 
 
    <!-- 数据源配置 -->
    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"> 
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/> 
        <property name="url" value="jdbc:mysql://localhost:3306/test"/>
        <property name="username" value="root"/>
        <property name="password" value="123456"/>
    </bean>
 
</beans>

优点

适用于复杂的依赖注入场景。
适合需要严格Schema验证的项目。

缺点

书写繁琐。
对新手不太友好。

4. 其他配置文件类型

除了上述三种主流格式，Spring还支持以下配置文件类型：

JSON：通过第三方库（如spring-boot-properties-migrator）可以使用JSON格式的配置文件。
Command Line Arguments：通过命令行参数动态覆盖配置文件中的值。
Environment Variables：通过环境变量覆盖配置文件中的值。

第三部分：配置文件的加载顺序

当项目中同时存在多种配置文件时，Spring会按照一定的优先级加载它们。了解这一点非常重要，因为它决定了最终生效的配置。

默认加载顺序

Command Line Arguments（命令行参数）：最高优先级。
Environment Variables（环境变量）。
application.properties 。
application.yml 。
application.xml 。
Other Profile-Specific Files（特定环境的配置文件）。

示例

假设我们有以下配置：

application.properties ：server.port=8080
application.yml ：server.port=8081
命令行参数：--server.port=8082

最终生效的端口号将是8082，因为命令行参数的优先级最高。

第四部分：如何在项目中使用多种配置文件？

步骤1：添加依赖

如果你使用的是Spring Boot，默认已经支持Properties和YAML格式的配置文件。如果需要使用XML格式，则需要确保项目中包含相关的依赖。

<!-- 在pom.xml 中添加对Spring XML的支持 -->
<dependency>
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

步骤2：创建配置文件

在src/main/resources目录下创建以下文件：

application.properties
application.yml
config.xml

步骤3：在代码中引用配置

Properties配置

@Configuration 
public class AppConfig {
 
    @Value("${app.name}") 
    private String appName;
 
    @Bean 
    public String getAppName() {
        return appName;
    }
}

YAML配置

@Configuration 
public class AppConfig {
 
    @Value("${app.name}") 
    private String appName;
 
    @Bean 
    public String getAppName() {
        return appName;
    }
}

XML配置

<!-- 在application.xml 中定义Bean -->
<bean id="appName" class="java.lang.String"> 
    <value>${app.name}</value> 
</bean>

第五部分：案例实战——整合多种配置文件

案例背景

假设我们需要开发一个简单的Spring Boot应用，要求：

使用YAML配置数据库连接。
使用Properties文件配置应用信息。
使用XML文件定义一个自定义Bean。

具体实现

1. 创建项目结构

my-spring-app/
├── src/
│   └── main/
│       ├── java/
│       │   └── com/
│       │       └── example/
│       │           └── myapp/
│       │               ├── AppConfig.java  
│       │               └── MainApplication.java  
│       └── resources/
│           ├── application.properties  
│           ├── application.yml  
│           └── config.xml

2. 配置文件内容

`application.properties`

app.name=My  Spring App 
app.version=1.0.0

`application.yml`

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test 
    username: root 
    password: 123456

`config.xml`

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xsi:schemaLocation="http://www.springframework.org/schema/beans  
                           http://www.springframework.org/schema/beans/spring-beans.xsd"> 
 
    <bean id="customBean" class="java.lang.String"> 
        <value>Custom Bean from XML</value>
    </bean>
 
</beans>

3. 引用配置

`AppConfig.java`

import org.springframework.beans.factory.annotation.Value; 
import org.springframework.context.annotation.Bean; 
import org.springframework.context.annotation.Configuration; 
 
@Configuration 
public class AppConfig {
 
    @Value("${app.name}") 
    private String appName;
 
    @Value("${spring.datasource.url}") 
    private String dbUrl;
 
    @Bean 
    public String getAppName() {
        return appName;
    }
 
    @Bean 
    public String getDbUrl() {
        return dbUrl;
    }
}

`MainApplication.java`

import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
import org.springframework.context.ApplicationContext; 
 
@SpringBootApplication 
public class MainApplication {
 
    public static void main(String[] args) {
        ApplicationContext context = SpringApplication.run(MainApplication.class,  args);
 
        // 获取配置值 
        String appName = context.getBean("appName",  String.class); 
        String dbUrl = context.getBean("dbUrl",  String.class); 
        String customBean = context.getBean("customBean",  String.class); 
 
        System.out.println("App  Name: " + appName);
        System.out.println("DB  URL: " + dbUrl);
        System.out.println("Custom  Bean: " + customBean);
    }
}

4. 运行结果

运行程序后，控制台输出如下：

App Name: My Spring App 
DB URL: jdbc:mysql://localhost:3306/test 
Custom Bean: Custom Bean from XML

第六部分：总结与展望

通过本文的学习，你应该已经掌握了Spring中常用的配置文件类型及其使用场景。从简单的Properties到强大的YAML，再到灵活的XML，每种配置文件都有其独特的优势。在实际开发中，可以根据项目的复杂性和需求选择合适的配置方式。

互动环节：你遇到过哪些配置文件相关的问题？

在评论区留言告诉我们：

你在使用Spring配置文件时遇到过哪些问题？
你更喜欢使用哪种配置文件格式？为什么？
你对Spring配置文件还有哪些疑问？

我会定期查看并回复大家的问题！😊

希望这篇文章能够帮助你更好地理解和掌握Spring配置文件的使用！如果你觉得这篇文章对你有帮助，请记得点赞和分享给更多的小伙伴哦！ 😊