fastjson怎么校验json格式

Fastjson如何校验JSON格式：从基础到实践的完整指南

在Java开发中，处理JSON数据是家常便饭，而Fastjson作为阿里巴巴开源的高性能JSON库，凭借其简洁的API和高效的性能，被广泛使用，从字符串或输入流中获取JSON数据时，首要任务往往是校验其格式是否正确，一个格式错误的JSON可能导致解析失败、程序异常甚至安全漏洞，本文将详细介绍如何使用Fastjson校验JSON格式，涵盖不同场景下的实现方法、最佳实践以及常见问题解决方案。

为什么需要校验JSON格式？

在代码之前,我们先明确一下校验JSON格式的必要性：

1. 数据完整性：确保输入的数据符合JSON规范,避免因格式错误导致的解析异常。
2. 程序健壮性：提前过滤掉非法的JSON输入,防止程序因解析错误而崩溃。
3. 安全性：虽然Fastjson本身有安全机制,但校验可以减少恶意构造的非标准JSON进入后续处理流程的风险。
4. 接口契约：在API开发中，确保接收到的请求体或响应体是合法的JSON,符合接口定义。

使用Fastjson校验JSON格式的核心方法

Fastjson提供了多种方式来校验JSON格式，核心在于其JSON.parse()方法，该方法在尝试解析JSON字符串时，如果格式不正确，会抛出JSONException。

基本方法：JSON.parse(String text)

这是最直接、最常用的校验方法，它尝试将输入的字符串解析为JSON对象（JSONObject）或JSON数组（JSONArray），如果字符串不是合法的JSON，则会抛出JSONException。

示例代码：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONException;
public class FastjsonJsonValidator {
    public static boolean isValidJson(String jsonString) {
        if (jsonString == null || jsonString.trim().isEmpty()) {
            return false; // 空字符串或null视为不合法
        }
        try {
            JSON.parse(jsonString);
            return true; // 解析成功，格式合法
        } catch (JSONException e) {
            return false; // 解析失败，格式不合法
        }
    }
    public static void main(String[] args) {
        String validJsonStr = "{\"name\":\"张三\", \"age\":30, \"isStudent\":false}";
        String invalidJsonStr = "{\"name\":\"李四\", \"age\":30, \"isStudent\":false,"; // 缺少闭合括号
        String notJsonStr = "Hello, this is not JSON!";
        System.out.println("Is validJsonStr valid? " + isValidJson(validJsonStr)); // true
        System.out.println("Is invalidJsonStr valid? " + isValidJson(invalidJsonStr)); // false
        System.out.println("Is notJsonStr valid? " + isValidJson(notJsonStr)); // false
    }
}

说明：

• JSON.parse()对于标准的JSON对象（以开头）和JSON数组（以[]开头）都能正确解析。
• 如果字符串是JSON数字、JSON字符串、JSON布尔值或JSON null（如"123"、"\"abc\""、"true"、"null"），JSON.parse()也会尝试解析，并返回对应的Java对象（Integer、String、Boolean、null），如果你的需求是校验必须是JSON对象或数组,则需要额外判断解析结果的类型。

校验并获取解析结果（带类型检查）

如果你不仅想知道JSON是否合法，还想获取解析后的对象，并且对类型有要求（例如必须是JSON对象）,可以这样处理：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONException;
import com.alibaba.fastjson.JSONObject;
public class FastjsonJsonValidatorWithType {
    public static boolean isValidJsonObject(String jsonString) {
        try {
            Object obj = JSON.parse(jsonString);
            return obj instanceof JSONObject;
        } catch (JSONException e) {
            return false;
        }
    }
    public static boolean isValidJsonArray(String jsonString) {
        try {
            Object obj = JSON.parse(jsonString);
            return obj instanceof JSONArray;
        } catch (JSONException e) {
            return false;
        }
    }
    public static void main(String[] args) {
        String jsonObjStr = "{\"key\":\"value\"}";
        String jsonArrayStr = "[1, 2, 3]";
        String invalidStr = "just a string";
        System.out.println("Is jsonObjStr valid JSON object? " + isValidJsonObject(jsonObjStr)); // true
        System.out.println("Is jsonArrayStr valid JSON object? " + isValidJsonObject(jsonArrayStr)); // false
        System.out.println("Is jsonArrayStr valid JSON array? " + isValidJsonArray(jsonArrayStr)); // true
        System.out.println("Is invalidStr valid JSON object? " + isValidJsonObject(invalidStr)); // false
    }
}

校验JSON文件或输入流

对于来自文件、网络请求等输入流形式的JSON数据，可以先将其读取为字符串，然后使用上述方法校验，Fastjson本身不直接提供输入流的校验API，但可以结合IOUtils（如Apache Commons IO）或Java NIO进行读取。

示例（读取文件并校验）：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONException;
import org.apache.commons.io.IOUtils;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
public class FastjsonJsonFileValidator {
    public static boolean isValidJsonFile(String filePath) {
        try (FileInputStream fis = new FileInputStream(filePath)) {
            String jsonString = IOUtils.toString(fis, StandardCharsets.UTF_8);
            return isValidJson(jsonString); // 调用之前定义的isValidJson方法
        } catch (IOException e) {
            e.printStackTrace();
            return false;
        }
    }
    public static boolean isValidJson(String jsonString) {
        if (jsonString == null || jsonString.trim().isEmpty()) {
            return false;
        }
        try {
            JSON.parse(jsonString);
            return true;
        } catch (JSONException e) {
            return false;
        }
    }
    public static void main(String[] args) {
        String validJsonFile = "valid.json";
        String invalidJsonFile = "invalid.json";
        // 假设valid.json内容为: {"name":"test"}
        // 假设invalid.json内容为: {"name":"test"
        System.out.println("Is valid.json valid? " + isValidJsonFile(validJsonFile)); // true
        System.out.println("Is invalid.json valid? " + isValidJsonFile(invalidJsonFile)); // false
    }
}

进阶校验：Schema校验（需结合其他库）

上述方法主要校验JSON格式的合法性（是否符合JSON语法），如果需要校验JSON数据是否符合特定的结构（必须有哪些字段，字段类型是什么等），则需要JSON Schema校验，Fastjson本身不提供JSON Schema校验功能，但可以结合其他库如everit-org/json-schema来实现。

基本思路：

1. 定义JSON Schema（一个描述JSON数据结构的JSON文件）。
2. 使用校验库加载Schema和待校验的JSON数据。
3. 执行校验,获取校验结果。

示例（概念性，需引入json-schema依赖）：

// 需要添加依赖: implementation 'org.everit.json:org.everit.json.schema:1.0.2'
// import org.everit.json.schema.Schema;
// import org.everit.json.schema.loader.SchemaLoader;
// import org.json.JSONObject;
// import org.json.JSONTokener;
public class JsonSchemaValidator {
    public static boolean validateWithSchema(String jsonString, String schemaString) {
        try {
            JSONObject jsonSubject = new JSONObject(new JSONTokener(jsonString));
            JSONObject schemaJson = new JSONObject(new JSONTokener(schemaString));
            Schema schema = SchemaLoader.load(schemaJson);
            schema.validate(jsonSubject); // 如果校验失败，会抛出ValidationException
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }
    // main方法示例略，需要提供具体的schema和json字符串
}

最佳实践与注意事项

1. 异常处理：使用try-catch捕获JSONException是核心，不要忽略异常,可以根据业务需求记录日志或进行其他处理。
2. 空值与空白字符串：在校验前，最好对输入字符串进行null和空字符串（或仅包含空白字符的字符串）检查,它们通常不是合法的JSON。
3. 性能考虑：对于高频调用的场景，反复解析字符串可能带来性能开销，如果只是需要校验格式而不需要使用解析后的对象，可以考虑使用更轻量级的JSON校验库（如Gson的JsonParser也能用于校验，或者专门的校验库），但对于大多数应用场景,Fastjson的性能已经足够。
4. 安全性：Fastjson在不同版本中存在过反序列化漏洞，虽然校验JSON格式本身不能完全解决安全问题，但确保输入是合法的JSON可以减少一部分风险,务必使用Fastjson的稳定版本，