当前位置：首页 > news >正文

@ConfigurationProperties加在方法上

news 2025/7/28 9:43:01

@ConfigurationProperties注解通常用于将外部配置文件（如application.properties或application.yml）中的属性映射到Java类中。它通常加在类上，但也可以加在方法上。加在方法上时，通常与@Bean注解一起使用，以便将配置属性注入到Spring容器中的Bean中。

示例：将`@ConfigurationProperties`加在方法上

以下是一个完整的示例，展示如何将@ConfigurationProperties注解加在方法上，并将配置属性注入到Spring容器中的Bean中。

1. 创建配置属性类

首先，创建一个简单的配置属性类，用于映射外部配置文件中的属性。

import org.springframework.boot.context.properties.ConfigurationProperties;@ConfigurationProperties(prefix = "app")
public class AppProperties {private String name;private String version;// Getters and Setterspublic String getName() {return name;}public void setName(String name) {this.name = name;}public String getVersion() {return version;}public void setVersion(String version) {this.version = version;}
}

2. 创建配置类

创建一个配置类，并在方法上使用@ConfigurationProperties注解和@Bean注解。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;@Configuration
@EnableConfigurationProperties
public class AppConfig {@Bean@ConfigurationProperties(prefix = "app")public AppProperties appProperties() {return new AppProperties();}
}

3. 配置文件

在application.properties或application.yml文件中添加配置属性。

application.properties

app.name=MyApp
app.version=1.0.0

application.yml

app:name: MyAppversion: 1.0.0

4. 使用配置属性

在你的应用程序中，你可以通过注入AppProperties来使用这些配置属性。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Service
public class AppService {private final AppProperties appProperties;@Autowiredpublic AppService(AppProperties appProperties) {this.appProperties = appProperties;}public void printAppProperties() {System.out.println("App Name: " + appProperties.getName());System.out.println("App Version: " + appProperties.getVersion());}
}

5. 运行应用

在你的应用程序中调用AppService的printAppProperties方法来打印配置属性。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;@Component
public class AppRunner implements CommandLineRunner {private final AppService appService;@Autowiredpublic AppRunner(AppService appService) {this.appService = appService;}@Overridepublic void run(String... args) throws Exception {appService.printAppProperties();}
}

总结

配置属性类：创建一个简单的类，用于映射外部配置文件中的属性。
配置类：在方法上使用@ConfigurationProperties注解和@Bean注解，将配置属性注入到Spring容器中的Bean中。
配置文件：在application.properties或application.yml文件中添加配置属性。
使用配置属性：通过注入配置属性类来使用这些配置属性。

在Spring框架中，@Autowired 注解通常用于自动注入依赖。虽然它通常用于类的字段或构造函数上，但也可以用于方法参数上。@Autowired 加在形参上的用法也是合法的，并且可以与 @Qualifier 注解一起使用，以指定具体的bean。

以下是一个示例，展示了如何在方法参数上使用 @Autowired 和 @Qualifier 注解：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.kafka.core.KafkaTemplate;
import org.springframework.kafka.core.KafkaProperties;
import org.springframework.stereotype.Service;@Service
public class KafkaService {private final KafkaTemplate<String, String> kafkaTemplate;private final KafkaProperties kafkaProperties;@Autowiredpublic KafkaService(KafkaTemplate<String, String> kafkaTemplate,@Qualifier("kafkaProperties") KafkaProperties kafkaProperties) {this.kafkaTemplate = kafkaTemplate;this.kafkaProperties = kafkaProperties;}// 其他方法
}