SpringBoot Configuration

SpringBoot 在 SpringMVC 的基础之上，进一步强化了配置有关的功能。下面介绍一下 SpringBoot 配置有关的功能。

配置外部化

所谓配置外部化，指的是不通过代码，而通过外部环境（文件）来进行配置，将配置和代码隔离开来，有助于降低配置的耦合性。

SpringBoot 支持从命令行参数，系统环境变量，配置文件等诸多位置读取配置信息。在工程的 resources 目录下加入一个配置文件 application.yml，将前面章节中 SQLite 有关的数据库的配置放到配置文件中：

  1. spring:
  2.   datasource:
  3.     driver-class-name: org.sqlite.JDBC
  4.     url: jdbc:sqlite:D:\\test.db

配置文件会随着代码打到 Jar 包当中，进而被 Spring 读取。可以看到这种配置写法可读性也很高。Spring 对配置文件的支持很强大，这里我们统一使用 yaml 配置的写法。

除了 Spring 内置的配置项之外，我们也可以定义自己的配置项，并且很方便的在代码中使用。例如我们有一个 MyProperties 的 Bean 类：

  1. public class MyProperties {
  2.     public MyProperties() {
  3.     }
  5.     private String username;
  6.     private String password;
  7.     // Getters & Setters
  8. }

在配置文件中进行配置：

  1. customProperty:
  2.   username: hello
  3.   password: world

在代码中使用：

  1. package com.skyline;
  3. import com.skyline.model.MyProperties;
  4. import org.springframework.boot.context.properties.ConfigurationProperties;
  5. import org.springframework.context.annotation.Bean;
  6. import org.springframework.context.annotation.Configuration;
  8. @Configuration
  9. public class AppConfig {
  11.     @Bean
  12.     @ConfigurationProperties(prefix="customProperty")
  13.     public MyProperties myProperties() {
  14.         return new MyProperties();
  15.     }
  16. }

对于单独的值来说，也可以在配置文件中存储，例如我们在配置文件中添加这样一个值：

  1. another.custom.property: hello-again

在代码中需要用的地方，可以这样使用：

  1. package com.skyline;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.web.bind.annotation.*;
  6. @RestController
  7. @RequestMapping("/person")
  8. public class PersonController {
  10.     @Value("${another.custom.property}")
  11.     String property;
  12. }

这里使用的 “${…}” 写法，是 Spring 独有的 SpEL（Spring Expression Language）语法。熟悉 JSP 的同学应该都在 JSP 中使用过 EL 表达式。SpEL 的思想是类似的。SpEL 的功能很强大，这里不再赘述，有兴趣的同学可以查阅有关资料。

Profile

SpringBoot 支持将配置文件分成多个部分，其中每个部分对应不同的环境，也就是 Profile。例如我们在测试环境和线上环境中，要使用不同的数据库等配置，这种需求是非常常见的。在 Spring 配置文件中我们可以这样做：

  1. spring.profiles.active = test
  3. ---
  4. spring:
  5.   profiles: test
  6. customProperty:
  7.   username: hello
  8.   password: world
  10. ---
  11. spring:
  12.   profiles: online
  13. customProperty:
  14.   username: hello2
  15.   password: world2

可以看到我们把配置文件分成了 test 和 online 两个部分，并且激活了 test 这个 Profile，通过这种方式，可以很方便地进行配置的切换。

Profile 还可以通过 SpringBoot 启动时传入命令行参数来激活。

注意: 下面的内容介绍不全面，暂时不推荐阅读。

Auto-Configuration

SpringBoot 对于跨组件配置的场景，提供了 Auto-Configuration 进行支持。Auto-Configuration 允许我们根据运行时环境进行判断，执行不同的配置操作。例如，我们可以判断一个外界的 Bean 是否存在：

  1. @Bean
  2. @ConditionalOnBean(name = "dataSource")
  3. public MyBean thisBean() {
  4.     //...
  5. }

通过这样配置，当已经存在一个名为 dataSource 的 Bean 时，thisBean 才会生效。

除此之外，还有 @ConditionalOnMissingBean，@ConditionalOnClass 等等一系列很方便的 annotation 来帮助我们实现自动配置。