脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot @ConfigurationProperties注解

SpringBoot @ConfigurationProperties注解的简单使用

 更新时间：2021年05月24日 11:37:06   作者：WinterJay  
即便现在简化了配置，但是一个独立的配置文件总是易于理解而且使人安心的。Spring在构建完项目后，会默认在resources文件夹下创建一个application.properties文件，application.yml也是一样的效果。@ConfigurationProperties可以获取配置文件中的数据，将其注入类。

源码

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConfigurationProperties {
    @AliasFor("prefix")
    String value() default "";

    @AliasFor("value")
    String prefix() default "";

    boolean ignoreInvalidFields() default false;

    boolean ignoreUnknownFields() default true;
}

使用

向注解中传入配置文件中的前缀名，如果配置文件如下：

myConfigs:
  config1:
    field1: f1
    field2: f2
    field3: f3

那么代码中的配置类应该这样写：

@Component
@ConfigurationProperties("myConfigs.config1")
public class MyConfig1 {
    String field1;
    String field2;
    String field3;
}

如上所示，field1, field2, field3三个属性就被绑定到了对象上。

注意到我们使用了@Component，实际上我们使用配置类都是将其注入到其他类中，所以我们往往将其注册为Bean。

ignoreInvalidFields默认为false，不合法的属性的属性会默认抛出异常；
ignoreUnknownFields默认为true, 未能识别的属性会被忽略(所以打错了名字就会被忽略了)

@ConfigurationProperties(prefix="config.prefix", ignoreInvalidFields=true, ignoreUnknownFields=false)
public class MyConfig {
    // fields
}

Spring Boot的绑定规则相当宽松，myField, my-field, my_field等都能识别绑定到myField上。

可以给字段设定默认值，这样配置中没有传入时会使用默认值。

@ConfigurationProperties("your.prefix")
public class YourConfig {
    private String field = "Default"
    // setter
}

类的字段必须要有public访问权限的setter方法。

在很多情况下public的setter方法时必须的，使用IDEA的话，这里推荐Alt+Insert(Windows, Mac使用Alt+n)生成；当然，想使用Lombok也可以

以上就是SpringBoot @ConfigurationProperties注解的简单使用的详细内容，更多关于SpringBoot @ConfigurationProperties注解的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • Spark使用IDEA编写wordcount的示例演示

    Spark使用IDEA编写wordcount的示例演示

    这篇文章主要介绍了Spark使用IDEA编写wordcount的示例演示,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2023-07-07
  • java中Memcached的使用实例(包括与Spring整合)

    java中Memcached的使用实例(包括与Spring整合)

    这篇文章主要介绍了java中Memcached的使用实例(包括与Spring整合)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-07-07
  • Mybatis-Plus使用MetaObjectHandler实现自动填充实体对象字段

    Mybatis-Plus使用MetaObjectHandler实现自动填充实体对象字段

    在我们使用Mybatis-Plus时,一些简单的CRUD,你会发现好多表,许多字段是重复的,如果我们每次更新或者新增,都要手动赋值,那么会出现许多不必要的重复操作,所以本文介绍了Mybatis-Plus使用MetaObjectHandler实现自动填充实体对象字段,需要的朋友可以参考下
    2024-11-11
  • Nacos后台频繁打印get changedGroupKeys:[]的问题及解决

    Nacos后台频繁打印get changedGroupKeys:[]的问题及解决

    这篇文章主要介绍了Nacos后台频繁打印get changedGroupKeys:[]的问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • application.yaml与bootstrap.yaml的使用

    application.yaml与bootstrap.yaml的使用

    这篇文章主要介绍了application.yaml与bootstrap.yaml的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • SpringBoot接收JSON类型的参数方式

    SpringBoot接收JSON类型的参数方式

    这篇文章主要介绍了SpringBoot接收JSON类型的参数方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-03-03
  • 浅谈JAVA设计模式之代理模式

    浅谈JAVA设计模式之代理模式

    这篇文章主要介绍了JAVA设计模式之代理模式的的相关资料，文中代码非常详细，供大家参考和学习，感兴趣的朋友可以了解下
    2020-06-06
  • java地理坐标系及投影间转换代码示例

    java地理坐标系及投影间转换代码示例

    在地图投影中,经常需要将坐标从不同的坐标系之间进行转换,下面这篇文章主要给大家介绍了关于java地理坐标系及投影间转换的相关资料,需要的朋友可以参考下
    2024-08-08
  • 轻松掌握Java桥接模式

    轻松掌握Java桥接模式

    这篇文章主要帮助大家轻松掌握Java桥接模式,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2016-09-09
  • idea搭建mybatis环境配置全过程

    idea搭建mybatis环境配置全过程

    本文介绍了如何以IDEA搭建MyBatis环境配置的方法,包括步骤和注意事项,通过本文的介绍,可以轻松地以IDEA搭建MyBatis环境配置,提高开发效率
    2023-10-10

最新评论