当前位置:

首页 > 编程开发 > 如何验证JSON格式是否合法?使用Java可以怎样实现?

如何验证JSON格式是否合法?使用Java可以怎样实现?

JSONSchemaJSONSchema是用于验证JSON数据结构的强大工具,Schema可以理解为模式或者规则。JsonSchema定义了一套词汇和规则,这套词汇和规则用来定义Json元数据,且元数据也是通过Json数据形式表达的。Json元数据定义了Json数据需要满足的规范,规范包括成员、结构、类型、约束等。JSONSchema就是json的格式描述、定义、模板,有了他就可以生成任何符合要求的json数据json-schema-validator在java中,对json数据格式的校验,使用json-

本文目录

    JSON Schema

    JSON Schema 是用于验证 JSON 数据结构的强大工具,Schema可以理解为模式或者规则。

    Json Schema定义了一套词汇和规则,这套词汇和规则用来定义Json元数据,且元数据也是通过Json数据形式表达的。Json元数据定义了Json数据需要满足的规范,规范包括成员、结构、类型、约束等。

    JSON Schema 就是json的格式描述、定义、模板,有了他就可以生成任何符合要求的json数据

    json-schema-validator

    在java中,对json数据格式的校验,使用 json-schema-validator,具体实例如下:

    1. 引入依赖

            
                com.github.fge
                json-schema-validator
                2.2.6
            
    
            
                com.fasterxml.jackson.core
                jackson-core
                2.3.0
            
            
                com.fasterxml.jackson.core
                jackson-core
                2.3.0
            

    jackson-core和 jackson-core 是必须要引入的,他们为 json-schema-validator 必须的

    2. 编写schema

    如果我们要校验的数据格式如下:

    {
        "data": [
            {
                "sex": "男",
                "name": "王小明",
                "age": 18
            },
            {
                "sex": "女",
                "name": "王小红",
                "age": 17
            }
        ],
        "type": "human"
    }

    外面是type和data,里面是一个数组,数组属性包括sex、name、age

    编写schema文件

    {
        "type": "object",
        "properties": {
            "type": {
                "type": "string"
            },
            "data": {
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": {
                        "name": {
                            "type": "string",
                            "maxLength": 3
                        },
                        "sex": {
                            "enum": [
                                "男",
                                "女"
                            ]
                        },
                        "age": {
                            "type": "number"
                        }
                    },
                    "required": [
                        "name",
                        "sex",
                        "age"
                    ]
                }
            }
        },
        "required": [
            "type",
            "data"
        ]
    }

    以上json描述了目标json的数据格式,外层必须字段type、data,里面限制了name的最大长度 maxLength 为3,sex 为枚举值,只可取 男、女两个字符串,age 为number类型。

    3. 代码实现

    public Map validatorJsonUnchecked(String body) {
            Map map = new HashMap<>();
            String filePath = "validator" + File.separator + "validator.json";
            ObjectMapper objectMapper = new ObjectMapper();
            try {
                JsonNode jsonNodeSchema = objectMapper.readTree(ResourceUtil.readUtf8Str(filePath));
                JsonNode jsonNode = objectMapper.readTree(body);
                ProcessingReport processingReport = JsonSchemaFactory.byDefault().getValidator().validate(jsonNodeSchema, jsonNode, true);
                if (!processingReport.isSuccess()) {
                    processingReport.forEach(processingMessage -> {
                        JsonNode missing = processingMessage.asJson().get("missing");
                        String keyword = processingMessage.asJson().get("keyword").asText();
                        // 如果缺失字段
                        if (!Objects.isNull(missing)) {
                            missing.forEach(miss -> {
                                String text = miss.asText();
                                map.put(text, text + " 字段缺失");
                            });
                            // 如果字段超长
                        } else if ("maxLength".equals(keyword)) {
                            String field = processingMessage.asJson().get("instance").get("pointer").asText();
                            String value = processingMessage.asJson().get("value").asText();
                            field = field.substring(field.lastIndexOf("/") + 1);
                            map.put(field, value + " 字段长度过长");
                            // 如果不在枚举范围内
                        } else if ("enum".equals(keyword)) {
                            String field = processingMessage.asJson().get("instance").get("pointer").asText();
                            String value = processingMessage.asJson().get("value").asText();
                            field = field.substring(field.lastIndexOf("/") + 1);
                            map.put(field, field + "字段值错误," + value + "不在枚举范围内");
                        } else if ("type".equals(keyword)) {
                            String field = processingMessage.asJson().get("instance").get("pointer").asText();
                            String found = processingMessage.asJson().get("found").asText();
                            String expected = processingMessage.asJson().get("expected").toString();
                            field = field.substring(field.lastIndexOf("/") + 1);
                            map.put(field, field + " 类型错误,现有类型: " + found + ", 预期类型:" + expected);
                        }
                    });
                }
            } catch (IOException | ProcessingException e) {
                log.error("校验json格式异常", e);
            }
            return map;
        }

    以上代码首先获取了 要校验的json的标准文件 validator.json,然后调用 JsonSchemaFactory.byDefault().getValidator().validate(jsonNodeSchema, jsonNode, true) 方法对传进来的json 进行了校验,这里 true 的意思是深度检查,如果没有这个参数,校验json的时候遇到第一个错误,就直接返回了

    接下来构建测试方法

        public static void main(String[] args) {
            ValidatorService validatorService = new ValidatorServiceImpl();
            Map body = new HashMap<>();
            HashMap one = new HashMap() {{
                put("name", "王小明");
                put("sex", "男");
                put("age", 18);
            }};
            HashMap two = new HashMap() {{
                put("name", "王小明1");
                put("sex", "未知");
                put("age", "18");
            }};
            body.put("type", "human");
            body.put("data", Arrays.asList(one,two));
    
            Map map = validatorService.validatorJsonUnchecked(JSONUtil.toJsonStr(body));
            System.out.println(map);
        }

    4. 执行结果

    {sex=sex字段值错误,未知不在枚举范围内, name=王小明1 字段长度过长, age=age 类型错误,现有类型: string, 预期类型:["integer","number"]}

    5. 整理总结

    如果schema 编写的时候,对列表使用了中括号 [],那么当校验的时候只会校验数组中的第一个,这是一个坑,如下

    {
        "type": "object",
        "properties": {
            "type": {
                "type": "string"
            },
            "data": {
                "type": "array",
                "items": [
                    {
                        "type": "object",
                        "properties": {
                            "name": {
                                "type": "string",
                                "maxLength": 3
                            },
                            "sex": {
                                "enum": [
                                    "男",
                                    "女"
                                ]
                            },
                            "age": {
                                "type": "number"
                            }
                        },
                        "required": [
                            "name",
                            "sex",
                            "age"
                        ]
                    }
                ]
            }
        },
        "required": [
            "type",
            "data"
        ]
    }

    如果是这样的话,只会校验 data 数组的第一条数据,其他的有错误也不会报错!!

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 Java JSON
    相关文章 更多
    Java单元测试入门:使用JUnit 5编写第一个测试用例
    Java单元测试入门:使用JUnit 5编写第一个测试用例

    面向初学者的JUnit 5实用入门指南。从测试概念、Maven依赖配置,到手把手编写首个单元测试用例及断言验证,助你掌握Java单元测试的核心流程。

    Java变量未初始化报错解析:局部变量与成员变量默认值差异
    Java变量未初始化报错解析:局部变量与成员变量默认值差异

    深入解析Java中局部变量未初始化编译报错与成员变量自动赋予默认值的机制差异,涵盖JVM内存分配、编译期确定性赋值检查与实际排查修复方案。

    Java获取当前时间并格式化输出:DateTimeFormatter与SimpleDateFormat
    Java获取当前时间并格式化输出:DateTimeFormatter与SimpleDateFormat

    详细讲解在Java中获取当前系统时间并进行格式化输出的两种核心方案:基于Java 8全新日期时间API的DateTimeFormatter与传统遗留的SimpleDateFormat,包含完整代码示例、线程安全机制对比及生产选型建议。

    Java中final与static final常量的定义及初始化规则
    Java中final与static final常量的定义及初始化规则

    深入解析Java中final变量与static final常量的定义、内存语义、初始化时机及合法赋值路径,涵盖编译期常量优化与实战避坑指南。

    Java抽象方法与接口方法的区别及选型建议
    Java抽象方法与接口方法的区别及选型建议

    深入对比Java中抽象类抽象方法与接口方法的语法演进、设计意图及运行期差异,并提供清晰的架构选型决策流程与实战范例。

    Java实现HTTP请求与JSON解析的完整代码示例
    Java实现HTTP请求与JSON解析的完整代码示例

    本文提供Java标准库HttpClient发起HTTP GET/POST请求并结合Jackson进行JSON数据反序列化与序列化的完整代码示例与工程实践指南。

    Java递归出现StackOverflowError的原因分析及栈空间优化方案
    Java递归出现StackOverflowError的原因分析及栈空间优化方案

    详细分析Java递归调用出现StackOverflowError的原因,结合代码说明线程栈、栈帧和递归深度之间的关系,并介绍终止条件排查、迭代改写、减少栈帧开销以及通过-Xss调整JVM栈空间的方法。

    Java空指针异常(NPE)的代码排查与修复实例
    Java空指针异常(NPE)的代码排查与修复实例

    针对Java中常见的NullPointerException(NPE),本文从堆栈日志定位、典型代码触发场景、具体修复代码对比到防御体系进行系统讲解,提供实用且易上手的排查与修复方案。

    selenium上传文件教程本地文件路径设置方法
    selenium上传文件教程本地文件路径设置方法

    深入解析Selenium处理文件上传的技术细节,涵盖标准HTML控件的路径直接注入法与非标准控件的系统级模拟方案,提供Windows与Linux环境下的路径设置最佳实践及常见异常排查。

    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景
    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景

    针对大数据工程场景,系统对比Java、Scala与Python在执行性能、生态结合、开发效率和维护成本上的核心差异,给出清晰的架构选型依据与落地方案。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。