springBoot整合json schema 校验传入json

最新推荐文章于 2024-10-12 01:36:34 发布

Ⅲ1024

最新推荐文章于 2024-10-12 01:36:34 发布

阅读量1.1k

点赞数 1

文章标签： json spring java

本文链接：https://blog.csdn.net/weixin_52489284/article/details/131845459

版权

文章介绍了如何在SpringBoot项目中利用jsonschema库进行JSON数据的格式校验，通过添加相关依赖，定义JSONschema文件来设定数据规则，然后在Controller中进行校验，提高校验效率并避免手动解析的错误。示例中展示了成功和失败的校验结果。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

这是笔者在工作中碰到的一个需求需要对复杂的json进行格式校验自己手动解析json效率低而且容易出错于是使用json schema进行json校验效率高

springBoot版本2.7.3

pom添加如下依赖

<dependency>
    <groupId>com.github.fge</groupId>
    <artifactId>json-schema-validator</artifactId>
    <version>2.2.6</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
    <version>3.0.4</version>
</dependency>

自定义一个json文件定义规则twinSchema.json 放于resources根目录下

{
       "$schema": "http://json-schema.org/draft-07/schema#",
       "type": "object",
       "properties": {
              "id": {
                     "type": "string",
                     "pattern": "^metastar:define:.*$"
              },
              "type": {
                     "type": "string",
                     "enum": ["define"]
              },
              "name": {
                     "type": "string",
                     "pattern": "^.*#.*$"
              }

       },
       "required": ["id","type","name"]
}

实际内容可以根据需要修改

解释:

parttern 字段表示匹配类似正则表达式 ^xxxx 表示以xxxx开头

enum 表示枚举传入的type值只能为enum设置的值此处为 define

required 表示传入的json必须含有 id , type, name 字段否则报错

随便写一个Controller测试

@RestController
@RequestMapping("/test")
public class TestJsonController {


    @PostMapping("/user")
    public String createUser(@RequestBody String json) throws ProcessingException, IOException {

        JsonNode schemaNode = JsonLoader.fromResource("/twinSchema.json");

        JsonSchema schema = JsonSchemaFactory.byDefault().getJsonSchema(schemaNode);

        //解析用户提交的json数据
        JsonNode userNode = JsonLoader.fromString(json);

        //校验json是否符合规则
        ProcessingReport validate = schema.validate(userNode);

        if(validate.isSuccess()){
            return "User is created successfully";
        }else {
            return validate.toString();
        }

    }

}

postman测试1 数据正确