本文介绍了如何在非Spring Boot项目中，将外部jar包中的类与application.properties文件绑定，使得外部类能够读取并使用配置文件中的属性值。通过@ConfigurationPropertiesScan注解，我们可以轻松地实现这一目标，并确保配置类在Spring上下文中可用。
在Spring应用中，我们经常需要从application.properties文件中读取配置信息，并将其绑定到相应的Java类中。对于Spring Boot项目，这通常非常简单，只需使用@ConfigurationProperties注解即可。然而，当我们在非Spring Boot项目中使用外部jar包中的类，并希望将其与application.properties绑定时，就需要一些额外的配置。
使用 @ConfigurationPropertiesScan 注解
@ConfigurationPropertiesScan 注解允许Spring扫描指定包路径下的带有 @ConfigurationProperties 注解的类，并将它们注册为Spring Bean。这使得我们可以将外部jar包中的配置类与application.properties文件绑定。
假设我们有一个外部jar包，其中包含以下类：
// 外部jar包中的类
package com.example.external;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties("test")
public class NetworkConfig {
private String host;
private int port;
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
}
public int getPort() {
return port;
}
public void setPort(int port) {
this.port = port;
}
@Override
public String toString() {
return "NetworkConfig{" +
"host='" + host + '\'' +
", port=" + port +
'}';
}
}该类使用了 @ConfigurationProperties("test") 注解，这意味着它将尝试从application.properties文件中读取以 test 为前缀的属性。
现在，假设我们在一个非Spring Boot项目中使用了这个jar包，并希望将application.properties中的属性绑定到NetworkConfig类。我们需要做以下几步：
- 在Spring配置类中使用 @ConfigurationPropertiesScan 注解：
import com.example.external.NetworkConfig;
import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConfigurationPropertiesScan("com.example.external") // 扫描外部jar包的包路径
public class AppConfig {
// 可选：直接注入 NetworkConfig
@Bean
public String networkConfigInfo(NetworkConfig networkConfig) {
return "NetworkConfig: " + networkConfig.toString();
}
}- 在 application.properties 文件中定义属性：
test.host=localhost test.port=8080
- 运行Spring应用：
当Spring应用启动时，@ConfigurationPropertiesScan 注解会扫描 com.example.external 包，找到 NetworkConfig 类，并将其注册为Spring Bean。同时，它会读取application.properties文件中以 test 为前缀的属性，并将它们绑定到 NetworkConfig 类的相应字段。
注意事项：
- 确保外部jar包中的类使用了 @Component 注解，以便Spring能够将其注册为Bean。
- @ConfigurationPropertiesScan 注解需要指定正确的包路径，以确保Spring能够找到外部jar包中的配置类。
- application.properties 文件必须位于Spring能够找到的位置，例如 src/main/resources 目录下。
- 如果你的项目使用了XML配置，也可以通过
标签来扫描外部jar包的包路径，达到类似的效果。
总结：
通过使用 @ConfigurationPropertiesScan 注解，我们可以轻松地将外部jar包中的类与application.properties文件绑定，使得外部类能够读取并使用配置文件中的属性值。这在开发过程中非常有用，可以提高代码的可维护性和灵活性。 这种方法也适用于在模块化应用中，将配置信息从一个模块传递到另一个模块。
