加载配置文件

288次阅读

共计 1730 个字符，预计需要花费 5 分钟才能阅读完成。

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

storage:
  local:
    max-size: 102400

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

@Component
public class FileUploader {@Value("${storage.local.max-size:102400}")
    int maxSize;

    ...
}

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

@Component
public class UploadFilter implements Filter {@Value("${storage.local.max-size:100000}")
    int maxSize;

    ...
}

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

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

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

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

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

public class StorageConfiguration {private String rootDir;
    private int maxSize;
    private boolean allowEmpty;
    private List<String> allowTypes;

    // TODO: getters and setters
}

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

@Configuration
@ConfigurationProperties("storage.local")
public class StorageConfiguration {...}

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

@Component
public class StorageService {final Logger logger = LoggerFactory.getLogger(getClass());

    @Autowired
    StorageConfiguration storageConfig;

    @PostConstruct
    public void init() {logger.info("Load configuration: root-dir = {}", storageConfig.getRootDir());
        logger.info("Load configuration: max-size = {}", storageConfig.getMaxSize());
        logger.info("Load configuration: allowed-types = {}", storageConfig.getAllowTypes());
    }
}