springboot读取配置文件属性注解@Value、@PropertySource、@ConfigurationProperties、@EnableConfigurationProperties

简介: 前沿介绍

在SpringBoot中,读取配置文件属性的相关注解有:


@Value

@PropertySource

@ConfigurationProperties

接下来,我们对其进行简单的案例介绍:


@Value

功能:@Value先读默认配置文件application.properties中定义的属性。


使用方式:@value(占位符) 该注解加载成员变量上

举例:@value("${user.name}")


application.properties中配置:

user.username=csp
user.password=123
user.age=22

java代码读取:

@Data// lombok插件注解,可替换成setter/getter
@AllArgsConstructor// lombok插件注解,可替换成全参构造函数
@NoArgsConstructor// lombok插件注解,可替换成空参构造函数
@Component
public class User {
    @Value("${user.username}")
    private String username;//csp
    @Value("${user.password}")
    private String password;//123
    @Value("${user.age}")
    private int age;//22
}

@PropertySource

功能:@PropertySource读取自定义的配置文件中定义的属性。


使用方式:@PropertySource(value={classpath:/指定配置文件名称}) 该注解加载成员变量上

举例:@PropertySource(value={"classpath:/user.properties"})


user.properties中配置:

user.username=csp1999
user.password=123456
user.age=22

java代码:

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@PropertySource(value={"classpath:/user.properties"})
public class User {
    @Value("${user.username}")
    private String username;//csp1999
    @Value("${user.password}")
    private String password;//123456
    @Value("${user.age}")
    private int age;//22
}


@ConfigurationProperties

功能:@ConfigurationProperties读取默认配置文件中定义的属性,但是可以指定属性前缀。


使用方式:@ConfigurationProperties(prefix = "前缀名称") 该注解加载成员变量上

举例:@ConfigurationProperties(prefix = "user")


默认配置文件application.properties/application.yml中配置:

user.username=csp789
user.password=456
user.age=18

注意:该注解在新版本的springboot中idea窗口会出现image.png

这种提示,解决方法1:

<!--
   个人版本踩坑:
   不加这个依赖的话,当在配置类中
   使用@ConfigurationProperties(prefix = "xxx")注解时,
   我这个版本的spring boot会提示有问题
-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artif
    <optional>true</optional>
</dependency>

解决方法2:

image.png

java代码:

@Data
@AllArgsConstructor
@NoArgsConstructor
@ConfigurationProperties(prefix = "user")
@Component
public class User {
  // 有了前缀,可以省去@Value注解
    private String username;//csp789
    private String password;//456
    private int age;//18
}


@ConfigurationProperties 和 @EnableConfigurationProperties 配合使用

单独使用@ConfigurationProperties时

@Data
@Component // 这时候加该注解 将DemoConfig 交给IOC管理
@ConfigurationProperties(prefix = "csp.user")
public class DemoConfig {
  private String username;
  private String password;
}

这种情况下,需要使用 DemoConfig时,直接:

@Autowired
private DemoConfig demoConfig;

即可!

@ConfigurationProperties 和 @EnableConfigurationProperties 配合使用

@Data
//@Component //  未将DemoConfig1 交给IOC管理
@ConfigurationProperties(prefix = "csp.user2")
public class DemoConfig1 {
  private String username1;
  private String password1;
}
@Data
//@Component //  未将DemoConfig2 交给IOC管理
@ConfigurationProperties2(prefix = "csp.user2")
public class DemoConfig2 {
  private String username2;
  private String password2;
}

这种情况下,需要使用 DemoConfig1和DemoConfig2时

@Service // 或者@Configuration/@Componet/@Controller/@Repository 只需要交给IOC管理即可
@EnableConfigurationProperties({
        DemoConfig1.class,
        DemoConfig2.class
})
public class TestService{
  @Autowired
  private DemoConfig1 demoConfig1;
  @Autowired
  private DemoConfig2 demoConfig2;
}


@PropertySource和@ConfigurationProperties配合使用

@Data
@AllArgsConstructor
@NoArgsConstructor
@ConfigurationProperties(prefix = "user")
@Component
@PropertySource(value={"classpath:/user.properties"})
public class User {
    private String username;//csp1999
    private String password;//123456
    private int age;//22
}


如果文章对您有帮助,还请您一键三连!

相关文章
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1846 128
|
存储 Java 文件存储
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— logback.xml 配置文件解析
本文解析了 `logback.xml` 配置文件的详细内容,包括日志输出格式、存储路径、控制台输出及日志级别等关键配置。通过定义 `LOG_PATTERN` 和 `FILE_PATH`,设置日志格式与存储路径;利用 `&lt;appender&gt;` 节点配置控制台和文件输出,支持日志滚动策略(如文件大小限制和保存时长);最后通过 `&lt;logger&gt;` 和 `&lt;root&gt;` 定义日志级别与输出方式。此配置适用于精细化管理日志输出,满足不同场景需求。
3445 1
|
Java 测试技术 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——少量配置信息的情形
本课主要讲解Spring Boot项目中的属性配置方法。在实际开发中,测试与生产环境的配置往往不同,因此不应将配置信息硬编码在代码中,而应使用配置文件管理,如`application.yml`。例如,在微服务架构下,可通过配置文件设置调用其他服务的地址(如订单服务端口8002),并利用`@Value`注解在代码中读取这些配置值。这种方式使项目更灵活,便于后续修改和维护。
544 0
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
777 4
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
981 2
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
822 12
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
813 0
探索Spring Boot的@Conditional注解的上下文配置
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
2081 0
|
Java 数据库 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
912 0
|
Java 微服务 Spring
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——少量配置信息的情形
在微服务架构中,随着业务复杂度增加,项目可能需要调用多个微服务。为避免使用`@Value`注解逐一引入配置的繁琐,可通过定义配置类(如`MicroServiceUrl`)并结合`@ConfigurationProperties`注解实现批量管理。此方法需在配置文件中设置微服务地址(如订单、用户、购物车服务),并通过`@Component`将配置类纳入Spring容器。最后,在Controller中通过`@Resource`注入配置类即可便捷使用,提升代码可维护性。
380 0