辅助函数

json 包提供丰富的辅助函数，用于 JSON 比较、缓存管理和工具处理。

JSON 比较函数

CompareJSON

签名：func CompareJSON(json1, json2 string, cfg ...Config) (bool, error)

比较两个 JSON 字符串是否相等。处理数字精度差异和键顺序差异。

无 cfg 时行为与历史一致（不做安全验证，两侧均用 encoding/json 编组）。传入 cfg 时，对两个输入应用安全验证（大小/深度/危险模式限制），并使用配置中的编码进行对称比较。

// 键顺序不同但内容相同
equal, _ := json.CompareJSON(`{"a":1,"b":2}`, `{"b":2,"a":1}`)
fmt.Println(equal) // true

// 数字精度不同但值相同
equal, _ = json.CompareJSON(`{"num":1}`, `{"num":1.0}`)
fmt.Println(equal) // true

// 内容不同
equal, _ = json.CompareJSON(`{"a":1}`, `{"a":2}`)
fmt.Println(equal) // false

// 带配置（应用安全验证与编码控制）
equal, err = json.CompareJSON(a, b, json.SecurityConfig())

Processor 等价方法

Processor.CompareJSON 始终执行安全验证（按 cfg 或处理器自身配置），与包级函数的无 cfg 路径行为不同。详见 Processor 数据修改。

JSON 合并函数

MergeJSON

签名：func MergeJSON(json1, json2 string, cfg ...Config) (string, error)

合并两个 JSON 对象，支持通过 Config 配置合并模式。详见修改函数。

MergeMany

签名：func MergeMany(jsons []string, cfg ...Config) (string, error)

合并多个 JSON 对象。详见修改函数。

缓存和统计

ClearCache（包级函数）

签名：func ClearCache()

清除全局处理器的内部缓存。

json.ClearCache()

GetStats（包级函数）

签名：func GetStats() Stats

获取全局处理器的统计信息。

stats := json.GetStats()
fmt.Printf("缓存命中率：%.2f%%\n", stats.HitRatio * 100)
fmt.Printf("缓存大小：%d\n", stats.CacheSize)

GetHealthStatus（包级函数）

签名：func GetHealthStatus() HealthStatus

获取全局处理器的健康状态。

status := json.GetHealthStatus()
if status.Healthy {
    fmt.Println("处理器健康")
}

Processor.ClearCache

签名：func (p *Processor) ClearCache()

清除处理器的内部缓存。

p, err := json.New()
if err != nil {
    panic(err)
}
defer p.Close()

p.ClearCache()

Processor.GetStats

签名：func (p *Processor) GetStats() Stats

获取处理器的统计信息。

p, err := json.New()
if err != nil {
    panic(err)
}
defer p.Close()

stats := p.GetStats()
fmt.Printf("缓存命中率：%.2f%%\n", stats.HitRatio * 100)
fmt.Printf("缓存大小：%d\n", stats.CacheSize)

Processor.GetHealthStatus

签名：func (p *Processor) GetHealthStatus() HealthStatus

获取处理器的健康状态。

p, err := json.New()
if err != nil {
    panic(err)
}
defer p.Close()

status := p.GetHealthStatus()
if status.Healthy {
    fmt.Println("处理器健康")
}

WarmupCache

签名：func WarmupCache(jsonStr string, paths []string, cfg ...Config) (*WarmupResult, error)

预热缓存以提高后续操作性能。

data := `{"user": {"name": "Alice", "email": "[email protected]"}, "items": [{"id": 1}]}`
paths := []string{"user.name", "user.email", "items[*].id"}
result, err := json.WarmupCache(data, paths)
if err != nil {
    panic(err)
}
fmt.Printf("成功预热 %d 个路径\n", result.Successful)

全局处理器管理

全局处理器用于所有包级函数（如 Get、GetString 等）。

SetGlobalProcessor

签名：func SetGlobalProcessor(processor *Processor)

设置自定义全局处理器。

cfg := json.SecurityConfig()
p, err := json.New(cfg)
if err != nil {
    panic(err)
}

json.SetGlobalProcessor(p)

// 之后所有包级函数都使用这个处理器
val := json.GetString(data, "user.name")

ShutdownGlobalProcessor

签名：func ShutdownGlobalProcessor()

关闭全局处理器并释放资源。

package main

import (
    "github.com/cybergodev/json"
)

func main() {
    cfg := json.DefaultConfig()
    p, err := json.New(cfg)
    if err != nil {
        panic(err)
    }
    json.SetGlobalProcessor(p)

    defer json.ShutdownGlobalProcessor()

    // 应用逻辑...
}

输出函数

API 变更说明

Print、PrintPretty、PrintE、PrintPrettyE 已从库中移除，不再提供。请使用 EncodeWithConfig、EncodePretty 或 Prettify 配合 fmt.Println 代替（Encode 已废弃）。详见打印函数。

Buffer 兼容函数

说明

以下函数与 encoding/json 标准库完全兼容，同时通过 cfg 参数支持额外配置。

Compact

签名：func Compact(dst *bytes.Buffer, src []byte, cfg ...Config) error

将 JSON 压缩后写入 Buffer。100% 兼容 encoding/json.Compact。

var buf bytes.Buffer
err := json.Compact(&buf, []byte(`{"name": "test"}`))

Indent

签名：func Indent(dst *bytes.Buffer, src []byte, prefix, indent string, cfg ...Config) error

将 JSON 格式化后写入 Buffer。100% 兼容 encoding/json.Indent。

var buf bytes.Buffer
err := json.Indent(&buf, []byte(`{"name":"test"}`), "", "  ")

HTMLEscape

签名：func HTMLEscape(dst *bytes.Buffer, src []byte, cfg ...Config)

将 JSON 进行 HTML 转义后写入 Buffer。100% 兼容 encoding/json.HTMLEscape。

var buf bytes.Buffer
json.HTMLEscape(&buf, []byte(`{"html":"<script>alert(1)</script>"}`))

安全模式函数

Config.AddDangerousPattern

通过 Config 的 AddDangerousPattern 方法或 AdditionalDangerousPatterns 字段注册自定义危险模式。

cfg := json.DefaultConfig()
cfg.AddDangerousPattern(json.DangerousPattern{
    Pattern: "malicious_keyword",
    Name:    "自定义恶意关键字",
    Level:   json.PatternLevelCritical,
})
p, err := json.New(cfg)
if err != nil {
    panic(err)
}
defer p.Close()

也可以在创建 Config 后设置 AdditionalDangerousPatterns 字段：

cfg := json.DefaultConfig()
cfg.AdditionalDangerousPatterns = []json.DangerousPattern{
    {Pattern: "malicious_keyword", Name: "自定义恶意关键字", Level: json.PatternLevelCritical},
}
p, err := json.New(cfg)
if err != nil {
    panic(err)
}
defer p.Close()

DangerousPattern 结构体

字段	类型	说明
`Pattern`	`string`	要检测的子字符串
`Name`	`string`	人类可读的风险描述
`Level`	`PatternLevel`	严重级别

PatternLevel 级别

级别	说明
`PatternLevelCritical`	始终阻止操作
`PatternLevelWarning`	严格模式下阻止，宽松模式下记录警告
`PatternLevelInfo`	仅记录，永不阻止

错误处理函数

SafeError

签名：func SafeError(err error) string

返回客户端安全的错误消息，不包含内部详细信息。适合在 API 响应中使用。

val, err := json.Get(data, "user.name")
if err != nil {
    // 返回安全的错误消息（不含路径、内部状态等敏感信息）
    fmt.Println(json.SafeError(err))
}

RedactedPath

签名：func RedactedPath(path string) string

返回已编辑的路径，用于安全日志记录。隐藏路径中的敏感部分。

path := "users[0].ssn"
fmt.Println(json.RedactedPath(path)) // 输出：***（非空路径统一返回 ***，空路径返回空字符串）

AccessResult 类型转换方法

AccessResult 是 Processor.SafeGet() 和包级 SafeGet() 的返回类型，提供类型安全的转换方法。

AccessResult.AsString

签名：func (r AccessResult) AsString() (string, error)

安全转换为字符串类型。仅当值本身是字符串时成功。

result := json.SafeGet(data, "user.name")
name, err := result.AsString()
if err != nil {
    return
}
fmt.Println(name)

AccessResult.AsStringConverted

签名：func (r AccessResult) AsStringConverted() (string, error)

将任意值转换为字符串（使用 fmt.Sprintf 格式化）。

result := json.SafeGet(data, "user.age")
ageStr, err := result.AsStringConverted()
// "30" (字符串格式)

AccessResult.AsInt

签名：func (r AccessResult) AsInt() (int, error)

安全转换为整数。不支持 bool 到 int 的转换。

result := json.SafeGet(data, "user.age")
age, err := result.AsInt()

AccessResult.AsFloat64

签名：func (r AccessResult) AsFloat64() (float64, error)

安全转换为 float64。不支持 bool 到 float64 的转换。

result := json.SafeGet(data, "item.price")
price, err := result.AsFloat64()

AccessResult.AsBool

签名：func (r AccessResult) AsBool() (bool, error)

安全转换为布尔值。仅支持 bool 和 string 类型。

result := json.SafeGet(data, "feature.enabled")
enabled, err := result.AsBool()

辅助函数 ​

JSON 比较函数 ​

CompareJSON ​

JSON 合并函数 ​

MergeJSON ​

MergeMany ​

缓存和统计 ​

ClearCache（包级函数） ​

GetStats（包级函数） ​

GetHealthStatus（包级函数） ​

Processor.ClearCache ​

Processor.GetStats ​

Processor.GetHealthStatus ​

WarmupCache ​

全局处理器管理 ​

SetGlobalProcessor ​

ShutdownGlobalProcessor ​

输出函数 ​

Buffer 兼容函数 ​

Compact ​

Indent ​

HTMLEscape ​

安全模式函数 ​

Config.AddDangerousPattern ​

错误处理函数 ​

SafeError ​

RedactedPath ​

AccessResult 类型转换方法 ​

AccessResult.AsString ​

AccessResult.AsStringConverted ​

AccessResult.AsInt ​

AccessResult.AsFloat64 ​

AccessResult.AsBool ​

相关 ​