Spring Boot中的Properties的使用详解

更新时间：2020年02月11日 10:57:57 作者：flydean

这篇文章主要介绍了Spring Boot中的Properties的使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

简介

本文我们将会讨怎么在Spring Boot中使用Properties。使用Properties有两种方式，一种是java代码的注解，一种是xml文件的配置。本文将会主要关注java代码的注解。

使用注解注册一个Properties文件

注册Properties文件我们可以使用@PropertySource 注解，该注解需要配合@Configuration 一起使用。

@Configuration
@PropertySource("classpath:foo.properties")
public class PropertiesWithJavaConfig {
  //...
}

我们也可以使用placeholder来动态选择属性文件：

@PropertySource({ 
 "classpath:persistence-${envTarget:mysql}.properties"
})
@PropertySource也可以多次使用来定义多个属性文件：

@PropertySource("classpath:foo.properties")
@PropertySource("classpath:bar.properties")
public class PropertiesWithJavaConfig {
  //...
}

我们也可以使用@PropertySources来包含多个@PropertySource：

@PropertySources({
  @PropertySource("classpath:foo.properties"),
  @PropertySource("classpath:bar.properties")
})
public class PropertiesWithJavaConfig {
  //...
}

使用属性文件

最简单直接的使用办法就是使用@Value注解：

@Value( "${jdbc.url}" )
private String jdbcUrl;

我们也可以给属性添加默认值：

@Value( "${jdbc.url:aDefaultUrl}" )
private String jdbcUrl;

如果要在代码中使用属性值，我们可以从Environment API中获取：

@Autowired
private Environment env;
...
dataSource.setUrl(env.getProperty("jdbc.url"));

Spring Boot中的属性文件

默认情况下Spring Boot 会读取application.properties文件作为默认的属性文件。当然，我们也可以在命令行提供一个不同的属性文件：

java -jar app.jar --spring.config.location=classpath:/another-location.properties

如果是在测试环境中，我们可以使用@TestPropertySource 来指定测试的属性文件：

@RunWith(SpringRunner.class)
@TestPropertySource("/foo.properties")
public class FilePropertyInjectionUnitTest {
 
  @Value("${foo}")
  private String foo;
 
  @Test
  public void whenFilePropertyProvided_thenProperlyInjected() {
    assertThat(foo).isEqualTo("bar");
  }
}

除了属性文件，我们也可以直接以key=value的形式：

@RunWith(SpringRunner.class)
@TestPropertySource(properties = {"foo=bar"})
public class PropertyInjectionUnitTest {
 
  @Value("${foo}")
  private String foo;
 
  @Test
  public void whenPropertyProvided_thenProperlyInjected() {
    assertThat(foo).isEqualTo("bar");
  }
}

使用@SpringBootTest，我们也可以使用类似的功能：

@RunWith(SpringRunner.class)
@SpringBootTest(properties = {"foo=bar"}, classes = SpringBootPropertiesTestApplication.class)
public class SpringBootPropertyInjectionIntegrationTest {
 
  @Value("${foo}")
  private String foo;
 
  @Test
  public void whenSpringBootPropertyProvided_thenProperlyInjected() {
    assertThat(foo).isEqualTo("bar");
  }
}

@ConfigurationProperties

如果我们有一组属性，想将这些属性封装成一个bean，则可以考虑使用@ConfigurationProperties。

@ConfigurationProperties(prefix = "database")
public class Database {
  String url;
  String username;
  String password;
 
  // standard getters and setters
}

属性文件如下：

database.url=jdbc:postgresql:/localhost:5432/instance
database.username=foo
database.password=bar

Spring Boot将会自动将这些属性文件映射成java bean的属性，我们需要做的就是定义好prefix。

yaml文件

Spring Boot也支持yaml形式的文件，yaml对于层级属性来说更加友好和方便，我们可以看下properties文件和yaml文件的对比：

database.url=jdbc:postgresql:/localhost:5432/instance
database.username=foo
database.password=bar
secret: foo

database:
 url: jdbc:postgresql:/localhost:5432/instance
 username: foo
 password: bar
secret: foo

注意yaml文件不能用在@PropertySource中。如果你使用@PropertySource，则必须指定properties文件。

Properties环境变量

我们可以这样传入property环境变量：

java -jar app.jar --property="value"

~~shell

java -Dproperty.name="value" -jar app.jar

或者这样：
export name=value
java -jar app.jar

环境变量有什么用呢？当指定了特定的环境变量时候，Spring Boot会自动去加载application-environment.properties文件，Spring Boot默认的属性文件也会被加载，只不过优先级比较低。

## java代码配置

除了注解和默认的属性文件，java也可以使用PropertySourcesPlaceholderConfigurer来在代码中显示加载：

@Bean
public static PropertySourcesPlaceholderConfigurer properties(){

PropertySourcesPlaceholderConfigurer pspc
 = new PropertySourcesPlaceholderConfigurer();
Resource[] resources = new ClassPathResource[ ]
 { new ClassPathResource( "foo.properties" ) };
pspc.setLocations( resources );
pspc.setIgnoreUnresolvablePlaceholders( true );
return pspc;
}

本文的例子可以参考：https://github.com/ddean2009/learn-springboot2/tree/master/springboot-properties](https://github.com/ddean2009/learn-springboot2/tree/master/springboot-properties

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

详解SpringCloud服务认证（JWT）
本篇文章主要介绍了SpringCloud服务认证（JWT），小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-01-01
mybatis插入数据后返回自增主键ID的两种实现方式
这篇文章主要介绍了mybatis插入数据后返回自增主键ID的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-05-05
Java面试题目集锦
本文是小编日常收集整理的java面试题目，非常不错，具有参考借鉴价值，需要的朋友可以参考下
2016-09-09
MybatisPlus中selectPage的使用方法
本文主要介绍了MybatisPlus中selectPage的使用方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-05-05
spring的UnexpectedRollbackException事务嵌套示例解析
这篇文章主要为大家介绍了spring的UnexpectedRollbackException事务嵌套示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-09-09
Java递归实现斐波那契数列
这篇文章主要为大家详细介绍了Java递归实现斐波那契数列，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-02-02
Java中的synchronized重量级锁解析
这篇文章主要介绍了Java中的synchronized重量级锁解析,内核需要去申请这个互斥量,必须要进入内核态,也就是这里需要用户态,内核态的切换,状态的切换,开销是比较大的,这就是重型锁的一个弊端,需要的朋友可以参考下
2024-01-01
Java设计模式之策略模式_动力节点Java学院整理
策略模式是对算法的封装，把一系列的算法分别封装到对应的类中，并且这些类实现相同的接口，相互之间可以替换。接下来通过本文给大家分享Java设计模式之策略模式，感兴趣的朋友一起看看吧
2017-08-08
Java压缩解压zip技术_动力节点Java学院整理
Java解压缩zip - 多个文件(包括文件夹)，对多个文件和文件夹进行压缩，对复杂的文件目录进行解压。压缩方法使用的是可变参数，可以压缩1到多个文件
2017-05-05
java多线程编程之线程的生命周期
线程要经历开始（等待）、运行、挂起和停止四种不同的状态。这四种状态都可以通过Thread类中的方法进行控制。下面给出了Thread类中和这四种状态相关的方法
2014-01-01

Spring Boot中的Properties的使用详解

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具