Spring占位符Placeholder的实现原理解析

在Spring中，占位符（Placeholder）是一个非常实用的功能，它可以在Spring容器启动时通过配置文件或环境变量等方式注入需要的配置值。本文将详细讲解Spring占位符的实现原理。

占位符的使用

在Spring中，占位符有两种使用方式：XML配置方式和注解方式。

XML配置方式

在XML配置文件中使用占位符，需要借助于Spring的PropertyPlaceholderConfigurer类，例如：

<context:property-placeholder location="classpath:config.properties"/>

在上述示例中，我们通过<context:property-placeholder>元素指定了占位符的配置文件，即config.properties。在这个配置文件中，我们可以定义一些占位符，例如：

jdbc.url=@jdbc.url@
jdbc.username=@jdbc.username@
jdbc.password=@jdbc.password@

在上述配置文件中，三个占位符分别代表了数据库连接的URL、用户名和密码。在Spring启动时，会自动将占位符替换成实际的值，例如：

jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=test
jdbc.password=123456

注解方式

在注解方式中，我们可以用@Value注解来指定占位符的值，例如：

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

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

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

在上述示例中，我们通过@Value注解指定了三个占位符的值，分别为${jdbc.url}、${jdbc.username}和${jdbc.password}。在Spring启动时，会自动将这些占位符替换成实际的值。

占位符的实现原理

在Spring中，占位符的实现原理是依赖于一个PropertyResolver接口。

PropertyResolver接口定义了一个resolveRequiredPlaceholders方法，该方法用于解析必需的占位符。

在Spring中，有几个实现了PropertyResolver接口的类，例如：

• StandardEnvironment
• ConfigurableEnvironment
• PropertySourcesPropertyResolver

在这些类中，最常用的是StandardEnvironment类，它包含了一个默认的PropertyResolver实现。

StandardEnvironment类中的resolveRequiredPlaceholders方法会遍历配置文件和环境变量等资源，查找所有可用的占位符，并将其替换成实际的值。

示例说明

示例一：占位符的配置和注入

在这个示例中，我们将演示如何在XML配置文件中用占位符配置数据库连接参数，并在代码中注入这些参数。

假设我们有一个配置文件jdbc.properties，其中定义了数据库连接的URL、用户和密码：

jdbc.url=jdbc:mysql://${jdbc.host}:${jdbc.port}/${jdbc.database}
jdbc.username=${jdbc.username}
jdbc.password=${jdbc.password}

接下来，在我们的Spring配置文件中，我们可以在<bean>元素中使用占位符来注入这些参数，例如：

<bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource">
    <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="${jdbc.url}"/>
    <property name="username" value="${jdbc.username}"/>
    <property name="password" value="${jdbc.password}"/>
</bean>

通过上述配置，我们成功地将占位符的值注入了dataSource对象中。

示例二：占位符的注入和使用

在这个示例中，我们将演示如何使用注解方式来注入和使用占位符。

首先，我们在Spring配置类中定义一个Bean，这个Bean需要用到一些占位符定义的配置参数：

@Component
public class AppConfig {

    @Value("${app.name}")
    private String appName;

    @Value("${app.version}")
    private String appVersion;

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

    // ...
}

在上述示例中，我们通过@Value注解来注入占位符定义的配置参数。

接着，我们可以在我们的代码中使用这些参数，例如：

@Component
public class AppRunner implements CommandLineRunner {

    private final AppConfig appConfig;

    public AppRunner(AppConfig appConfig) {
        this.appConfig = appConfig;
    }

    @Override
    public void run(String... args) throws Exception {
        System.out.println("Application name: " + appConfig.getAppName());
        System.out.println("Application version: " + appConfig.getAppVersion());
        System.out.println("Server port: " + appConfig.getServerPort());
    }
}

在上述代码中，我们通过AppConfig的getAppName、getAppVersion和getServerPort方法来获取占位符的值，并进行使用。