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
}


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

相关文章
|
18天前
|
Java 调度 Spring
SpringBoot实现多线程定时任务动态定时任务配置文件配置定时任务
SpringBoot实现多线程定时任务动态定时任务配置文件配置定时任务
38 0
|
28天前
|
XML Java 数据库连接
spring boot 参数的过滤注解与实战
在Spring Boot应用中,对于入参的过滤,通常会涉及到对Web层的数据验证和处理。Spring Boot借助Spring框架提供了强大的验证框架支持,主要基于JSR-303/JSR-380(Bean Validation API)规范,以及Spring自身的@Valid或@Validated注解来实现请求参数的验证。以下是一些常见的使用案例来展示如何对参数进行过滤和验证。
24 1
|
1月前
|
Java 测试技术 数据库
SpringBoot:@Profile注解和Spring EL
SpringBoot:@Profile注解和Spring EL
|
1月前
|
Java 数据库 数据安全/隐私保护
【SpringBoot】Validator组件+自定义约束注解实现手机号码校验和密码格式限制
【SpringBoot】Validator组件+自定义约束注解实现手机号码校验和密码格式限制
|
7天前
|
XML Java API
springboot 常用的注解标签的概念及用法RequiredArgsConstructor 、RestController、RequestMapping
【4月更文挑战第12天】在 Spring Boot 中,@RequiredArgsConstructor, @RestController, 和 @RequestMapping 是常用的注解,每个都有其特定的功能和用法,它们合起来极大地简化了 Spring 应用程序的开发过程。
10 2
|
10天前
|
存储 关系型数据库 MySQL
【mybatis-plus】Springboot+AOP+自定义注解实现多数据源操作(数据源信息存在数据库)
【mybatis-plus】Springboot+AOP+自定义注解实现多数据源操作(数据源信息存在数据库)
|
11天前
|
Java 容器
SpringBoot使用配置注解开启自动配置功能&整合spring-boot-configuration-processor
SpringBoot使用配置注解开启自动配置功能&整合spring-boot-configuration-processor
12 0
|
1月前
|
XML 设计模式 Java
springboot创建并配置环境3 - 配置扩展属性(下)
springboot创建并配置环境3 - 配置扩展属性(下)
springboot创建并配置环境3 - 配置扩展属性(下)
|
1月前
|
XML JSON Java
springboot如何创建并配置环境3 - 配置扩展属性(上)
springboot如何创建并配置环境3 - 配置扩展属性(上)
springboot如何创建并配置环境3 - 配置扩展属性(上)
|
1月前
|
消息中间件 NoSQL Java
springboot - 条件注解@ConditionalOnClass原理
springboot - 条件注解@ConditionalOnClass原理
springboot - 条件注解@ConditionalOnClass原理