脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Boot 校验JSON数据

Spring Boot 中使用 JSON Schema 校验复杂JSON数据的过程

 更新时间：2024年08月10日 09:23:59   作者：程序猿DD  
在数据交换领域,JSON Schema 以其强大的标准化能力,为定义和规范 JSON 数据的结构与规则提供了有力支持,下面给大家介绍Spring Boot 中使用 JSON Schema 校验复杂JSON数据的过程,感兴趣的朋友跟随小编一起看看吧

JSON是我们编写API时候用于数据传递的常用格式，那么你是否知道JSON Schema呢？

在数据交换领域，JSON Schema 以其强大的标准化能力，为定义和规范 JSON 数据的结构与规则提供了有力支持。通过一系列精心设计的关键字，JSON Schema 能够详尽地描述数据的各项属性。然而，仅凭 JSON Schema 本身，尚不足以验证 JSON 实例是否严格遵循预设的模式。此时，JSON Schema 验证器的角色便显得尤为关键。这些验证器如同严格的检查官，确保每一个 JSON 文档都能忠实地反映出模式的定义。JSON Schema 验证器，作为实现 JSON Schema 规范的技术工具，其灵活的集成能力使得无论项目规模大小，都能轻松地将 JSON Schema 融入开发流程，从而提升数据处理的效率与准确性。

下面我们来看看如何在Spring Boot应用中使用JSON Schema校验JSON数据

动手试试

  • 创建一个基本的Spring Boot应用，如果还不会可以点击查看快速入门
  • 在pom.xml中添加json-schema-validator依赖
<dependency>
  <groupId>com.networknt</groupId>
  <artifactId>json-schema-validator</artifactId>
  <version>1.4.0</version>
</dependency>

创建JSON Schema

在src/main/resources目录下创建一个validation.json文件，然后在里面制定一套详尽的验证规则，比如下面这样：

{
 "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Order Event",
    "description": "Order event schema for example",
    "required": ["order_id", "total_price", "products" ],
    "properties": {
       "order_id": {
          "type": "string"
        },
        "event": {
          "enum": ["PLACED", "DELIVERED", "RETURNED"],
          "type": "string"
        },
        "total_price": { 
         "type": "number",
             "minimum": 0
     },
        "products": {
      "type": "array",
      "items": {
        "additionalProperties": true,
        "required": ["product_id", "price"],
        "minItems": 1,
        "properties": {
          "product_id": {
            "type": "string"
          },
          "price": {
            "type": "number",
            "minimum": 0
          },
          "quantity": {
            "type": "integer"
          }
        }
      }
    }
   }
}

创建 JsonSchema 的 Bean

当然，你也可以直接new来创建，但实战中还是推荐用Spring管理这些实例，比如 下面这样：

@Configuration
public class JsonSchemaConfiguration {
    private static final String SCHEMA_VALIDATION_FILE = "validation.json";
    @Bean
    public JsonSchema jsonSchema() {
        return JsonSchemaFactory
                .getInstance( SpecVersion.VersionFlag.V7 )
                .getSchema( getClass().getResourceAsStream( SCHEMA_VALIDATION_FILE ) );
    }
}

使用 JsonSchema

@Slf4j
@Service
public class JsonSchemaValidationService{
  @Autowired
  private JsonSchema jsonSchema;
  public String validateJson(JsonNode jsonNode){
    Set<ValidationMessage> errors = jsonSchema.validate(jsonNode);
    if(errors.isEmpty()){
      log.info("event is valid");
    }else{
      log.info("event is invalid");
     }
      return errors.toString();
  }
}

在 Web 层的应用

创建一个Controller，当接收到来自客户端的JSON数据之后，就可以像下面这样对json数据进行校验：

import com.fasterxml.jackson.databind.JsonNode;
@RestController
public class JsonSchemaController {
    @Autowired
    private JsonSchemaValidationService service;
    @PostMapping("/test")
    public String validateEvent( @RequestBody JsonNode jsonNode ){
       return service.validateJson(jsonNode);
    }
}

测试一下

启动 Sprint Boot 应用，然后使用你喜欢的http客户端工具对/test接口发送测试请求：

比如，下面使用Curl来进行测试：

符合规则的合法请求：

$ curl --location 'localhost:8080/test' \
--header 'Content-Type: application/json' \
--data '{
  "order_id":"order134",
   "event": "PLACED",
   "products": [
     {
       "product_id": "product_1",
        "price":20.5,
       "quantity":2
     }
   ],
   "total_price": 41
}'

校验通过，返回：[]，没有错误信息

不符合规则的非法请求（却少order id）：

$ curl --location 'localhost:8080/test' \
--header 'Content-Type: application/json' \
--data '{
   "event": "PLACED",
   "products": [
     {
       "product_id": "product_1",
        "price":20.5,
       "quantity":2
     }
   ],
   "total_price": 41
}'

校验失败，将返回错误信息：[$.order_id: is missing but it is required]

相关资料What is JSON Schema?JSON Schema validator

到此这篇关于Spring Boot 中使用 JSON Schema 来校验复杂JSON数据的文章就介绍到这了,更多相关Spring Boot 校验JSON数据内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Spring boot CommandLineRunner启动任务传参实例详解

    Spring boot CommandLineRunner启动任务传参实例详解

    在使用SpringBoot构建项目时,我们通常有一些预先数据的加载,下面这篇文章主要给大家介绍了关于Spring boot CommandLineRunner启动任务传参的相关资料,需要的朋友可以参考下
    2022-06-06
  • Java 中图片压缩处理的解决方案

    Java 中图片压缩处理的解决方案

    图片经过base64编码转换后,文件会变大的原因是因为base64编码会将每个3字节的数据转换成4字节的数据,并且在转换的过程中还会添加一些额外的字符,这篇文章主要介绍了Java 中如何对图片进行压缩处理,需要的朋友可以参考下
    2023-09-09
  • FeignClient设置动态url方式

    FeignClient设置动态url方式

    文章介绍了如何在Spring Cloud环境下使用FeignClient实现负载均衡,通过配置Nacos和FeignClient属性,可以实现服务间的负载均衡调用
    2024-11-11
  • Java后端配置允许跨域方式

    Java后端配置允许跨域方式

    本文介绍了在不同技术和框架中配置跨域资源共享（CORS）的方法,包括使用SpringMVC的@CrossOrigin注解、SpringBoot的全局CORS配置、SpringSecurity中的CORS集成以及手动设置响应头,根据具体需求和技术栈,选择合适的方法来确保跨域请求的安全性和有效性
    2025-02-02
  • Spring源码解析之推断构造方法

    Spring源码解析之推断构造方法

    今天给大家带来的是关于Java的相关知识,文章围绕着Spring推断构造方法展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • nacos修改druid配置自动刷新后服务异常的问题

    nacos修改druid配置自动刷新后服务异常的问题

    这篇文章主要介绍了nacos修改druid配置自动刷新后服务异常的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-06-06
  • Spring Boot统一处理全局异常的实战教程

    Spring Boot统一处理全局异常的实战教程

    最近在做项目时需要对异常进行全局统一处理,所以下面这篇文章主要给大家介绍了关于Spring Boot统一处理全局异常的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2021-12-12
  • Intellij IDEA中启动多个微服务(开启Run Dashboard管理)

    Intellij IDEA中启动多个微服务(开启Run Dashboard管理)

    这篇文章主要介绍了Intellij IDEA中启动多个微服务(开启Run Dashboard管理)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • SpringBoot配置mybatis驼峰命名规则自动转换的实现

    SpringBoot配置mybatis驼峰命名规则自动转换的实现

    这篇文章主要介绍了SpringBoot配置mybatis驼峰命名规则自动转换的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • Spring AOP切点表达式使用及说明

    Spring AOP切点表达式使用及说明

    这篇文章主要介绍了Spring AOP切点表达式使用及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05

最新评论