@ConfigurationProperties基本使用

最新推荐文章于 2025-10-08 16:06:59 发布
原创 最新推荐文章于 2025-10-08 16:06:59 发布 · 175 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #前端 #spring

文章介绍了在Spring框架中，如何使用@Component注解将类定义为bean，并通过@ConfigurationProperties(prefix=user1)注解来绑定配置文件中的属性，实现bean实例的属性自动初始化。示例中展示了当配置文件user1.name=Tom时，User类的name属性会被设置为Tom。

有三种方式

1.1基本使用方式

// 将类定义为一个bean的注解，比如 @Component,@Service,@Controller,@Repository
// 或者 @Configuration
@Component
// 表示使用配置文件中前缀为user1的属性的值初始化该bean定义产生的的bean实例的同名属性
// 在使用时这个定义产生的bean时，其属性name会是Tom
@ConfigurationProperties(prefix = "user1")
public class User {
	private String name;
	// 省略getter/setter方法
}

对应application.properties配置文件内容如下：

user1.name=Tom

@ConfigurationProperties的使用方式
骑个小蜗牛的博客
11-19 9707
@ConfigurationProperties使用方式 1. @ConfigurationProperties + @Component 2. @ConfigurationProperties + @Bean 3. @ConfigurationProperties + @EnableConfigurationProperties
SpringBoot中@ConfigurationProperties注解的常见使用（学习笔记）
向心行者
12-07 3862
  @ConfigurationProperties是springboot提供读取配置文件的一个注解。其对应的bean的后置处理器为 ConfigurationPropertiesBindingPostProcessor类，它是实现了BeanPostProcessor接口，在bean被实例化后，会调用后置处理，递归的查找属性，通过反射注入值，对大多数属性而言强制需提供其setter和getter方法。  @ConfigurationProperties注解加载配置文件三种常见的用法，如下：  这里需要注意的
@ConfigurationProperties 的基本用法
wddblog的博客
03-13 2579
在注解中，你可以通过prefix属性指定配置属性的前缀。这样，Spring Boot 就会自动匹配该前缀下的所有属性，并将它们绑定到对应的字段上。同时，你也可以通过其他方式（如）指定配置文件的位置。有时，配置文件中的属性名可能与 JavaBean 的字段名不完全匹配，或者你可能需要应用一些自定义的转换逻辑。在这种情况下，你可以使用注解或自定义的Converter类来定义自己的属性绑定规则。
@ConfigurationProperties注解使用
学习不止境的博客
07-13 1325
业务场景是这样的，在项目中最近涉及到一个某个内容剩余量预警的需求，当余量低于某个值，就发送短信给相关人。 而关于接收短信的相关人员是写在配置文件中，需要通过代码去获取。 但是虽然我们只需要用到接受短信相关人员这个配置，但是配置文件中相关人员的配置有个前缀warning,格式为warning.xxxx.且不仅仅有相关人员这一个配置，而是多个带有以warning为前缀的配置。 当时第一时间想到的当然是@Value,但是通过看前辈的代码，发现它专门写了一个类，并且用上了@ConfigurationProperti
@ConfigurationProperties的三种使用方式
我叫晨曦啊的博客
01-04 3189
@ConfigurationProperties的三种使用方式
Spring Boot技术知识点：如何理解@ConfigurationProperties注解
06-20
2. **基本使用** - 创建一个Java类，例如`AppConfig`，并在类上添加`@ConfigurationProperties`注解，指定前缀（通常与配置文件中的key相对应）。 ``` @ConfigurationProperties(prefix = "app") public class ...
深入解析Spring Boot中的@ConfigurationProperties注解
web15185420056的博客
12-06 1848
是Spring Boot提供的一个注解，用于将外部配置属性绑定到Java对象上。通过使用这个注解，开发者可以将配置文件（如或）中的属性值自动映射到Java类的字段上，从而实现配置的集中管理和类型安全。首先，定义一个Java类，用于绑定配置属性。使用注解标记该类，并指定前缀（prefix）。@Component：指定配置属性的前缀为app。@Component：将该类注册为Spring Bean，使其可以被Spring容器管理。
@ConfigurationProperties 注解完全指南-从入门到精通 Spring 配置属性绑定
最新发布
2401_89221704的博客
10-08 697
是 Spring Boot 配置属性绑定的核心注解。通过prefix参数实现类型安全的配置管理，告别硬编码，拥抱灵活配置！🚀// Getter 和 Setter public CustomEnum getStatus() { return status;
@ConfigurationProperties无效果
m0_62645012的博客
10-29 5681
通过@EnableConfigurationProperties对User进行实例化时，便会使用到@ConfigurationProperties的功能，对属性进行匹配赋值。
@ConfigurationProperties和@Value的区别
爪哇人的博客
06-30 7087
目录1 前言2 @ConfigurationProperties和@value的区别3 用法3.1 @ConfigurationProperties3.2 @Value 4 指定配置文件在平时开发中，我们会将大量的参数配置在application.properties或者application.yml文件中，通过@ConfigurationProperties注解或者@value注解可以很方便的拿到这些值。两种注解斗能够读取配置文件中属性并绑定到javaBean中，但两种存在以下不同1）使用位置不同@Con
@ConfigurationProperties使用方法
lafsca5的博客
02-20 2971
@ConfigurationProperties功能类似于@Value 都可以用来获取配置文件中的数据 @ConfigurationProperties 只需要在实体类上添加一个注解，通过属性名和配置文件的中的名字对照（实体类的属性名和配置文件中的名称要相同，若配置文件中是card-id形式写法，在实体类的就需要写成驼峰形式，否则会获取不到），进行绑定。 # 配置文件 spring: redis: # redis服务器地址 host: 127.0.0.1 # 端口 por
@ConfigurationProperties的两种使用方式
骑个小蜗牛的博客
12-04 1588
可以在 @Bean 注解的方法上使用 @ConfigurationProperties 注解，将外部属性值绑定到该方法返回的对象中。这种方式适用于需要创建一个实例，并将属性值注入到该实例中的场景。将 @ConfigurationProperties 注解直接应用在配置类上，将属性值绑定到该类的属性中。这种方式适用于需要将外部属性值直接注入到整个配置类中的场景。@ConfigurationProperties 注解有两种使用方式：绑定到方法和绑定到类。
@ConfigurationProperties的使用
yygr的博客
04-12 990
https://blog.youkuaiyun.com/lucky_ly/article/details/90049513 @ConfigurationProperties简介 @ConfigurationProperties是springboot提供读取配置文件的一个注解。其对应的bean的后置处理器为ConfigurationPropertiesBindingPostProcessor 它是实现了BeanPostProcessor接口，在bean被实例化后，会调用后置处理，递归的查找属性，通过反射注入值，对
@ConfigurationProperties 使用
fyinthesky的专栏
05-23 2366
@ConfigurationProperties 使用 背景，可以把属性文件读到bean里方便使用。 【1】 pom.xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-...
Spring框架中@ConfigurationProperties注解如何使用
xuTao667的博客
10-15 603
通过本案例，展示了如何使用注解来将外部配置中的属性映射到一个 Java 对象。这种方式不仅清晰易懂，而且便于维护和扩展，是管理复杂配置的推荐做法。
@ConfigurationProperties注解使用方法（内含源代码）
weixin_46411355的博客
01-28 844
@ConfigurationProperties注解使用方法 前言 一、Spring配置方式 1.1 第一阶段：xml配置 1.2 第二阶段：注解配置 1.3 第三阶段：Java配置(java config) 二、@ConfigurationProperties使用方法 三、使用场景 3.1 作用于方法 3.1.1 使用场景（`配置读写分离`） 3.1.2 读写分离 案例实操 3.1.2.1 数据库的创建 3.1.2.2创建并搭建项目 3.1.2.3 添加依赖 druid启动器的依赖
@ConfigurationProperties注解的使用
2403_88969259的博客
01-03 583
ConfigurationProperties注解，此注解的作用是用来为bean绑定属性的。开发者可以在yml配置文件中以对象的格式添加若干属性。@Value 注解通常用于外部配置的属性注入，具体用法为： @Value("${配置文件中的key}")@ConfigurationProperties可以批量的将外部的属性配置注入到bean对象的属性中。使用@ConfigurationProperties注解就可以将配置中的属性值关联到开发的模型类上。@Value注解只能一个一个的进行外部属性的注入。
Spring @ConfigurationProperties 典型用法
张紫娃的博客
03-20 851
1、该注解有一个 prefix属性，根据指定的前缀来绑定配置文件中的配置和 @value有着相同的功能，@ConfigurationProperties其实就类似于使用多个 @Value同时绑定，绑定的是对象；修饰的POJO类的命名比较严格，必须和 prefix的后缀名一致, 不然值会绑定不上。但是配置文件里蛇形命名变量 “driver-class-name”和 POJO里面转驼峰命名属性 “driverClassName”可以绑定成功。
@/ConfigurationProperties详解
Gemini1995的博客
10-08 2814
提供了灵活、易用的方式来将配置文件中的内容映射到 Java 类中。它支持复杂的嵌套结构、列表、Map 类型，并且可以结合JSR-303校验注解进行数据验证。适用于处理复杂配置场景，并提高配置管理的安全性和可维护性。
@ConfigurationProperties作用对象
10-03
<think>首先，用户的问题是：“我想了解@ConfigurationProperties注解的作用对象 请问@ConfigurationProperties注解的作用对象”。这翻译成英文是：“I want to know the target objects of the @ConfigurationProperties annotation. What are the target objects of the @ConfigurationProperties annotation?” 现在，我需要参考提供的站内引用来回答这个问题。引用来自不同的来源： - 引用[1]：解释了@ConfigurationProperties注解用于将Spring容器中的Bean与配置文件中的属性绑定。 - 引用[2]：深入解析了@ConfigurationProperties注解，提到它用于处理外部配置。 - 引用[3]：详细描述了@ConfigurationProperties注解的用法，包括如何定义配置类和字段绑定。 - 引用[4]：展示了@ConfigurationProperties注解的使用方式，包括在类上和方法上使用。 关键是从这些引用中提取关于@ConfigurationProperties注解的作用对象的信息。作用对象指的是这个注解可以应用在哪些元素上，比如类、方法等。 回顾引用： - 引用[1]说：“将标注了@ConfigurationProperties注解的Spring容器中的Bean与配置文件中的属性进行一一绑定”。这表明注解可以应用到Spring容器中的Bean上。 - 引用[2]：没有直接指定作用对象，但讨论了配置绑定。 - 引用[3]：详细说明了基本用法：“创建一个普通的Java类，并使用@ConfigurationProperties注解来指定配置文件中的属性的前缀”。例子中注解是用在类上的，并用@Component标记。 - 引用[4]：展示了两种方式： - 在类上使用：@ConfigurationProperties(prefix = "test") - 在方法上使用：在@Bean方法上添加@ConfigurationProperties。 具体来说，引用[4]说：“或 标注在方法上使用 @Configuration public class MyConfig { @Bean("user") @ConfigurationProperties(prefix = "user") public User user(){ return new User(); } }”。这表明注解可以作用在方法上。 总结作用对象： - @ConfigurationProperties注解可以作用在类上：当用在类上时，该类通常是一个Spring组件（如@Component）。 - 也可以作用在方法上：当用在@Bean方法上时，用于绑定返回对象的属性。 此外，从Spring Boot的官方文档或常识中知道，@ConfigurationProperties注解主要用于绑定配置到Java对象，因此作用对象是那些表示配置的Java类或Bean定义方法。 用户的问题具体是“作用对象”，所以我需要清晰地列出这些对象类型。 结构化回答： 1. **介绍注解的作用**：首先简要说明@ConfigurationProperties注解的目的是将外部配置（如application.properties）绑定到Java对象。 2. **明确作用对象**：基于引用，列出可以应用注解的位置： - 类上：用于配置类，通常配合@Component等注解。 - 方法上：用于@Bean方法，返回一个对象，注解绑定时置属性。 3. **提供例子**：为了清晰，可以给出简单的代码示例，但要遵守系统指令：代码块使用正确格式（如示例中的Python代码，但这里是Java），独立公式用$$...$$，但我这里没有数学公式，所以不需要。 4. **引用来源**：在回答中自然地添加引用标识，如[^1], [^3], [^4]。 5. **生成相关问题**：根据系统指令，我需要生成相关问题。相关问题应该基于用户的问题扩展，比如优化、常见错误等。 示例相关问题： 1. @ConfigurationProperties注解的常见使用场景是什么？ 2. 如何处理@ConfigurationProperties中的类型安全问题？ 3. 与其他配置注解如@Value的区别是什么？ 确保回答真实可靠：基于提供的引用，我不会添加外部知识。 回答结构： - 使用中文。 - 结构清晰：先回答问题，然后细化。 - 最后添加相关问题。 完整回答框架： 1. 简短介绍注解。 2. 解释作用对象。 3. 提供例子。 4. 结尾。 5. 生成相关问题。 </think>### @ConfigurationProperties注解的作用对象 在Spring Boot框架中，`@ConfigurationProperties`注解主要用于将外部配置文件（如`application.properties`或`application.yml`）中的属性绑定到Java对象，实现类型安全的配置管理。其核心作用是简化配置数据的读取和注入，提升开发效率。根据提供的参考资料，`@ConfigurationProperties`注解的作用对象主要包括以下两类： 1. **类（Java类）**： - 注解可直接应用于普通的Java类上，尤其适用于定义配置模型（如POJO）。 - 类中的字段（Field）需与配置文件中的属性名匹配（支持驼峰命名和下划线转换），并通过`prefix`属性指定配置前缀。 - 此类通常需注册为Spring容器的Bean（例如使用`@Component`、`@Configuration`等注解），以便Spring在启动时自动完成属性绑定。 - **示例代码**（基于引用[3]）： ```java @Component @ConfigurationProperties(prefix = "test") public class ConfigProperties { private String hostName; // 绑定的属性：test.host-name（或test.hostName） private int port; // 绑定的属性：test.port // 省略Setter/Getter方法 } ``` 在此例中，`ConfigProperties`类是注解的作用对象，Spring会将`test.host-name`等属性值注入到该类的实例中[^3]。 2. **方法（@Bean方法）**： - 注解可应用于Spring配置类中的`@Bean`方法上，用于绑定配置到方法返回的对象。 - 这种方式常用于动态创建Bean时，直接将外部属性绑定到返回的实例上，无需在类级别添加注解。 - **示例代码**（基于引用[4]）： ```java @Configuration public class MyConfig { @Bean("user") @ConfigurationProperties(prefix = "user") public User user() { return new User(); // 返回的User对象属性会被绑定到user.*配置 } } ``` 在此例中，`user()`方法是注解的作用对象，Spring会将`user.name`等属性注入到`User`实例中[^4]。 ### 关键说明 - **绑定机制**：无论作用于类还是方法，`@ConfigurationProperties`都依赖于Spring的绑定机制，将配置文件的键值对映射到对象的字段。类型安全检查确保配置值正确转换（如字符串转为整数），避免了类型错误[^2]。 - **依赖条件**：对象必须由Spring容器管理（即注册为Bean），否则绑定不会生效[^1]。 - **最佳实践**：推荐在类上使用，配合`prefix`定义清晰的作用域，避免配置冲突[^3]。 通过以上方式，`@ConfigurationProperties`注解简化了配置管理，适用于各种需要外部化配置的场景，如数据库连接、第三方API密钥等[^2][^3]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值