SpringBoot配置绑定方法详解

2022-11-13 18:11:05 配置绑定详解

配置绑定

所谓“配置绑定”就是把配置文件中的值与 JavaBean 中对应的属性进行绑定。通常，我们会把一些配置信息（例如，数据库配置）放在配置文件中，然后通过 Java 代码去读取该配置文件，并且把配置文件中指定的配置封装到 JavaBean(实体类)中。

SpringBoot提供了以下两种方式进行配置绑定:

使用@Value注解
使用@ConfigurationProperties注解

@Value基础类型配置

当我们只需要读取配置文件中的某一个配置时，可以通过 @Value 注解获取

语法

@Value("${key}")
数据类型成员变量;

@Value注解

${property : default_value}

注入的是外部配置文件对应的property
也可以自定义默认值

#{obj}

是SpEl表达式
可以表示常量的值

application.properties配置信息

#Girl配置信息===================================
girl.name=林初初
girl.age=25
#数组和集合=====================================
girl.hobbyList=单车,跑步,爬山
girl.habbyArray=唱歌,跳舞
girl.habbySet=烧烤,火锅,火锅
#Map集合=======================================
girl.hobbyMap={name:'林初初',age:25}
#日期==========================================
girl.birthday1 = 2022/10/09
girl.birthday2 = 2022-10-09
girl.birthday3 = 2022-10-09 21:12:21

config/Girl实体类

@Component
@Data
public class Girl {
    //:后默认值
    @Value("${girl.name:初初}")
    private String name;
    @Value("${girl.age}")
    private Integer age;
    @Value("${girl.hobbyList}")
    private List<String> hobbyList;
    @Value("${girl.habbyArray}")
    private String[] hobbyArray;
    @Value("${girl.habbySet}")
    private Set<String> hobbySet;
    @Value("#{${girl.hobbyMap}}")
    private Map<String,Object> hobbyMap;
    @Value("#{150+20}")
    private int height;
    @Value("${girl.birthday1}")
    @JSONFORMat(pattern="yyyy/MM/dd")
    private Date birthday1;
    @Value("${girl.birthday2}")
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private LocalDate birthday2;
    @Value("${girl.birthday3}")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime birthday3;
}

启动类App

@springBootApplication
public class App{
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(App.class, args);
        Girl bean = context.getBean(Girl.class);
        System.out.println(bean);
    }
}

运行结果

乱码解决

@ConfigurationProperties注解

通过 Spring Boot 提供的 @ConfigurationProperties 注解，可以将配置文件中的配置数据绑定到 JavaBean 中。

application.properties配置信息

注意:

boy.hobbyMap={name:'moming',age:18}这种格式,此注解解析不了

要分开写如:

boy.hobbyMap.name=moming

boy.hobbyMap.age=18

#Boy配置信息===================================
boy.name=沫洺
boy.age=18
boy.hobbyArray=单车,跑步,爬山
boy.hobbyMap.name=moming
boy.hobbyMap.age=18
boy.birthday=2022-10-09 21:12:21

config/Girl实体类

@Configuration
@ConfigurationProperties(prefix = "boy")
@Data
public class Boy {
    private String name;
    private int age;
    private String[] hobbyArray;
    private Map<String,Object> hobbyMap;
    @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")
    private LocalDateTime birthday;
}

启动类App

@SpringBootApplication
public class App{
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(App.class, args);
        Boy bean = context.getBean(Boy.class);
        System.out.println(bean);
    }
}

运行结果

只有在容器中的组件，才会拥有 SpringBoot 提供的强大功能。如果我们想要使用 @ConfigurationProperties 注解进行配置绑定，那么首先就要保证该JavaBean 对象在 ioc 容器中，所以需要用到 @Configuration 注解来添加组件到容器中。
JavaBean 上使用了注解 @ConfigurationProperties(prefix = "boy") ，它表示将这个 JavaBean 中的所有属性与配置文件中以“boy”为前缀的配置进行绑定。

@PropertySource

如果将所有的配置都集中到 application.properties 或 application.yml 中，那么这个配置文件会十分的臃肿且难以维护，因此我们通常会将与 Spring Boot 无关的配置（例如自定义配置）提取出来，写在一个单独的配置文件中，并在对应的 JavaBean 上使用 @PropertySource 注解指向该配置文件。

自定义配置文件user.properties

user.username=初初
user.age=18
user.birthday=2000/12/01
user.books={jsp:36,html:360,spring:65}
user.hobby=23,34
user.list=sprig,myatis
user.set=34,45,56

实体配置类User

@Component
@Data
@PropertySource("classpath:user.properties")
public class User {
    @Value("${user.username}")
    private String username;
    @Value("${user.age}")
    private Integer age;
    @Value("${user.birthday}")
    @DateTimeFormat(pattern = "yyyy/MM/dd")
    private LocalDate birthday;
    @Value("#{${user.books}}")
    private Map books;
    @Value("${user.hobby}")
    private Integer[] hobby;
    @Value("${user.list}")
    private List<String> list;
    @Value("${user.set}")
    private Set<Integer> set;
}

启动测试App

@SpringBootApplication
public class App{
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(App.class, args);
        User bean = context.getBean(User.class);
        System.out.println(bean);
    }
}

注意:该注解只能引用properties文件

到此这篇关于SpringBoot配置绑定方法详解的文章就介绍到这了,更多相关SpringBoot配置绑定内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

相关文章

SpringBoot配置绑定方法详解

目录

配置绑定

@Value基础类型配置

@ConfigurationProperties注解

@PropertySource