Spring读取配置文件属性实现方法

所属分类：软件编程 / java 阅读数： 42

收藏 0赞 0分享

一前言

本篇内容包括spring 运行时读取配置文件的多种方式和SpEl表达式入门基础；

二运行时读取配置文件

spring 运行时读取配置文件值提供了2种方式

属性占位符（Property placeholder）。

Spring表达式语言（SpEL）

2.1 读取外部配置文件

使用 @PropertySource 注解可以读取导classpath下配置文件属性；参数如下

value是个字符串数组；
ignoreResourceNotFound；如果设置为true, 配置文件未找到时不会报错；
encoding；指定字符集

首先resource 目录下创建配置文件zszxz.properties ；内容如下

zszxz.name = zszxz
zszxz.point = share

其次读取配置文件配置类如下

@Configuration
@PropertySource(value = {"classpath:zszxz.properties"},encoding = "UTF-8")
@Component
public class EnvironmentProperty {
  // 注入环境
  @Autowired
  private Environment environment;


  public void outputProperty(){
    System.out.println(environment.getProperty("zszxz.name"));
  }
}

最后通过测试类调用outputProperty()输出配置文件中属性的值

@RunWith(SpringJUnit4ClassRunner.class)//创建spring应用上下文
@ContextConfiguration(classes= EnvironmentProperty.class)//加载配置类
public class PropertyTest {
  @Autowired
  EnvironmentProperty environmentProperty;

  @Test
  public void test(){
    // zszxz
    environmentProperty.outputProperty();
  }
}

Tip 也可以使用@PropertySources 注解，其value是 @PropertySource类型的数组；

其中 EnvironmentProperty 获取主要属性方法如下

String getProperty(String key); 通过key 取值
String getProperty(String key, String defaultValue); 获取值，没有则使用默认值；
T getProperty(String key, Class var2); 获取值，指定返回类型；
T getProperty(String key, Class var2, T defaultValue);获取值，指定返回类型，指定默认值；
String getRequiredProperty(String key) ; key必须为非空否则抛出IllegalStateException异常

2.2 使用占位符获取配置文件

使用注解@Value获取配置文件属性值；其中值使用占位符("${........}")方式；

配置类示例

@Configuration
@PropertySource(value = {"classpath:zszxz.properties"},encoding = "UTF-8")
@Component
public class EnvironmentProperty {

  @Value("${zszxz.point}")
  private String point;

  public void outputPoint(){
    System.out.println(point);
  }

}

测试示例

@RunWith(SpringJUnit4ClassRunner.class)//创建spring应用上下文
@ContextConfiguration(classes= EnvironmentProperty.class)//加载配置类
public class PropertyTest {
  @Autowired
  EnvironmentProperty environmentProperty;
  @Test
  public void testPoint(){
    // share
    environmentProperty.outputPoint();
  }
}

2.3 SpEl表达式

Spring表达式语言（Spring Expression Language，SpEL）是一种灵活的表达式语言，能够以简洁的方式将值装配到bean属性或者构造器参数中，此过程中能够计算表达式获取计算值；使用@Valjue注解时，SpEL表达式要放到“#{......}”之中；

获取bean示例

  @Value("#{environmentProperty}")
  private EnvironmentProperty getBean;

  @Test
  public void testBean(){
    // com.zszxz.property.EnvironmentProperty$$EnhancerBySpringCGLIB$$8e54e11f@1d9b7cce
    System.out.println(getBean);
  }

获取方法示例

  @Value("#{environmentProperty.getStr()}")
  private String getMethod;

  @Test
  public void testMethod(){
    // 知识追寻者
    System.out.println(getMethod);
  }

获取属性示例

注意点：username字段必须是public

  @Value("#{environmentProperty.username}")
  private String getField;

  @Test
  public void testField(){
    // 知识追寻者
    System.out.println(getField);
  }

获取静态方法示例

其中T()表示运算会得到一个Class对象；

  @Value("#{T(java.lang.Math).random()}")
  private double number;

  @Test
  public void testStatic() {
    // 0.9205474938572363
    System.out.println(number);
  }

非空判定示例

其中? 表示非空判定

  @Value("#{environmentProperty.username?.toString()}")
  private String notNull;

  @Test
  public void testNotNUll() {
    // 知识追寻者
    System.out.println(notNull);
  }

支持运算符如下