java 公共配置文件格式

转载

mob64ca1419e0cc 2024-09-14 16:22:22

文章标签 java 公共配置文件格式 java项目中俩个配置文件 YAML java System 文章分类 Java 后端开发

YAML，在项目中用过没？它与 properties 文件啥区别？

目前 SpringBoot、SpringCloud、Docker等各大项目、各大组件，在使用过程中几乎都能看到YAML文件的身影。

2017 年的时候，我才真正把 YAML 文件用到负责的项目中，当时用 YAML 文件主要是为 Sharding-JDBC 配置数据源以及分库分表的规则。

java 公共配置文件格式_java 公共配置文件格式

从实际项目中把 sharding-jdbc.yaml 文件抽出来，为了更清晰，进行了大量简化，接下来就一同感受一下 YAML 的魅力。

java 公共配置文件格式_System_02

上图配置的内容虽然还没解释，仔细去看配置，大体都能看明白。其实，这就是 YAML 比 properties 配置文件的优势所在，层次感分明，配置有序，而且比较简洁。

纵然配置已经很清晰，还是要稍微带着看一看配置内容。

dev 是一个对象，对应于 Java 中的 Map，包含 datasources 和 tables 两个属性。其本身含义是开发环境配置，当然实际项目中也会有测试、准生产、生产的对应的配置。

datasources 属性是一个数组，对应于 Java 中的 List，数组元素由 name、default 等 10 个属性构成。其本身含义是数据源配置，因为涉及到分库，所以会有好多库要连接，图中只列举两个数据库；

tables 属性也是一个数组，对应于 Java 中的 List，数组元素由 tableName、databaseCount 等 5 个属性构成。其本身含义是要拆分表的规则配置，图中只列举一个项目基本信息表。

按照常规思路，写好配置文件，接下来就要校验一下，再稍微格式化一下。

在这儿校验Yaml文件：http://www.bejson.com/validators/yaml/

java 公共配置文件格式_YAML_03

如上图所示，YAML 文件校验转换之后，就真的太清晰啦！

不过，YAML 是很简单，但是有些细节，在开发中还是要注意，否则入坑就难跳出(一旦入坑，真的不好跳出来，别问为什么？一个空格难倒英雄汉，真心体会过)。

Tips:

1. 使用冒号加缩进的方式代表层级关系，使用短横杠代表数组元素；

2. 注意缩进不允许使用「tab」键，只能使用空格键(曾经掉这个坑啦，记忆之深刻)；

3. 缩进空格个数多少并不重要，只要相同层级的元素左对齐即可；

4. 如果冒号后跟着 value，一定要注意冒号后跟上空格呦！

5. YAML 大小写很敏感。

有关 YAML 的更多规范，可以参考如下 pdf，本次不过多展开去讲。

https://yaml.org/spec/1.2/spec.pdf

YAML 配置有了，该怎么去解析呢？

在不同的编程语言中，都有很多三方工具可以解析 YAML 文件，而在 Java 项目可以用 SnakeYaml 进行解析，接下来就写写代码体验一下 yaml 文件的解析。

首先引入依赖包(想用人家，就别想撇清关系！)

org.yamlsnakeyaml1.18

码点代码(从原项目中直接拿来，为了清晰，索性只留解析 YAML 文件部分的代码，呈现给你)

import org.apache.commons.collections4.MapUtils;import org.yaml.snakeyaml.Yaml;import java.io.File;import java.io.FileReader;import java.io.IOException;import java.util.ArrayList;import java.util.LinkedHashMap;import java.util.Map;/*** @author 一猿小讲*/public class ShardingJdbcDataSource {private static LinkedHashMap profile;@SuppressWarnings("unchecked")public static ArrayList> parse(String profileId, String key) throws IOException {//如果profile为空的情况才进行加载配置文件,减少读取文件的次数if (MapUtils.isEmpty(profile)) {Yaml yaml = new Yaml();File file = new File(ShardingJdbcDataSource.class.getResource("/").getPath() + "sharding-jdbc.yaml");try (FileReader fileReader = new FileReader(file);) {Map result = yaml.loadAs(fileReader, Map.class);profile = (LinkedHashMap) result.get(profileId);}}return (ArrayList>) profile.get(key);}public static void main(String[] args) throws IOException {// 开发环境String profileId = "dev";// 数据源集合ArrayList> datasources = parse(profileId, "datasources");for (LinkedHashMap datasource : datasources) {System.out.println(String.format("数据库名称：%s",datasource.get("name")));System.out.println(String.format("数据库URL：%s",datasource.get("jdbc.url")));}System.out.println("=============华丽的分割线==============");// 表集合ArrayList> tables = parse(profileId, "tables");for (LinkedHashMap table : tables) {System.out.println(String.format("表名称：%s",table.get("tableName")));System.out.println(String.format("数据库拆分 %d 个",table.get("databaseCount")));System.out.println(String.format("每个数据库表的数目：%s",table.get("tableCountPerDatabase")));}}}

去掉 main 函数，发现解析代码没几行，跑起来看一看，效果还可以。

java 公共配置文件格式_YAML_04