Spring 配置文件 XML 教程

最后修改于 2023 年 10 月 18 日

Spring 配置文件 XML 教程展示了如何在 Spring 应用程序的 XML 中配置配置文件。

Spring 是一个流行的 Java 应用程序框架，用于创建企业级应用程序。

Spring 配置文件

配置文件是为特定环境（如开发或生产）声明的已命名 bean 集合。配置文件可以在 XML 中配置，也可以使用注解配置。

Spring 配置文件示例

该应用程序定义了两个配置文件：生产和开发。

pom.xml
src
├───main
│   ├───java
│   │   └───com
│   │       └───zetcode
│   │               Application.java
│   └───resources
│           database-dev.properties
│           database-prod.properties
│           logback.xml
└───test
    └───java

这是项目结构。我们有两个属性文件：database-dev.properties 和 database-prod.properties。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
            http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.zetcode</groupId>
    <artifactId>profileex</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <spring-version>5.3.23</spring-version>

    </properties>

    <dependencies>

        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.4.0</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring-version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring-version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring-version}</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <mainClass>com.zetcode.Application</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

在 pom.xml 文件中，我们具有基本的 Spring 依赖 spring-core、spring-context、spring-jdbc，以及日志 logback-classic 依赖。

exec-maven-plugin 用于从 Maven 命令行执行 Spring 应用程序。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <logger name="org.springframework" level="ERROR"/>
    <logger name="com.zetcode" level="INFO"/>

    <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <Pattern>%d{HH:mm:ss.SSS} %blue(%-5level) %magenta(%logger{36}) - %msg %n
            </Pattern>
        </encoder>
    </appender>

    <root>
        <level value="INFO" />
        <appender-ref ref="consoleAppender" />
    </root>
</configuration>

logback.xml 是 Logback 日志库的配置文件。

db.url=jdbc:h2:mem:testdb
db.username=testuser
db.password=s$cret

这是开发属性。

db.url=jdbc:postgresql:///mydb
db.username=user7
db.password=s$cret

这是生产属性。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd">

    <context:property-placeholder location="classpath:database-${spring.profiles.active}.properties"/>

    <bean id="dataSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSource">
        <property name="url" value="${db.url}"/>
        <property name="username" value="${db.username}"/>
        <property name="password" value="${db.password}"/>
    </bean>

</beans>

my-beans.xml 包含一个 dataSource bean。<context:property-placeholder> 标签根据活动的 Spring 配置文件配置数据源的属性。

package com.zetcode;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.support.GenericXmlApplicationContext;
import org.springframework.jdbc.datasource.SimpleDriverDataSource;

public class Application {

    private static final Logger logger = LoggerFactory.getLogger(Application.class);

    public static void main(String[] args) {

        System.setProperty("spring.profiles.active", "prod");

        var ctx = new GenericXmlApplicationContext("my-beans.xml");

        var dataSource = (SimpleDriverDataSource) ctx.getBean("dataSource");

        logger.info("Url: {}", dataSource.getUrl());
        logger.info("User name: {}", dataSource.getUsername());
        logger.info("Password: {}", dataSource.getPassword());

        ctx.close();
    }
}

该应用程序检索 dataSource bean 并打印其属性。活动属性使用 System.setProperty 方法设置。或者，我们可以将该属性设置为 VM 变量 -Dspring.profiles.active=prod 或在 IDE 设置中进行设置。

$ mvn -q -Dspring.profiles.active=dev exec:java
20:30:45.832 INFO  com.zetcode.Application - Url: jdbc:h2:mem:testdb
20:30:45.832 INFO  com.zetcode.Application - User name: testuser
20:30:45.832 INFO  com.zetcode.Application - Password: s$cret

我们通过命令行设置的配置文件来运行应用程序

在本文中，我们为 Spring 应用程序创建了开发和生产配置文件。

我叫 Jan Bodnar，我是一名充满激情的程序员，拥有丰富的编程经验。我从 2007 年开始撰写编程文章。迄今为止，我已撰写了 1,400 多篇文章和 8 本电子书。我在编程教学方面拥有十多年的经验。

列出 所有 Spring 教程。