json 형식이 Java의 요구 사항을 충족하는지 확인하는 방법

JSON Schema

JSON 스키마는 JSON 데이터 구조의 유효성을 검사하는 강력한 도구입니다. 스키마는 패턴이나 규칙으로 이해될 수 있습니다.

Json Schema는 Json 메타데이터를 정의하는 데 사용되는 일련의 어휘와 규칙을 정의하며, 메타데이터도 Json 데이터 형식으로 표현됩니다. Json 메타데이터는 Json 데이터가 충족해야 하는 사양을 정의합니다. 사양에는 멤버, 구조, 유형, 제약 조건 등이 포함됩니다.

JSON 스키마는 json의 형식 설명, 정의 및 템플릿입니다. 이를 통해 요구 사항을 충족하는 모든 json 데이터를 생성할 수 있습니다.

json-schema-validator

Java에서 json 데이터 형식을 확인하려면 다음을 사용하세요. json-schema-validator, 구체적인 예는 다음과 같습니다: json-schema-validator，具体实例如下：

1. 引入依赖

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

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.3.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.3.0</version>
        </dependency>

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<String, String> 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<String, Object> body = new HashMap<>();
        HashMap<String, Object> one = new HashMap<String, Object>() {{
            put("name", "王小明");
            put("sex", "男");
            put("age", 18);
        }};
        HashMap<String, Object> two = new HashMap<String, Object>() {{
            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 编写的时候，对列表使用了中括号 []

1. 종속성 소개

{
    "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"
    ]
}

jackson-core 및 jackson-core 는 json-schema-validator에 필요합니다.

2. 스키마 쓰기

우리가 확인하려는 데이터 형식이 다음과 같은 경우: rrreeeOutside 유형과 데이터이며 배열입니다. 배열 속성에는 성별, 이름, 나이가 포함됩니다🎜🎜스키마 파일 작성🎜rrreee🎜위 json은 대상 json의 데이터 형식을 설명합니다. 필드 유형 및 데이터이며 최대 이름은 내부로 제한됩니다. maxLength 길이는 3이고, 성별은 열거형 값이고 남성과 여성의 두 문자열만 사용할 수 있으며 연령은 숫자 유형입니다. 🎜

3. 코드 구현

rrreee🎜위 코드는 먼저 검증할 json의 표준 파일 validator.json을 얻은 후 JsonSchemaFactory.byDefault()를 호출합니다. .getValidator ().validate(jsonNodeSchema, jsonNode, true) 메소드는 수신되는 json을 확인합니다. 여기서 true는 해당 매개변수가 없는 경우 심층 검사를 의미합니다. 첫 번째 오류 발생 시 바로 반환🎜🎜그런 다음 테스트 메서드 빌드🎜rrreee

4. 실행 결과

🎜🎜{sex=sex 필드 값이 잘못되었습니다. 알 수 없음이 열거 범위 내에 없습니다. 이름 = Wang Xiaoming1 필드 길이가 너무 깁니다. 연령=연령 유형 오류, 기존 유형: 문자열, 예상 유형: ["integer", "number"]}🎜🎜

5. 요약

🎜스키마가 작성된 경우 목록에 대괄호 []를 사용하면 확인 중에 배열의 첫 번째 항목만 확인됩니다. 이는 다음과 같은 함정입니다.🎜rrreee🎜이 경우 첫 번째 항목만 확인됩니다. 🎜다른 오류가 있으면 오류가 보고되지 않습니다. ! 🎜🎜

위 내용은 json 형식이 Java의 요구 사항을 충족하는지 확인하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!