cn.taskflow.jsv:json-schema-validator

json-schema-validator

English | 简体中文

Overview

Data validation middleware based on JSON DSL implementation. It provides developers with a powerful set of tools for defining and validating data structures.

Features

• Flexible DSL definition: Allows users to describe complex JSON structures with simple DSL syntax.
• Automatic code generation: Automatically generate Java classes from JSON schema, reducing manual coding effort.
• Data Validation: Rich built-in validation rules ensure data is in the expected format.
• Data extraction: Supports the extraction of specified fields from JSON documents, simplifying the data processing flow.

Installation

To integrate TaskFlow into your Java project.

The Maven project adds the following dependency to your 'pom.xml' file：

<dependency>
    <groupId>cn.taskflow.jsv</groupId>
    <artifactId>json-schema-validator</artifactId>
    <version>latest</version>
</dependency>

Add the following dependencies to the gradle project:

implementation 'cn.taskflow.jsv:json-schema-validator:latest'

Code generation sample program

JSON data

{
  "item": {
    "id": 1000,
    "orderIds": [ 1, 2, 3, 4, 5 ],
    "title": "item name"
  },
  "name": "shanfeng Zhang",
  "age": 60
} 

String json =...;
//JSON schema code is generated using JSON
String javaCode = CodeGenerationUtils.generateSchemaCode(json,new GenerateOptional());
System.out.println(javaCode);

The resulting code looks like this:：

JsonSchema jsonSchema = JsonObject.required(  
        JsonObject.required("item",
            JsonNumber.required("id"),
                JsonArray.required("orderIds"),
                    JsonString.required("title")
                ),
            JsonString.required("name"),
            JsonNumber.required("age"));
//The validity of the data is verified according to the schema definition

//data validation
Validator.fromSchema(jsonSchema).validate(json)
        
//Data Validation & Data Extraction
Validator.fromSchema(jsonSchema).validate(json).extract(json);

custom validation extension

CustomValidationRule customValidationRule = new CustomValidationRule() {
    @Override
    public boolean validate(JsonSchema schema, JsonNode node) throws ValidationException {
        /*Custom validation logic*/
        return true;
    }
};

//Add the validation policy withValidator(...) to any node in the Schema Optional
JsonSchema jsonSchema = JsonObject.required(
    JsonObject.required("item",
        JsonNumber.required("id").withValidator(customValidationRule),
        JsonArray.required("orderIds").withValidator(customValidationRule),
        JsonString.required("title").withValidator(customValidationRule)
    ).withValidator(customValidationRule),
    JsonString.required("name").withValidator(customValidationRule),
    JsonNumber.required("age").withValidator(customValidationRule)
    ).withValidator(customValidationRule);
        
//The data validation remains the same
Validator.fromSchema(jsonSchema).validate(...);

Example of Request Body Parameter Validation Based on Spring

Demonstration of Creating Order API

order Data Structure

  {
  "orderId": "ORD123456",
  "user": {
    "userId": "USR78910",
    "name": "Zhang Shanfeng",
    "email": "[e-mail]",
    "phone": "13800000000"
  },
  "items": [
    {
      "productId": "PROD001",
      "productName": "Wireless Headphones",
      "quantity": 2,
      "price": 199.99,
      "total": 399.98
    },
    {
      "productId": "PROD002",
      "productName": "Bluetooth Speaker",
      "quantity": 1,
      "price": 299.99,
      "total": 299.99
    }
  ],
  "totalAmount": 699.97,
  "orderDate": "2024-02-04T14:30:00Z",
  "status": "PENDING",
  "shippingAddress": {
    "recipient": "Li Si",
    "addressLine1": "Some street in Chaoyang District, Beijing",
    "addressLine2": "Building 1, No.1小区",
    "city": "Beijing",
    "state": "Beijing",
    "postalCode": "100000",
    "country": "China"
  },
  "payment": {
    "method": "CREDIT_CARD",
    "transactionId": "TXN123456789",
    "amount": 699.97,
    "currency": "CNY"
  }
}

Generate Schema Code Using JSON

CodeGenerationUtils.generateSchemaCode(json, new GenerateOptional());

Register the Generated Schema Definition to Spring

    @Bean("orderSchema")
public JsonSchema orderSchema(){
        return JsonObject.required(
            JsonString.required("orderId"),
            JsonObject.required("user",
            JsonString.required("userId"),
        JsonString.required("name"),
        JsonString.required("email"),
        JsonString.required("phone")),
        JsonArray.required("items",
            JsonObject.required(
                JsonString.required("productId"),
                JsonString.required("productName"),
                JsonNumber.required("quantity"),
                JsonNumber.required("price"),
                JsonNumber.required("total"))),
        JsonNumber.required("totalAmount"),
        JsonString.required("orderDate"),
        JsonString.required("status"),
        JsonObject.required("shippingAddress",
        JsonString.required("recipient"),
        JsonString.required("addressLine1"),
        JsonString.required("addressLine2"),
        JsonString.required("city"),
        JsonString.required("state"),
        JsonString.required("postalCode"),
        JsonString.required("country")),
        JsonObject.required("payment",
        JsonString.required("method"),
        JsonString.required("transactionId"),
        JsonNumber.required("amount"),
        JsonString.required("currency")));
        }

Example of Validating Request Body Parameters in Spring Controller

    @PostMapping("/api/test")
    public ApiResponse<T> createOrder(@RequestBody @JsonSchemaValidate("orderSchema") Order order) {
            //省略代码...  
    }

License

json-schema-validator software is licensed under the Apache License Version 2.0. See the LICENSE file for details.