升级 SpringBoot3 全项目讲解 — 如何在 SpringBoot3 种用 JsonSchema 来验证 Json是否有效？

学会这款 🔥全新设计的 Java 脚手架 ，从此面试不再怕！

一、认识 JsonSchema

JsonSchema 是一种基于 JSON 格式定义的语言，用于描述和验证 JSON 数据的结构。通过 JsonSchema，我们可以定义 JSON 数据必须遵守的规则，如必填字段、字段类型、格式等，从而确保接收到的 JSON 数据符合预期。

二、SpringBoot3 集成 JsonSchema

在 SpringBoot3 中集成 JsonSchema 并非难事，我们只需引入相关依赖并配置即可。

1. 添加依赖
   在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-json</artifactId>
</dependency>
<dependency>
    <groupId>org.everit.json</groupId>
    <artifactId>org.everit.json.schema</artifactId>
    <version>1.12.1</version>
</dependency>

2. 配置 JsonSchema Validator
   创建一个配置类，用于配置 JsonSchema Validator：

import org.everit.json.schema.Schema;
import org.everit.json.schema.loader.SchemaLoader;
import org.json.JSONObject;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class JsonSchemaConfig {
    @Bean
    public Schema jsonSchema() {
        JSONObject schemaJson = new JSONObject("{...}"); // 这里填写你的 JsonSchema 定义
        return SchemaLoader.load(schemaJson);
    }
}

三、编写 JsonSchema 定义

JsonSchema 定义是验证 JSON 数据的关键。以下是一个简单的 JsonSchema 定义示例：

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "age": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": ["name", "age"]
}

这个定义表示 JSON 对象必须包含 name 和 age 两个字段，其中 name 是字符串类型，age 是整数类型且最小值为 0。

四、在 SpringBoot3 中使用 JsonSchema 验证 JSON

接下来，我们将在 SpringBoot3 控制器中使用 JsonSchema 来验证接收到的 JSON 数据。

1. 创建控制器

import org.everit.json.schema.Schema;
import org.everit.json.schema.ValidationException;
import org.everit.json.schema.loader.SchemaLoader;
import org.json.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api")
public class JsonValidationController {
    private final Schema jsonSchema;
    @Autowired
    public JsonValidationController(Schema jsonSchema) {
        this.jsonSchema = jsonSchema;
    }
    @PostMapping("/validateJson")
    public String validateJson(@RequestBody String jsonData) {
        try {
            JSONObject jsonToValidate = new JSONObject(jsonData);
            jsonSchema.validate(jsonToValidate);
            return "JSON is valid!";
        } catch (ValidationException e) {
            return "JSON is invalid: " + e.getMessage();
        }
    }
}

2. 测试验证
   启动 SpringBoot3 应用后，使用 POST 请求发送 JSON 数据到 /api/validateJson 接口，即可验证 JSON 数据的有效性。

五、总结

通过本文的讲解，我们掌握了在 SpringBoot3 中使用 JsonSchema 验证 JSON 数据的有效性的方法。这一技术不仅提升了数据验证的便捷性和准确性，还增强了应用的健壮性。在实际开发中，根据具体需求灵活定义 JsonSchema，能够有效保障数据的正确性和完整性。
希望本文能对大家在 SpringBoot3 项目中应用 JsonSchema 验证 JSON 数据提供有益的参考和帮助。如有任何疑问或建议，欢迎在评论区留言交流。