当前位置: 首页 > 编程笔记 >

Spring Boot中的Properties的使用详解

倪德业
2023-03-14
本文向大家介绍Spring Boot中的Properties的使用详解,包括了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_thenProhtml" target="_blank">perlyInjected() {
    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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持小牛知识库。

 类似资料:
  • 本文向大家介绍Springboot中@Value的使用详解,包括了Springboot中@Value的使用详解的使用技巧和注意事项,需要的朋友参考一下 Springboot通过@Value注解将配置文件中的属性注入到容器内组件中(可用在@Controller、@Service、@Configuration、@Component等Spring托管的类中)  1.普通字符串注入 例:yml中存在key

  • 本文向大家介绍springboot中thymeleaf模板使用详解,包括了springboot中thymeleaf模板使用详解的使用技巧和注意事项,需要的朋友参考一下 这篇文章将更加全面详细的介绍thymeleaf的使用。thymeleaf 是新一代的模板引擎,在spring4.0中推荐使用thymeleaf来做前端模版引擎。 thymeleaf介绍 简单说, Thymeleaf 是一个跟 Vel

  • 本文向大家介绍SpringBoot拦截器Filter的使用方法详解,包括了SpringBoot拦截器Filter的使用方法详解的使用技巧和注意事项,需要的朋友参考一下 前言: 最新Servlet 3.0拦截器的使用 1.pom.xml添加需要使用的依赖 2.添加Filter拦截器 3.添加测试控制器 4.添加启动类 5.添加拦截后调整的页面filter.html 6.右键项目Run As启动项目,

  • 本文向大家介绍SpringBoot整合Swagger和Actuator的使用教程详解,包括了SpringBoot整合Swagger和Actuator的使用教程详解的使用技巧和注意事项,需要的朋友参考一下 前言 本篇文章主要介绍的是SpringBoot整合Swagger(API文档生成框架)和SpringBoot整合Actuator(项目监控)使用教程。 SpringBoot整合Swagger 说明

  • 本文向大家介绍springboot+mybatis-plus实现内置的CRUD使用详解,包括了springboot+mybatis-plus实现内置的CRUD使用详解的使用技巧和注意事项,需要的朋友参考一下 springboot+mybatis-plus实现内置的CRUD使用详情,具体修改删除操作内容后文也有详细说明 mybatis-plus的特性 无侵入:只做增强不做改变,引入它不会对现有工程产

  • 本文向大家介绍详解springboot中redis的使用和分布式session共享问题,包括了详解springboot中redis的使用和分布式session共享问题的使用技巧和注意事项,需要的朋友参考一下 对于分布式使用Nginx+Tomcat实现负载均衡,最常用的均衡算法有IP_Hash、轮训、根据权重、随机等。不管对于哪一种负载均衡算法,由于Nginx对不同的请求分发到某一个Tomcat,T

  • 我尝试将Spring Boot与HikariDataSource配合使用,但出现了错误。断管怎么配置比较好还是用c3p0比较好?我正在使用这个配置 我使用: 和 springboot 版本 1.4.2.RELEASE

  • 我们有一个SpringBoot(版本1.5.12)REST Api,带有springfox-swagger2和springfox-swagger-ui(版本2.9.2) 我可以在http://localhost:8080/swagger-ui.html看到Swagger UI 我如何配置swagger-ui来读取我的swagger.yaml/json配置文件,而不是自动生成它?我尝试了几个配置都没