如何自己写json工具

如何自己写一个JSON工具：从零开始构建高效数据处理利器

JSON（JavaScript Object Notation）作为轻量级的数据交换格式，已成为前后端通信、配置文件存储、API响应等场景的“通用语言”，从简单的键值对到复杂的多层嵌套结构，JSON的灵活性和可读性让它无处不在，在日常开发中，我们常常遇到需要批量处理JSON数据、验证格式、生成结构或转换类型的需求——一个定制化的JSON工具能大幅提升效率。

本文将带你从零开始，手写一个轻量级JSON工具，涵盖核心功能设计、关键技术实现、代码示例及扩展方向，让你不仅理解工具背后的原理,更能自主构建数据处理利器的方法。

明确工具需求：你的JSON工具需要解决什么问题？

在动手编码前，先清晰定义工具的核心功能，根据常见使用场景，一个实用的JSON工具至少应包含以下功能（可按需扩展）：

JSON格式化与美化

将混乱的JSON字符串（如无缩进、单行）转换为格式化的输出（带缩进、换行），提升可读性。

输入: {"name":"Alice","age":25,"city":"New York"}  
输出: 
{
  "name": "Alice",
  "age": 25,
  "city": "New York"
}

JSON压缩与最小化

与格式化相反，移除JSON中的所有空白字符（空格、换行、缩进），减少数据体积，适用于网络传输或存储优化。

JSON Schema验证

根据预定义的JSON Schema（数据结构规范），验证目标JSON是否符合要求（如字段类型、必填项、枚举值等），确保数据规范性。

JSON路径查询

类似XPath对XML的操作，支持通过路径表达式（如$.store.book[0].author）从复杂嵌套JSON中提取特定数据，简化数据解析。

JSON转其他格式

将JSON转换为CSV、XML、YAML等常见格式，满足不同系统的数据需求；反之亦然（如CSV转JSON）。

技术选型：用什么语言实现？

选择开发语言时，需考虑JSON原生支持、解析性能、生态丰富度等因素，以下是主流语言的对比：

推荐选择：若追求快速开发，Python是首选；若需高性能或跨平台，Go/Java更合适，本文以Python为例，展示核心功能的实现逻辑（其他语言思路类似）。

核心功能实现：从0到1构建JSON工具

我们将基于Python，逐步实现“格式化”“压缩”“Schema验证”三大核心功能,最后整合为命令行工具。

JSON格式化与美化

Python标准库json提供了json.dumps()方法，支持通过indent参数控制缩进，即可实现格式化。

import json
def format_json(json_str: str, indent: int = 2) -> str:
    """格式化JSON字符串"""
    try:
        json_obj = json.loads(json_str)  # 解析JSON为Python对象
        return json.dumps(json_obj, indent=indent, ensure_ascii=False)
    except json.JSONDecodeError as e:
        raise ValueError(f"无效的JSON格式: {e}")
# 示例
raw_json = '{"name":"Alice","age":25,"city":"New York"}'
formatted = format_json(raw_json)
print(formatted)

关键点：

• json.loads()将JSON字符串转为Python字典/列表；
• json.dumps()将Python对象转回JSON字符串，indent控制缩进量，ensure_ascii=False支持非ASCII字符（如中文）。

JSON压缩与最小化

只需将indent设为None，并移除所有空白字符即可：

def minify_json(json_str: str) -> str:
    """压缩JSON字符串（移除所有空白字符）"""
    try:
        json_obj = json.loads(json_str)
        return json.dumps(json_obj, indent=None, separators=(',', ':'), ensure_ascii=False)
    except json.JSONDecodeError as e:
        raise ValueError(f"无效的JSON格式: {e}")
# 示例
minified = minify_json(raw_json)
print(minified)  # 输出: {"name":"Alice","age":25,"city":"New York"}

关键点：separators=(',', ':')会移除键值对间的空格和逗号后的空格，进一步压缩体积。

JSON Schema验证

JSON Schema是一种用于描述JSON数据结构的规范，可通过第三方库jsonschema实现验证。

安装依赖：

pip install jsonschema

实现代码：

from jsonschema import validate, ValidationError
def validate_json_schema(json_str: str, schema: dict) -> bool:
    """根据JSON Schema验证JSON字符串"""
    try:
        json_obj = json.loads(json_str)
        validate(instance=json_obj, schema=schema)
        return True
    except json.JSONDecodeError as e:
        raise ValueError(f"无效的JSON格式: {e}")
    except ValidationError as e:
        raise ValueError(f"Schema验证失败: {e.message}")
# 示例：定义Schema并验证
json_data = '{"name":"Alice","age":25,"city":"New York"}'
schema = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "age": {"type": "integer", "minimum": 0},
        "city": {"type": "string"}
    },
    "required": ["name", "age"]
}
try:
    is_valid = validate_json_schema(json_data, schema)
    print("验证通过" if is_valid else "验证失败")
except ValueError as e:
    print(e)

关键点：

• Schema定义了数据类型（如"type": "string"）、约束（如"minimum": 0）和必填字段（"required"）；
• validate()方法会检查JSON数据是否符合Schema，不符合则抛出ValidationError。

整合为命令行工具

使用Python的argparse库，将上述功能封装为命令行工具，支持通过参数选择操作。

import argparse
import json
from jsonschema import validate, ValidationError
def format_json(json_str: str, indent: int = 2) -> str:
    try:
        json_obj = json.loads(json_str)
        return json.dumps(json_obj, indent=indent, ensure_ascii=False)
    except json.JSONDecodeError as e:
        raise ValueError(f"无效的JSON格式: {e}")
def minify_json(json_str: str) -> str:
    try:
        json_obj = json.loads(json_str)
        return json.dumps(json_obj, indent=None, separators=(',', ':'), ensure_ascii=False)
    except json.JSONDecodeError as e:
        raise ValueError(f"无效的JSON格式: {e}")
def validate_json_schema(json_str: str, schema: dict) -> bool:
    try:
        json_obj = json.loads(json_str)
        validate(instance=json_obj, schema=schema)
        return True
    except json.JSONDecodeError as e:
        raise ValueError(f"无效的JSON格式: {e}")
    except ValidationError as e:
        raise ValueError(f"Schema验证失败: {e.message}")
def main():
    parser = argparse.ArgumentParser(description="JSON工具：格式化、压缩、验证")
    subparsers = parser.add_subparsers(dest="command", help="子命令")
    # 格式化命令
    format_parser = subparsers.add_parser("format", help="格式化JSON")
    format_parser.add_argument("input", help="输入JSON字符串或文件路径")
    format_parser.add_argument("--indent", type=int, default=2, help="缩进空格数")
    # 压缩命令
    minify_parser = subparsers.add_parser("minify", help="压缩JSON")
    minify_parser.add_argument("input", help="输入JSON字符串或文件路径")
    # 验证命令
    validate_parser = subparsers.add_parser("validate", help="Schema验证JSON")
    validate_parser.add_argument("input", help="输入JSON字符串或文件路径")
    validate_parser.add_argument("--schema", required=True, help="JSON Schema文件路径