百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程字典 > 正文

细数Java项目中用过的配置文件(YAML篇)

toyiye 2024-05-25 20:11 32 浏览 0 评论

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


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


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


初步感受 YAML 的魅力

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


上图配置的内容虽然还没解释,仔细去看配置,大体都能看明白。其实,这就是 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/

如上图所示,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 文件的解析。


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

<dependency>
    <groupId>org.yaml</groupId>
    <artifactId>snakeyaml</artifactId>
    <version>1.18</version>
</dependency>

码点代码(从原项目中直接拿来,为了清晰,索性只留解析 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<String, Object> profile;

    @SuppressWarnings("unchecked")
    public static ArrayList<LinkedHashMap<String, Object>> 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<String, Object> result = yaml.loadAs(fileReader, Map.class);
                profile = (LinkedHashMap<String, Object>) result.get(profileId);
            }
        }
        return (ArrayList<LinkedHashMap<String, Object>>) profile.get(key);
    }

    public static void main(String[] args) throws IOException {
        // 开发环境
        String profileId = "dev";

        // 数据源集合
        ArrayList<LinkedHashMap<String, Object>> datasources = parse(profileId, "datasources");
        for (LinkedHashMap<String, Object> 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<LinkedHashMap<String, Object>> tables = parse(profileId, "tables");
        for (LinkedHashMap<String, Object> 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 函数,发现解析代码没几行,跑起来看一看,效果还可以。

本文中的解析 YAML 文件的代码,改个类名,就可以直接变成工具类,如果有需要,自行简单封装一下就 ok 啦。

其中 SnakeYaml 类库还有很多 API 可以使用,不一一带着写代码啦,感兴趣的自行参考 SnakeYaml 官方文档,去照猫画虎敲敲吧。

https://bitbucket.org/asomov/snakeyaml/wiki/Documentation

另外,细心的你在平时研发时,有没有发现,有的项目 YAML 文件的后缀是 .yml,有的项目却是 .yaml,到底哪个是正确的呢?很久很久之前我也纠结过,感兴趣可以去 stackoverflow 溜达一番。

https://stackoverflow.com/questions/21059124/is-it-yaml-or-yml

它山之石相信可以攻玉

有关 YAML 文件在实际项目中的使用,本次就谈到这里,它山之石可以攻玉,希望能对你有所帮助。

欢迎关注「一猿小讲」,了解更多精彩。

相关推荐

为何越来越多的编程语言使用JSON(为什么编程)

JSON是JavascriptObjectNotation的缩写,意思是Javascript对象表示法,是一种易于人类阅读和对编程友好的文本数据传递方法,是JavaScript语言规范定义的一个子...

何时在数据库中使用 JSON(数据库用json格式存储)

在本文中,您将了解何时应考虑将JSON数据类型添加到表中以及何时应避免使用它们。每天?分享?最新?软件?开发?,Devops,敏捷?,测试?以及?项目?管理?最新?,最热门?的?文章?,每天?花?...

MySQL 从零开始:05 数据类型(mysql数据类型有哪些,并举例)

前面的讲解中已经接触到了表的创建,表的创建是对字段的声明,比如:上述语句声明了字段的名称、类型、所占空间、默认值和是否可以为空等信息。其中的int、varchar、char和decimal都...

JSON对象花样进阶(json格式对象)

一、引言在现代Web开发中,JSON(JavaScriptObjectNotation)已经成为数据交换的标准格式。无论是从前端向后端发送数据,还是从后端接收数据,JSON都是不可或缺的一部分。...

深入理解 JSON 和 Form-data(json和formdata提交区别)

在讨论现代网络开发与API设计的语境下,理解客户端和服务器间如何有效且可靠地交换数据变得尤为关键。这里,特别值得关注的是两种主流数据格式:...

JSON 语法(json 语法 priority)

JSON语法是JavaScript语法的子集。JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔花括号保存对象方括号保存数组JS...

JSON语法详解(json的语法规则)

JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔大括号保存对象中括号保存数组注意:json的key是字符串,且必须是双引号,不能是单引号...

MySQL JSON数据类型操作(mysql的json)

概述mysql自5.7.8版本开始,就支持了json结构的数据存储和查询,这表明了mysql也在不断的学习和增加nosql数据库的有点。但mysql毕竟是关系型数据库,在处理json这种非结构化的数据...

JSON的数据模式(json数据格式示例)

像XML模式一样,JSON数据格式也有Schema,这是一个基于JSON格式的规范。JSON模式也以JSON格式编写。它用于验证JSON数据。JSON模式示例以下代码显示了基本的JSON模式。{"...

前端学习——JSON格式详解(后端json格式)

JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScriptProgrammingLa...

什么是 JSON:详解 JSON 及其优势(什么叫json)

现在程序员还有谁不知道JSON吗?无论对于前端还是后端,JSON都是一种常见的数据格式。那么JSON到底是什么呢?JSON的定义...

PostgreSQL JSON 类型:处理结构化数据

PostgreSQL提供JSON类型,以存储结构化数据。JSON是一种开放的数据格式,可用于存储各种类型的值。什么是JSON类型?JSON类型表示JSON(JavaScriptO...

JavaScript:JSON、三种包装类(javascript 包)

JOSN:我们希望可以将一个对象在不同的语言中进行传递,以达到通信的目的,最佳方式就是将一个对象转换为字符串的形式JSON(JavaScriptObjectNotation)-JS的对象表示法...

Python数据分析 只要1分钟 教你玩转JSON 全程干货

Json简介:Json,全名JavaScriptObjectNotation,JSON(JavaScriptObjectNotation(记号、标记))是一种轻量级的数据交换格式。它基于J...

比较一下JSON与XML两种数据格式?(json和xml哪个好)

JSON(JavaScriptObjectNotation)和XML(eXtensibleMarkupLanguage)是在日常开发中比较常用的两种数据格式,它们主要的作用就是用来进行数据的传...

取消回复欢迎 发表评论:

请填写验证码