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
}


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

相关文章
|
14天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
2天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
14 4
SpringBoot必须掌握的常用注解!
|
4天前
|
Java Spring 容器
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
20 3
|
4天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
27 2
|
4天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
19 1
|
15天前
|
druid Java Maven
|
18天前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
22天前
|
Java 测试技术 Spring
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
这篇文章介绍了Spring Boot中配置文件的语法、如何读取配置文件以及如何通过静态工具类读取配置文件。
29 0
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
|
11天前
|
存储 Java 数据管理
强大!用 @Audited 注解增强 Spring Boot 应用,打造健壮的数据审计功能
本文深入介绍了如何在Spring Boot应用中使用`@Audited`注解和`spring-data-envers`实现数据审计功能,涵盖从添加依赖、配置实体类到查询审计数据的具体步骤,助力开发人员构建更加透明、合规的应用系统。
|
6月前
|
Java API Spring
Spring容器如何使用一个注解来指定一个类型为配置类型
Spring容器如何使用一个注解来指定一个类型为配置类型
50 0