Go语言实战案例-开发一个JSON格式校验工具

在日常开发中,经常会遇到需要校验 JSON 格式是否正确的场景:

  • • 前端调试接口返回数据时
  • • 配置文件是否符合 JSON 格式
  • • 接口 Mock 数据校验

如果 JSON 格式不正确,系统往往会报错甚至崩溃。因此开发一个 命令行 JSON 格式校验工具 非常实用。


一、程序目标

我们要实现一个命令行工具 jsoncheck,支持以下功能:

    1. 校验输入的字符串是否是合法 JSON
    1. 校验指定文件是否是合法 JSON
    1. (可选)格式化 JSON 输出

使用方式:

ini 复制代码
# 校验字符串
jsoncheck -str='{"name":"Go","version":1}'

# 校验文件
jsoncheck -file=config.json

# 校验并格式化
jsoncheck -file=config.json -pretty

二、实现思路

    1. 使用 flag 包解析命令行参数
    1. 如果输入是字符串,直接用 json.Unmarshal 校验
    1. 如果输入是文件,先读取文件内容再校验
    1. 如果传入 -pretty,就格式化输出 JSON

三、代码实现

main.go

go 复制代码
package main

import (
    "encoding/json"
    "flag"
    "fmt"
    "os"
)

func main() {
    // 定义命令行参数
    strInput := flag.String("str", "", "需要校验的 JSON 字符串")
    fileInput := flag.String("file", "", "需要校验的 JSON 文件路径")
    pretty := flag.Bool("pretty", false, "是否格式化输出 JSON")

    flag.Parse()

    var data []byte
    var err error

    // 优先处理字符串输入
    if *strInput != "" {
        data = []byte(*strInput)
    } else if *fileInput != "" {
        data, err = os.ReadFile(*fileInput)
        if err != nil {
            fmt.Println("❌ 读取文件失败:", err)
            return
        }
    } else {
        fmt.Println("用法: jsoncheck -str='{"key":"value"}' 或 -file=path.json [-pretty]")
        return
    }

    // 校验 JSON 格式
    var js interface{}
    if err := json.Unmarshal(data, &js); err != nil {
        fmt.Println("❌ JSON 格式错误:", err)
        return
    }

    fmt.Println("✅ JSON 格式正确")

    // 如果需要格式化输出
    if *pretty {
        formatted, _ := json.MarshalIndent(js, "", "  ")
        fmt.Println("格式化后的 JSON:")
        fmt.Println(string(formatted))
    }
}

四、运行效果

    1. 校验字符串
    css 复制代码
    go run main.go -str='{"name":"Go","version":1}'

    输出:

    javascript 复制代码
    ✅ JSON 格式正确
    1. 校验错误 JSON
    css 复制代码
    go run main.go -str='{"name":"Go",}'

    输出:

    typescript 复制代码
    ❌ JSON 格式错误: invalid character '}' looking for beginning of object key string
    1. 校验文件并格式化
    arduino 复制代码
    go run main.go -file=config.json -pretty

    输出:

    javascript 复制代码
    ✅ JSON 格式正确
    格式化后的 JSON:
    {
      "name": "Go",
      "version": 1
    }

五、总结

这个 JSON 格式校验工具小巧但实用,涵盖了:

  • 命令行参数解析(flag 包)
  • JSON 校验(json.Unmarshal)
  • 文件读取(os.ReadFile)
  • 格式化输出(json.MarshalIndent)

在实际项目中,你可以将它打包成二进制程序放到 PATH 下,随时用来校验 JSON 文件。


相关推荐
M1A110 小时前
小红书重磅升级!公众号文章一键导入,深度内容轻松入驻
后端
0wioiw011 小时前
Go基础(④指针)
开发语言·后端·golang
zhuyasen12 小时前
PerfTest: 压测工具界的“瑞士军刀”,原生支持HTTP/1/2/3、Websocket,同时支持实时监控
go·测试
李姆斯13 小时前
复盘上瘾症:到底什么时候该“复盘”,什么时候不需要“复盘”
前端·后端·团队管理
javachen__13 小时前
Spring Boot配置error日志发送至企业微信
spring boot·后端·企业微信
seabirdssss13 小时前
使用Spring Boot DevTools快速重启功能
java·spring boot·后端
OC溥哥99915 小时前
Flask论坛与个人中心页面开发教程完整详细版
后端·python·flask·html
迷知悟道17 小时前
java面向对象四大核心特征之抽象---超详细(保姆级)
java·后端
Aurora_NeAr17 小时前
对比Java学习Go——程序结构与变量
后端