Yaml校验，使用Java校验yaml文件

于 2024-08-13 12:49:51 发布
阅读量140 收藏 3
点赞数 2
分类专栏： Java 文章标签： java 前端 服务器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42254247/article/details/141161102
版权

Yaml校验

1. 核心目的和研究方向

项目中用到了yaml，例如：

# 字符串
name: jack
# 0-200岁，正数
age: 18

yaml需要客户填写，但是客户可能不会按照规则填写，所以需要定义一个schema文件来校验，例如：

name: 
	type: string
age:
	type: integer
	min: 0
	max: 200

本文涉及

  1. 是否存在这样的schema？以及schema如何编写？
  2. 如何使用Java项目进行yaml文件的验证

2. 是否存在这样的schema？以及schema如何编写？

2.1 是否存在这样的Schema

存在，以下2种

名字说明优点缺点参考文档Java库
JsonSchema用于校验标准Json数据格式的一种Schema，简单的yaml可以使用JsonSchema来进行校验。标准丰富、支持的库多、支持的语言多有些Yaml的扩展语法、JsonSchema可能无法验证https://json-schema.org/learn/getting-started-step-by-step
YamlSchema专门用于校验Yaml数据格式的Schema原生支持Yaml、支持扩展语法支持的编程语言少、库少https://asdf-standard.readthedocs.io/en/1.0.3/schemas/yaml_schema.html

2.2 Schema如何编写

以 com.networknt.json-schema-validator库为例子，

以如下文件为例子：

# 数字类型，范围为0-50
number_field: 25
# 字符串类型
string_field: "some string"
# 数组类型
array_field: ["item1", "item2"]
# 对象类型
people:
	# name必须填
  name: jack
# 规定为数字字母下划线
alphanumeric: "abc123_"
# 枚举-单选
single_choice: "option1"
# 枚举-多选
multi_choice: ["option1", "option2"]

2.2.1 JsonSchema

{
  "type": "object",
  "properties": {
    "number_field": {
      "type": "integer",
      "minimum": 0,
      "maximum": 50
    },
    "string_field": {
      "type": "string"
    },
    "array_field": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "people": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      },
      "required": ["name"]
    },
    "alphanumeric": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9_]+$"
    },
    "single_choice": {
      "type": "string",
      "enum": ["option1", "option2", "option3"]
    },
    "multi_choice": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["option1", "option2", "option3"]
      }
    }
  },
  "required": ["alphanumeric", "single_choice", "multi_choice", "array_field", "number_field", "string_field", "people"],
  "errorMessage": {
    "required": "缺少必填字段：''{0}/{1}''",
    "enum": "''{0}''的值必须是：''{1}''中的一个",
    "type": "''{0}''的类型必须是: ''{2}''，但你提供的是''{1}''"
  }
}

2.2.2 YamlSchema

type: object
  properties:
    alphanumeric:
      type: string
      pattern: "^[a-zA-Z0-9_]+$"
      errorMessage:
        pattern: "alphanumeric 字段只允许包含字母、数字和下划线"
    single_choice:
      type: string
      enum: ["option1", "option2", "option3"]
    multi_choice:
      type: array
      items:
        type: string
        enum: ["option1", "option2", "option3"]
        errorMessage:
          enum: "multi_choice 数组的每一项必须是 option1, option2, option3 其中之一"
      errorMessage:
        type: "multi_choice 字段必须是一个数组"
    array_field:
      type: array
      items:
        type: string
      errorMessage: "array_field 字段必须是一个字符串数组"
    number_field:
      type: integer
      minimum: 0
      maximum: 50
      errorMessage: "number_field 字段的值必须是 0 到 50 之间的整数"
    string_field:
      type: string
      errorMessage: "string_field 字段必须是一个字符串"
    people:
      type: object
      properties:
        name:
          type: string
      required:
        - name
      errorMessage:
        required:
          name: "people.name 字段是必填项"
  required:
    - alphanumeric
    - single_choice
    - multi_choice
    - array_field
    - number_field
    - string_field
    - people
  errorMessage:
    "required": "缺少必填字段：''{0}/{1}''"
    "enum": "''{0}''的值必须是：''{1}''中的一个"
    "type": "''{0}''的类型必须是: ''{2}''，但你提供的是''{1}''"

3. 如何使用Java项目进行yaml文件的验证

3.1 导入Maven包

<dependency>
    <groupId>com.networknt</groupId>
    <artifactId>json-schema-validator</artifactId>
  	<!--注意替换成你的版本/最新版本-->
    <version>1.4.2</version>
</dependency>

<dependency>
    <groupId>com.fasterxml.jackson</groupId>
    <artifactId>jackson-bom</artifactId>
	  <!--注意替换成你的版本/最新版本-->
    <version>2.12.5</version>
</dependency>

3.2 准备测试数据

data.yml

valid_data:
  alphanumeric: "abc123_"
  single_choice: "option1"
  multi_choice: ["option1", "option2"]
  array_field: ["item1", "item2"]
  number_field: 25
  string_field: "some string"

invalid_data:
  alphanumeric: "abc 123!"  # 包含无效字符
  single_choice: "invalid_option"  # 不在选项列表中
  multi_choice: ["option1", 123]  # 包含无效类型
  array_field: "not an array"  # 不是数组
  number_field: 55  # 超出范围
  string_field: 123  # 不是字符串
  people:
    age: 25  # 不是对象
    address:
      city: "London"

3.3 编写代码

3.3.1 使用JsonSchema

3.3.1.2 编写schema

schema.json

{
  "type": "object",
  "properties": {
    "alphanumeric": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9_]+$"
    },
    "single_choice": {
      "type": "string",
      "enum": ["option1", "option2", "option3"]
    },
    "people": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "address": {
          "type": "object",
          "province": {
            "type": "string"
          },
          "required": ["province"]
        }
      },
      "required": ["name", "address"]
    },
    "multi_choice": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["option1", "option2", "option3"]
      }
    },
    "array_field": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "number_field": {
      "type": "integer",
      "minimum": 0,
      "maximum": 50
    },
    "string_field": {
      "type": "string"
    }
  },
  "required": ["alphanumeric", "single_choice", "multi_choice", "array_field", "number_field", "string_field", "people"],
  "errorMessage": {
    "required": "缺少必填字段：''{0}/{1}''",
    "enum": "''{0}''的值必须是：''{1}''中的一个",
    "type": "''{0}''的类型必须是: ''{2}''，但你提供的是''{1}''"
  }
}

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.networknt.schema.JsonSchema;
import com.networknt.schema.JsonSchemaFactory;
import com.networknt.schema.SchemaValidatorsConfig;
import com.networknt.schema.SpecVersion;
import com.networknt.schema.ValidationMessage;
import org.springframework.core.io.ClassPathResource;

import java.io.IOException;
import java.util.Set;

public class YamlValidator {

    public static void main(String[] args) throws IOException {
        // 读取和解析 YAML数据 文件
        JsonNode yamlNode = new ObjectMapper(new YAMLFactory())
                .readTree(new ClassPathResource("data.yml").getInputStream());

        // 读取和解析 JSON Schema 文件
        JsonSchema schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V202012)
                .getSchema(new ClassPathResource("schema.json").getInputStream(), SchemaValidatorsConfig.builder()
                        .errorMessageKeyword("errorMessage")
                        .build());
       // 校验其中一个数据，你也可以校验valid_data
      // 另外，如果你的data文件，是一整个yaml，不区分分数据块，那么你无需yamlNode.get("...")，直接使用yamlNode自身即可
	 		 Set<ValidationMessage> validDataErrors = schema.validate(yamlNode.get("invalid_data"));
       if (validDataErrors.isEmpty()) {
            System.out.println(dataName + " 通过校验");
        } else {
            System.out.println(dataName + " 校验错误：");
            validDataErrors.forEach(error -> System.out.println(error.getMessage()));
        }
    }
}

3.3.1 使用YamlSchema

3.3.1.2 编写schema

schema.yaml

type: object
  properties:
    alphanumeric:
      type: string
      pattern: "^[a-zA-Z0-9_]+$"
      errorMessage:
        pattern: "alphanumeric 字段只允许包含字母、数字和下划线"
    single_choice:
      type: string
      enum: ["option1", "option2", "option3"]
    multi_choice:
      type: array
      items:
        type: string
        enum: ["option1", "option2", "option3"]
        errorMessage:
          enum: "multi_choice 数组的每一项必须是 option1, option2, option3 其中之一"
      errorMessage:
        type: "multi_choice 字段必须是一个数组"
    array_field:
      type: array
      items:
        type: string
      errorMessage: "array_field 字段必须是一个字符串数组"
    number_field:
      type: integer
      minimum: 0
      maximum: 50
      errorMessage: "number_field 字段的值必须是 0 到 50 之间的整数"
    string_field:
      type: string
      errorMessage: "string_field 字段必须是一个字符串"
    people:
      type: object
      properties:
        name:
          type: string
      required:
        - name
      errorMessage:
        required:
          name: "people.name 字段是必填项"
  required:
    - alphanumeric
    - single_choice
    - multi_choice
    - array_field
    - number_field
    - string_field
    - people
  errorMessage:
    "required": "缺少必填字段：''{0}/{1}''"
    "enum": "''{0}''的值必须是：''{1}''中的一个"
    "type": "''{0}''的类型必须是: ''{2}''，但你提供的是''{1}''"

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.networknt.schema.InputFormat;
import com.networknt.schema.JsonSchema;
import com.networknt.schema.JsonSchemaFactory;
import com.networknt.schema.SchemaValidatorsConfig;
import com.networknt.schema.SpecVersion;
import com.networknt.schema.ValidationMessage;
import com.networknt.schema.serialization.JsonNodeReader;

import java.util.Set;

public class YamlTest2 {

    public static void main(String[] args) {
      	// schema文件内容
        String schemaData2 = "...上述的schema文件内容";
        // 数据内容，Java17的多行字符串写法
        String inputData = """
                alphanumeric: '1)'
                single_choice: option5
                multi_choice: 1
                people:
                  age: 10
                """;
        // 构建yamlSchema数据读取器
        JsonNodeReader jsonNodeReader = JsonNodeReader.builder().yamlMapper(new ObjectMapper(new YAMLFactory())).build();
        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V202012,
                builder -> builder.jsonNodeReader(jsonNodeReader).build());
        SchemaValidatorsConfig config = SchemaValidatorsConfig.builder()
                .errorMessageKeyword("errorMessage")
                .build();
	    
	    // 读取schema
        JsonSchema schema = factory.getSchema(schemaData2, InputFormat.YAML, config);
        // 校验数据
        Set<ValidationMessage> validDataErrors = schema.validate(inputData, InputFormat.YAML);
        // 打印校验失败的信息
        validDataErrors.forEach(error -> System.out.println(error.getMessage()));
    }
}
青w韵
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
yaml语法及格式校验
全栈测试笔记
10-22 1万+
基本语法 1、yml文件以缩进代表层级关系 2、缩进不允许使用tab只能使用空格 3、空格的个数不重要，只要相同层级的元素左对齐即可 4、大小写敏感 5、数据格式为，名称:(空格)值 也就是说，如果冒号后面有值，冒号后面必须要有空格。 另外，-后面也必须要有空格。 6、＃ 表示注释， 从这个字符一直到行尾，都会被解析器忽略 7、--- 表示分段，在同一个yaml文件中，可以用 ...
使用python检查yaml配置文件是否符合要求
01-20
我就废话不多说了，大家还是直接看代码吧！ # coding=utf-8 import logging import yaml import os ... #将配置config.yaml配置文件以字典方式读取 dts_method = config['service']['method'] dts
yaml文件的一些语法规则及格式校验
luo_yu_1106的博客
03-15 3296
来源：http://www.ansible.com.cn/docs/YAMLSyntax.html YAML 语法 这个页面提供一个正确的 YAML 语法的基本概述, 它被用来描述一个 playbooks(我们的配置管理语言). 我们使用 YAML 是因为它像 XML 或 JSON 是一种利于人们读写的数据格式. 此外在大多数变成语言中有使用 YAML 的库. 你可能希望读Playbooks实践中如何使用的. 基本的 YAML 对于 Ansible, 每一个 YAML 文件都是从一个列表开始..
yaml在线校验网站
Allen技术小站
06-29 5822
http://yaml-online-parser.appspot.com/
如何校验K8S Yaml文件
LinkSLA的博客
04-23 2209
与JSON和INI相比，YAML更加紧凑和可读。例如，如果我们要定义一个可以在端口80上可达的pod，那么YAML、JSON和INI中的配置将如下表所示。很明显，YAML简化了我们定义Kubernetes应用程序的方式，特别是考虑到一个普通应用程序可能涉及几十个配置文件。此外，YAML的紧凑特性允许您将对象分组在一起，从而减少所需的文件数量。然而，在定义Kubernetes配置文件时存在重大挑战，特别是在嵌入manifest文件之间的约束和关系时。例如，我们如何确保按照最佳实践配置内存限制?
Atom的api-workbench插件 yaml文件格式校验
06-22
内容概要：我下载api-workbench主要是为了校验yaml文件，公司使用的是yaml文件写接口文档，经常修改完之后，构建失败。使用api-workbench插件，将yaml文件拖入到Atom中，即可自动识别格式问题。然后修改即可。 使用...
yaml_util.zip
08-01
本工具为控制台命令行工具，当你在编写spring-boot项目时，你会发现编写与yaml配置文件配合的java配置类文件是一件很繁琐的事，但是其实编写是有据可循的，因此写了这个工具用来自动生成配置类。需要实现配置好一个...
yamlConverter:yaml表定义信息提取工具：该程序用来提取yaml文件中的表定义信息，组成go结构体以及其他有用的信息
05-09
使用方法使用以下命令将同级目录下的user_info.yaml文件中的表定义信息提取出来，提取的结果存储在同级目录下的user_info.txt文件中，如果user_info.txt文件已存在，那么会覆盖已有内容。go run yamlConvertToStruct...
Java面试篇（JVM相关专题）
聂可以的博客
08-09 2699
Java面试篇（JVM相关专题）
springboot民办高校科研项目管理系统-计算机毕业设计源码54009
VX_DZbishe的博客
08-11 324
论文主要是对基于springboot的民办高校科研项目管理系统进行了介绍，包括研究的现状，还有涉及的开发背景，然后还对系统的设计目标进行了论述，还有系统的需求以及整个的设计方案，对系统的设计以及实现，也都论述的比较细致，最后对基于springboot的民办高校科研项目管理系统进行了一些具体测试。本次报告，首先分析了研究的背景、作用、意义，为研究工作的合理性打下了基础。
SpringBoot快速入门（手动创建）
m0_74124657的博客
08-11 313
代码如下//引导类项目的入口//注解添加导入进来你可以浏览器中查看自己编写的代码，看是否正确localhost：你命名的端口号（默认是8080。后面你也可以在配置文件修改）
软件测试需要具备的基础知识【功能测试】---后端知识（三）
最新发布
yang_xs的博客
08-12 970
为了更好的学习软件测试的相关技能，需要具备一定的基础知识。需要学习的基础知识包括：1、计算机基础2、前端知识3、后端知识4、软件测试理论后期分四篇文章进行编写，这是第三篇CS架构BS架构效率：c/s效率高，某些内容已经安装在系统中了，b/s每次都要加载最新的数据升级：b/s无缝升级；c/s删除老版本再安装新版本安全：c/s更安全，需要安装、注册、登录；b/s有浏览器即可使用，安全程度低开发成本：b/s成本低；c/s需要不同的系统要不同的开发人员，成本高。
集合（1）
supercool7的博客
08-12 455
表示不同的类型集合，Collection、Map、List、Set、Queue、Deque等，以及辅助性质的接口Iterator、LinkIterator、Comparator、Comparable这些接口是为迭代和比较元素而准备。对接口的具体实现，主要常用的有：ArrayList、LinkedList、HashMap、HashSet、TreeMap等等。理解Java集合体系可以从三个层次：最上层的接口、中间的抽象类、最后的实现类。是所有集合框架的根接口，包含了对集合进行基本操作的方法。
Spring事务
c1tenj2的博客
08-07 459
以银行转账为例，一次转账操作伴随着一个账户的扣钱和另一个账户的加钱，这个流程是一个原子操作，要么同时发生，一气呵成，要么都不做。AccountServiceImpl实现AccountService接口，里面只有一个转账方法AccountMapper以及其映射文件account数据库测试代码用1/0模拟程序运行时出现异常的情况由于没有开启事务，出现了莫名其妙少了100块钱的情况，说明这个事务不是连续的。
反射和注解
supercool7的博客
08-08 282
反射的基本步骤包括获取Class对象、获取类的信息（构造函数、方法、字段等），然后通过Constructor、Method、Field等类的实例进行具体的操作。注解以@符号开头，通常紧跟着一个标识符，后面可以跟一些参数，用于给类、方法、字段等添加元数据信息，这些信息可以在编译时、运行时被读取和处理。通过Class类，可以获取类的构造函数、方法、字段等信息，而不需要在编译时确定这些信息。Spring、SpringBoot、Mybatis等框架中都大量使用了反射机制。此外，开发者还可以定义自己的注解，通过。
Java：继承，this，super
m0_75257168的博客
08-10 362
可以同名，但参数列表不能相同（有参无参构造）
安卓Android & JAVA校招/实习面试合集:多线程、强软弱虚引用、进程、内存管理、Activity、Fragment......
qq_41915623的博客
08-10 454
安卓Android、java面试资料合集：内存管理、多线程、进程、强软弱虚应用、Activity
Spring一个强大便捷的代理工厂类
330553352的专栏
08-10 299
但如果你需要一种更加灵活和可配置性，那么Spring还提供了一个非常方便强大的ProxyFactoryBean类，该类特别适合那些需要更多自定义和控制的场景，例如当你需要为特定的Bean创建代理，或者需要在不修改原始代码的情况下为现有类添加额外的功能时。在Spring框架中，AOP（面向切面编程）是一种强大的编程范式，它允许开发者在不修改原有代码的情况下，为程序添加额外的功能，如日志记录、事务管理、安全控制等。在上面配置拦截器时，我们都是指定的具体拦截器，其实我们还可以使用通配符，指定拦截器。
请用html 集合js-yaml写一个yaml校验工具，并用codemirror显示yaml内容
07-11
你可以使用以下HTML代码来创建一个YAML校验工具，并使用CodeMirror库来显示YAML内容： ```html <!DOCTYPE html> <html> <head> <title>YAML校验工具</title> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.62.0/codemirror.min.css"> <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.62.0/codemirror.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/js-yaml/3.14.1/js-yaml.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.62.0/mode/yaml/yaml.min.js"></script> </head> <body> <textarea id="yaml-content" rows="10" cols="80"># 在这里输入你的YAML内容</textarea> <button onclick="validateYaml()">校验</button> <div id="result"></div> <script> function validateYaml() { var yamlContent = document.getElementById('yaml-content').value; try { jsyaml.safeLoad(yamlContent); document.getElementById('result').innerText = 'YAML内容有效！'; } catch (e) { document.getElementById('result').innerText = 'YAML内容无效：' + e.message; } } var yamlEditor = CodeMirror.fromTextArea(document.getElementById('yaml-content'), { mode: 'yaml', theme: 'default', lineNumbers: true }); </script> </body> </html> ``` 这段代码中，我们使用了CodeMirror库来创建一个具有语法高亮和行号
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值