@ConfigurationProperties

时间: 2023-08-25 21:12:20 浏览: 36

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的一个强大特性，它使得从配置文件中加载和管理属性变得更加简单和直观。通过合理地设计配置类，可以轻松地处理复杂的配置结构，提高代码的可读性和维护性。

@ConfigurationProperties 是一个注解，它可以用于将配置文件中的属性值映射到 Java 对象的属性上。通过在 Java 类上添加该注解，并指定前缀，可以将配置文件中以该前缀开头的属性值映射到该类的属性上。该注解通常与 @EnableConfigurationProperties 注解一起使用，以启用对配置属性的自动绑定。这样，我们就可以方便地在 Spring Boot 应用中读取配置文件中的属性值，并将其应用于应用程序中的各个组件。

阅读全文

@ConfigurationProperties

相关推荐

Spring Boot2.0 @ConfigurationProperties使用详解

config.properties

@configurationproperties

@ConfigurationProperties@ConfigurationProperties

@ConfigurationProperties @Configuration

@Value@ConfigurationProperties

@Configuration @ConfigurationProperties

@EnableConfigurationProperties @ConfigurationProperties

@configurationproperties无效

@configurationproperties使用

@ConfigurationProperties作用

关于@ConfigurationProperties

SpringBoot @ConfigurationProperties使用详解（源代码）

@ConfigurationProperties注解使用方法（源代码）

【大厂面试专栏】一份Java程序员需要的技术指南，这里有面试题、系统架构

flashocc-QAT-PTQ.zip

大连理工大学城市学院在四川2020-2024各专业最低录取分数及位次表.pdf

川北医学院在四川2020-2024各专业最低录取分数及位次表.pdf

最新推荐

【大厂面试专栏】一份Java程序员需要的技术指南，这里有面试题、系统架构

flashocc-QAT-PTQ.zip

大连理工大学城市学院在四川2020-2024各专业最低录取分数及位次表.pdf

川北医学院在四川2020-2024各专业最低录取分数及位次表.pdf

SSM动力电池数据管理系统源码及数据库详解

管理建模和仿真的文件

MapReduce分区机制揭秘：作业效率提升的关键所在

在电子商务平台上，如何通过CRM系统优化客户信息管理和行为分析？请结合DELL的CRM策略给出建议。

R语言桑基图绘制与SCI图输入文件代码分析

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