ValidateJson

文档中心 › 组件索引 › ValidateJson

ValidateJson Processor

类型全限定名:cn.org.acal.lynxus.processors.standard.ValidateJson

所属 Bundle:cn.org.acal.lynxus:lynxus-standard-nar:2.11.8

描述

根据可配置的 JSON Schema 验证 FlowFile 的内容。规范标准请参见 json-schema.org。 此处理器支持基于配置属性使用换行符分隔的 JSON 输入,其中包含多个 JSON 对象, 否则如果输入 FlowFile 包含换行符分隔的 JSON,则仅验证第一行。

标签

JSONschemavalidation

属性

下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。

名称默认值可选值描述
Schema Access StrategySCHEMA_CONTENT_PROPERTY
  • Schema Name 属性 — 要使用的 Schema 名称由 'Schema Name' 属性指定。此属性的值用于在配置的 JSON Schema Registry 服务中查找 Schema。
  • JSON Schema 属性 — JSON Schema 的 URL 或文件路径或实际的 JSON Schema 由 'JSON Schema' 属性指定。无论以何种方式指定 JSON Schema,它都必须是有效的 JSON Schema
指定如何获取用于解释数据的架构。
Schema Name${schema.name}指定要在架构Registry属性中查找的架构名称
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
JSON Schema Registry控制器服务 API:
JsonSchemaRegistry
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8
指定用于 JSON 架构Registry的Controller Service
JSON SchemaJSON 架构或实际 JSON 架构内容的 URL 或文件路径
JSON Schema VersionDRAFT_2020_12
  • Draft 4 — Draft Version 4
  • Draft 6 — Draft Version 6
  • Draft 7 — Draft Version 7
  • Draft 2019-09 — Draft Version 2019-09
  • Draft 2020-12 — Draft Version 2020-12
JSON schema 规范
Input FormatFLOW_FILE
  • FlowFile — 对包含 JSON 的 FlowFile 内容进行验证
  • JSON Lines — 验证应用于包含 JSON Lines 或 NDJSON 的 FlowFile 内容
指定包含一个或多个 JSON 元素的 FlowFile 内容的预期格式
Max String Length20 MB解析JSON文档时字符串值允许的最大长度

关系 (Relationships)

名称描述自动终止
failure无法读取为 JSON 的 FlowFiles 将路由到此关系否
invalid根据指定模式无效的 FlowFiles 将路由到此关系否
valid根据架构成功验证的 FlowFile 将路由到此关系否

写入的 FlowFile 属性

名称描述
json.validation.errors如果 FlowFile 路由到无效关系,此属性将包含验证导致的错误消息

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件要求有传入连接。

系统资源考量

资源描述
MEMORY验证 JSON 需要将 FlowFile 内容读入内存