SpringBoot-配置文件详解之自定义属性

Spring Boot优先于配置的惯例,旨在让我们尽快启动和运行。在一般情况下,我们不需要做太多的配置就能够让spring boot正常运行。在一些特殊的情况下,我们需要做修改一些配置,或者需要有自己的配置属性。

自定义属性

当我们创建一个springboot项目的时候,系统默认会为我们在src/main/java/resources目录下创建一个application.properties。当然我们也可以将application.properties改为application.yml文件,两种文件格式都支持。比如我们在application.properties中做了如下配置:

然后我们在程序中直接通过@Value("${属性名}")取属性值,如下:

@RestController
@RequestMapping("/custom/properties/*")
public class CustomPropertiesController {

  @Value("${my.name}")
  private String name;

  @Value("${my.age}")
  private String age;

  @RequestMapping("getNameAndAge")
  public String getNameAndAge() {
    return "name:" + name + ", age:" + age;
  }
}

通过浏览器访问:

注意事项

首先我们可以看到像上面这样的代码是完全没有问题的,只是我们在处理属性注入时容易忽略掉一个问题。假设我们没有在application.properties文件中配置my.name或者my.age属性会怎样?比如我们去掉my.age属性:

然后启动spring boot入口类,此时……程序报错:

SpringBoot-配置文件详解之自定义属性_第1张图片 这个提示已经很明确了,不能通过注解@Value取到my.age的属性值。那我们是不是应该给它个默认值处理呢?如下:

@RestController
@RequestMapping("/custom/properties/*")
public class CustomPropertiesController {

  @Value("${my.name:lisi}")
  private String name;

  @Value("${my.age:17}")
  private String age;

  @RequestMapping("getNameAndAge")
  public String getNameAndAge() {
    return "name:" + name + ", age:" + age;
  }
}

此时,再启动springboot入口类,启动正常。并通过浏览器访问,这正是我们可以预料到的结果:

源代码地址:https://gitee.com/chengab/SpringBoot/tree/master/springboot/src/main/java/com/study/springboot/properties

参考博客:SpringBoot非官方教程 | 第二篇:Spring Boot配置文件详解

你可能感兴趣的:(SpringBoot)