@Configuration @ConfigurationProperties

时间: 2023-10-18 10:25:33 浏览: 104

SpringBoot @ConfigurationProperties使用详解

主要介绍了SpringBoot @ConfigurationProperties使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧【SpringBoot @ConfigurationProperties 使用详解】在Spring Boot中，`@ConfigurationProperties`是用于将配置文件中的属性绑定到Java Bean的注解，极大地简化了属性的管理，使得配置更加灵活和类型安全。以下是对`@ConfigurationProperties`的详细解析。 **1. 添加依赖** 在开始使用`@ConfigurationProperties`之前，确保引入了Spring Boot的父依赖，如在`pom.xml`中添加以下内容： ```xml <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <relativePath/>  </parent> ``` 这将确保你具备了Spring Boot的基础环境。 **2. 创建配置类** 配置类通常会包含一组属性，这些属性对应于配置文件中的键值对。例如，创建一个名为`ConfigProperties`的类，用来绑定`mail`前缀的属性： ```java @Data @Configuration @ConfigurationProperties(prefix = "mail") public class ConfigProperties { private String hostName; private int port; private String from; } ``` 这里的`@Data`来自Lombok库，用于自动生成getter、setter等方法，方便属性的访问。`prefix`参数指定了配置文件中属性的前缀。 **3. 属性匹配** 在`application.properties`或`application.yml`中，可以定义与`ConfigProperties`类中字段对应的属性： ```properties mail.hostname=host@mail.com mail.port=9000 mail.from=mailer@mail.com ``` Spring Boot会自动将这些属性值赋给`ConfigProperties`类的相应字段。 **4. 手动启用配置** 如果不想在配置类上使用`@Configuration`，可以通过`@EnableConfigurationProperties`来启用配置： ```java @SpringBootApplication @EnableConfigurationProperties(ConfigProperties.class) public class ConfigPropApp { public static void main(String[] args) { SpringApplication.run(ConfigPropApp.class, args); } } ``` **5. 自定义扫描路径** 使用`@ConfigurationPropertiesScan`可以指定扫描配置类的包路径： ```java @SpringBootApplication @ConfigurationPropertiesScan("com.flydean.config") public class ConfigPropApp { public static void main(String[] args) { SpringApplication.run(ConfigPropApp.class, args); } } ``` 这样，Spring Boot只会在这个包及其子包下查找配置类。 **6. 属性嵌套** `@ConfigurationProperties`支持属性的嵌套，可以绑定复杂的数据结构。例如，创建一个`Credentials`类： ```java @Data public class Credentials { private String authMethod; private String username; private String password; } ``` 然后在`NestConfigProperties`类中嵌套使用： ```java @Data @Configuration @ConfigurationProperties(prefix = "nestmail") public class NestConfigProperties { private String host; private int port; private String from; private List<String> defaultRecipients; private Map<String, String> additionalHeaders; private Credentials credentials; } ``` 对应的配置文件如下： ```properties nestmail.hostname=mailer@mail.com nestmail.port=9000 nestmail.from=nest@example.com nestmail.default-recipients=user1@example.com,user2@example.com nestmail.additional-headers.header1=value1 nestmail.additional-headers.header2=value2 nestmail.credentials.auth-method=basic nestmail.credentials.username=admin nestmail.credentials.password=password ``` 如此，`NestConfigProperties`将自动填充嵌套的属性和列表、映射类型的值。 `@ConfigurationProperties`是Spring Boot的一个强大特性，它使得从配置文件中加载和管理属性变得更加简单和直观。通过合理地设计配置类，可以轻松地处理复杂的配置结构，提高代码的可读性和维护性。

@Configuration和@ConfigurationProperties是Spring框架中用于配置和管理属性的注解。 @Configuration注解标识一个类为配置类，表示该类中定义了一些配置信息。使用@Configuration注解可以告诉Spring容器该类是一个配置类，Spring容器会扫描该类并加载其中的配置信息。 @ConfigurationProperties注解则用于将外部配置文件中的属性值注入到配置类中的属性中。通过在配置类的属性上添加@ConfigurationProperties注解，并指定属性的前缀，可以将外部配置文件中以指定前缀开头的属性值注入到该属性中。通过使用@Configuration和@ConfigurationProperties注解，可以方便地将外部配置文件中的属性值注入到配置类中，实现属性的统一管理和配置。例如，在编写一个配置类来扫描数据库配置信息时，可以使用@Configuration和@ConfigurationProperties注解来实现。首先，使用@Configuration注解标识该类为配置类，然后在属性上使用@ConfigurationProperties注解，并指定属性的前缀为数据库配置的前缀，这样就可以将外部配置文件中的数据库配置信息注入到该属性中。总结起来，@Configuration和@ConfigurationProperties是Spring框架中用于配置和管理属性的注解。@Configuration用于标识一个类为配置类，而@ConfigurationProperties用于将外部配置文件中的属性值注入到配置类的属性中。通过使用这两个注解，可以方便地实现属性的统一管理和配置。123 #### 引用[.reference_title] - *1* [@Configuration、@ConfigurationProperties用法](https://blog.csdn.net/qq_45545968/article/details/110355408)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* *3* [使用@Configuration扫描配置文件（@Configuration、@ConfigurationProperties和@PropertySource组合使用）](https://blog.csdn.net/qq_48033003/article/details/119494732)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

阅读全文

@Configuration @ConfigurationProperties

相关推荐

@ConfigurationProperties绑定配置信息至Array、List、Map、Bean的实现

Spring Boot2.0 @ConfigurationProperties使用详解

@ConfigurationProperties @Configuration

@ConfigurationProperties和@Configuration

@Setter@Configuration@ConfigurationProperties(prefix = "elasticsearch")

@Configuration和@ConfigurationProperties的区别

@ConfigurationProperties 和 @Configuration 的区别

@ConfigurationProperties@ConfigurationProperties

@Configuration @ConfigurationProperties(prefix = "mes.system.erpapi")这两个注解的作用

@Configuration@Component@Data @ConfigurationProperties等相关idea注解作用

springboot1.5.15.RELEASE中，@Configuration类中@ConfigurationProperties无法获取到配置

Data @Configuration @ConfigurationProperties(prefix = "ignored") public class IgnoredUrlsProperties { private List<String> urls = new ArrayList<>(); }，解释这个代码

@ConfigurationProperties使用

@configurationproperties多层次

@ConfigurationProperties用法

@EnableConfigurationProperties @ConfigurationProperties

@ConfigurationProperties依赖

springBoot使用@ConfigurationProperties

static 读取 @ConfigurationProperties

最新推荐

使用 Simulink(R) 在 AWGN 信道上执行带穿孔的软判决维特比解码.rar

火炬连体网络在MNIST的2D嵌入实现示例

管理建模和仿真的文件

L2正则化的终极指南：从入门到精通，揭秘机器学习中的性能优化技巧

如何构建一个符合GB/T19716和ISO/IEC13335标准的信息安全事件管理框架，并确保业务连续性规划的有效性？

Angular插件增强Application Insights JavaScript SDK功能

"互动学习：行动中的多样性与论文攻读经历"

L1正则化模型诊断指南：如何检查模型假设与识别异常值（诊断流程+案例研究）

如何构建一个符合GB/T19716和ISO/IEC13335标准的信息安全事件管理框架，并确保业务连续性规划的有效性？

实时三维重建：InfiniTAM的ros驱动应用