Spring Boot自定义配置属性

Spring Boot

字数统计: 595阅读时长: 2 min

 2019/03/24   Share

自定义配置属性

Spring Boot提供了许多的配置，但通常情况我们需要自定义的配置应用自己的系统中，例如你需要配置一个默认的用户名密码做为系统的登录用。首先创建一个实体类，作为配置注入用，并使用@ConfigurationProperties注解进行批量注入，也可以使用Spring底层注解@Value的方式一个一个注入达到同样的效果。

@ConfigurationProperties注解

@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    ...
}

@Value注解

@Component
public class Person {
    @Value("${person.lastName}")
    private String lastName;
    @Value("#{11*2}")
    private Integer age;
    @Value("true")
    private Boolean boss;
    ...
}

测试类代码

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootHelloQuickApplicationTests {

    @Autowired
    Person person;

    @Test
    public void contextLoads() {
        System.out.println(person);
    }

}

测试结果

result

@ConfigurationProperties与@Value两种注解对比

名称	@ConfigurationProperties	@Value
功能	批量注入配置文件属性	一个个指定
松散绑定	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

如果我们只在某个业务逻辑中需要获取配置文件的某项值，使用@Value注解。
如果我们专门编写一个JavaBean类来和配置文件进行映射，就直接使用@ConfigurationProperties注解。

指定配置文件的配置

通常情况下我们将配置放在application开头的主配置文件中，这样随着项目的增大配置项的增多会使文件变得非常臃肿，其实Spring Boot早已考虑到了该问题，Spring Boot提供了@PropertySource和@ImportResource两个注解用于加载外部配置文件使用。

@PropertySource注解通常用于属性加载配置文件，注意：@PropertySource注解不支持加载yaml文件，仅支持properties文件。
@ImportResource注解通常用于加载Spring的xml配置文件。

@PropertySource注解

@PropertySource(value = {"classpath:person.properties"})
@Component
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    ...
}

@ImportResource注解

Spring Boot提出零xml的配置，因此Spring Boot默认情况下时不会识别项目中Spring的xml配置文件。为了能够加载xml的配置文件，Spring Boot提供了@ImportResource注解该注解可以加载Spring的xml配置文件，通常加于启动类上。

@ImportResource(locations = {"classpath:beans.xml"})
@SpringBootApplication
public class SpringBootHelloQuickApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootHelloQuickApplication.class, args);
    }
}

原文作者：金奇

原文链接：https://www.rossontheway.com/2019/03/24/SpringBoot自定义配置属性/

发表日期：March 24th 2019, 12:00:00 am

更新日期：March 24th 2019, 3:51:53 pm

Next Post

Spring Boot自动配置原理
Previous Post

Spring Boot配置文件的优先级

CATALOG

1. 自定义配置属性
2. 指定配置文件的配置
1. 2.1. @PropertySource注解
2. 2.2. @ImportResource注解

