加载配置文件

加载配置文件可以直接使用注解@Value，例如，我们定义了一个最大允许上传的文件大小配置：

  1. storage:
  2.   local:
  3.     max-size: 102400

在某个FileUploader里，需要获取该配置，可使用@Value注入：

  1. @Component
  2. public class FileUploader {
  3.     @Value("{storage.local.max-size:102400}")
  4.     int maxSize;
  6.     ...
  7. }

在另一个UploadFilter中，因为要检查文件的MD5，同时也要检查输入流的大小，因此，也需要该配置：

  1. @Component
  2. public class UploadFilter implements Filter {
  3.     @Value("{storage.local.max-size:100000}")
  4.     int maxSize;
  6.     ...
  7. }

多次引用同一个@Value不但麻烦，而且@Value使用字符串，缺少编译器检查，容易造成多处引用不一致（例如，UploadFilter把缺省值误写为100000）。

为了更好地管理配置，Spring Boot允许创建一个Bean，持有一组配置，并由Spring Boot自动注入。

假设我们在application.yml中添加了如下配置：

  1. storage:
  2.   local:
  3.     # 文件存储根目录:
  4.     root-dir: ${STORAGE_LOCAL_ROOT:/var/storage}
  5.     # 最大文件大小，默认100K:
  6.     max-size: ${STORAGE_LOCAL_MAX_SIZE:102400}
  7.     # 是否允许空文件:
  8.     allow-empty: false
  9.     # 允许的文件类型:
  10.     allow-types: jpg, png, gif

可以首先定义一个Java Bean，持有该组配置：

  1. public class StorageConfiguration {
  3.     private String rootDir;
  4.     private int maxSize;
  5.     private boolean allowEmpty;
  6.     private List<String> allowTypes;
  8.     // TODO: getters and setters
  9. }

保证Java Bean的属性名称与配置一致即可。然后，我们添加两个注解：

  1. @Configuration
  2. @ConfigurationProperties("storage.local")
  3. public class StorageConfiguration {
  4.     ...
  5. }

注意到@ConfigurationProperties("storage.local")表示将从配置项storage.local读取该项的所有子项配置，并且，@Configuration表示StorageConfiguration也是一个Spring管理的Bean，可直接注入到其他Bean中：

  1. @Component
  2. public class StorageService {
  3.     final Logger logger = LoggerFactory.getLogger(getClass());
  5.     @Autowired
  6.     StorageConfiguration storageConfig;
  8.     @PostConstruct
  9.     public void init() {
  10.         logger.info("Load configuration: root-dir = {}", storageConfig.getRootDir());
  11.         logger.info("Load configuration: max-size = {}", storageConfig.getMaxSize());
  12.         logger.info("Load configuration: allowed-types = {}", storageConfig.getAllowTypes());
  13.     }
  14. }

这样一来，引入storage.local的相关配置就很容易了，因为只需要注入StorageConfiguration这个Bean，这样可以由编译器检查类型，无需编写重复的@Value注解。

练习

从加载配置文件 - 图1下载练习：加载配置文件 （推荐使用IDE练习插件快速下载）

小结

Spring Boot提供了@ConfigurationProperties注解，可以非常方便地把一段配置加载到一个Bean中。

读后有收获可以支付宝请作者喝咖啡，读后有疑问请加微信群讨论：

加载配置文件 - 图2 加载配置文件 - 图3