查询与获取函数

json 包提供的查询和获取函数，支持路径表达式、类型安全获取和批量操作。

路径查询函数

Get

签名：func Get(jsonStr, path string, cfg ...Config) (any, error)

按路径获取任意类型的值。

参数

名称	类型	必需	说明
jsonStr	string	是	JSON 字符串
path	string	是	路径表达式
cfg	Config	否	可选配置

示例

package main

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

func main() {
    val, err := json.Get(`{"items":[{"name":"test"}]}`, "items[0].name")
    if err != nil {
        panic(err)
    }
    fmt.Println(val) // 输出：test
}

GetWithContext

签名：func GetWithContext(ctx context.Context, jsonStr, path string, cfg ...Config) (any, error)

带上下文的路径获取。支持超时和取消操作。Get 的上下文感知版本。

注意

Context 在操作前后检查，不在解析/导航过程中检查。对于大型 JSON 文档，操作期间可能不会响应取消。

package main

import (
    "context"
    "fmt"
    "time"
    "github.com/cybergodev/json"
)

func main() {
    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()

    val, err := json.GetWithContext(ctx, `{"user":{"name":"Alice"}}`, "user.name")
    if err != nil {
        panic(err)
    }
    fmt.Println(val) // 输出：Alice
}

类型安全获取函数

类型安全获取函数通过 defaultValue 可变参数提供零值回退。当路径不存在、值为 null 或类型转换失败时返回 defaultValue（未提供则返回对应类型的零值）。

GetString

签名：func GetString(jsonStr, path string, defaultValue ...string) string

按路径获取字符串值。

package main

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

func main() {
    jsonStr := `{"user": {"name": "CyberGo"}}`

    name := json.GetString(jsonStr, "user.name")
    fmt.Println(name) // 输出：CyberGo

    // 不存在的路径返回零值（空字符串）或自定义默认值
    nickname := json.GetString(jsonStr, "user.nickname", "未知")
    fmt.Println(nickname) // 输出：未知
}

GetInt

签名：func GetInt(jsonStr, path string, defaultValue ...int) int

按路径获取整数值。

package main

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

func main() {
    jsonStr := `{"pagination": {"count": 42}, "timeout": 30}`

    count := json.GetInt(jsonStr, "pagination.count")
    fmt.Println(count) // 输出：42

    timeout := json.GetInt(jsonStr, "timeout")
    fmt.Println(timeout) // 输出：30

    // 不存在的路径返回自定义默认值
    page := json.GetInt(jsonStr, "pagination.page", 1)
    fmt.Println(page) // 输出：1
}

GetFloat

签名：func GetFloat(jsonStr, path string, defaultValue ...float64) float64

按路径获取浮点数值。

package main

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

func main() {
    jsonStr := `{"item": {"price": 19.99}, "rate": 0.85}`

    price := json.GetFloat(jsonStr, "item.price")
    fmt.Println(price) // 输出：19.99

    rate := json.GetFloat(jsonStr, "rate")
    fmt.Println(rate) // 输出：0.85

    // 不存在的路径返回自定义默认值
    discount := json.GetFloat(jsonStr, "item.discount", 0.0)
    fmt.Println(discount) // 输出：0
}

GetBool

签名：func GetBool(jsonStr, path string, defaultValue ...bool) bool

按路径获取布尔值。

package main

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

func main() {
    jsonStr := `{"feature": {"enabled": true}, "debug": false}`

    enabled := json.GetBool(jsonStr, "feature.enabled")
    fmt.Println(enabled) // 输出：true

    debug := json.GetBool(jsonStr, "debug")
    fmt.Println(debug) // 输出：false

    // 不存在的路径返回自定义默认值
    verbose := json.GetBool(jsonStr, "feature.verbose", false)
    fmt.Println(verbose) // 输出：false
}

GetArray

签名：func GetArray(jsonStr, path string, defaultValue ...[]any) []any

按路径获取数组。

package main

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

func main() {
    jsonStr := `{"items": ["apple", "banana", "cherry"]}`

    items := json.GetArray(jsonStr, "items")
    for i, item := range items {
        fmt.Printf("[%d] %v\n", i, item)
    }

    // 不存在的路径返回自定义默认值
    empty := json.GetArray(jsonStr, "tags", []any{"default"})
    fmt.Println(empty) // 输出：[default]
}

GetObject

签名：func GetObject(jsonStr, path string, defaultValue ...map[string]any) map[string]any

按路径获取对象。

package main

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

func main() {
    jsonStr := `{"user": {"profile": {"name": "CyberGo", "level": 5}}}`

    profile := json.GetObject(jsonStr, "user.profile")
    fmt.Println(profile) // map[level:5 name:CyberGo]

    // 不存在的路径返回自定义默认值
    settings := json.GetObject(jsonStr, "user.settings", map[string]any{"theme": "dark"})
    fmt.Println(settings) // 输出：map[theme:dark]
}

泛型获取函数

GetTyped[T]

签名：func GetTyped[T any](jsonStr, path string, defaultValue ...T) T

泛型获取函数，支持自定义类型。当路径不存在、值为 null 或类型转换失败时返回 defaultValue（未提供则返回 T 的零值）。

命名约定说明：GetTyped[T] 等同于 GetAs[T] 语义，表示将 JSON 值获取并转换为指定类型 T。

package main

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

type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

func main() {
    jsonStr := `{"user": {"name": "CyberGo", "age": 30}}`

    // 获取类型化结构体
    user := json.GetTyped[User](jsonStr, "user")
    fmt.Printf("Name: %s, Age: %d\n", user.Name, user.Age)

    // 内置类型示例
    name := json.GetTyped[string](jsonStr, "user.name")
    fmt.Println(name) // 输出：CyberGo

    age := json.GetTyped[int](jsonStr, "user.age")
    fmt.Println(age) // 输出：30

    // 不存在的路径返回自定义默认值
    email := json.GetTyped[string](jsonStr, "user.email", "[email protected]")
    fmt.Println(email) // 输出：[email protected]
}

安全获取函数

SafeGet（包级函数）

签名：func SafeGet(jsonStr, path string, cfg ...Config) AccessResult

执行类型安全的获取操作，返回 AccessResult，提供类型转换方法（AsString, AsInt, AsFloat64, AsBool）。

package main

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

func main() {
    jsonStr := `{"user": {"name": "CyberGo", "age": 30}}`

    result := json.SafeGet(jsonStr, "user.age")
    if result.Exists {
        age, _ := result.AsInt()
        fmt.Println(age) // 输出：30
    }

    nameResult := json.SafeGet(jsonStr, "user.name")
    name, _ := nameResult.AsString()
    fmt.Println(name) // 输出：CyberGo
}

SafeGet（Processor 方法）

签名：func (p *Processor) SafeGet(jsonStr, path string, cfg ...Config) AccessResult

通过 Processor 实例执行类型安全的获取操作。

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

jsonStr := `{"user": {"name": "CyberGo", "age": 30}}`

result := p.SafeGet(jsonStr, "user.age")
if result.Exists {
    age, _ := result.AsInt()
    fmt.Println(age) // 输出：30
}

Processor 扩展方法

以下方法同时作为包级函数和 Processor 方法提供。

GetMultiple（包级函数）

签名：func GetMultiple(jsonStr string, paths []string, cfg ...Config) (map[string]any, error)

批量获取多个路径的值（包级函数，无需创建 Processor）。

jsonStr := `{"user": {"name": "CyberGo", "age": 30, "email": "[email protected]"}}`

paths := []string{"user.name", "user.age", "user.email"}
values, err := json.GetMultiple(jsonStr, paths)
if err != nil {
    panic(err)
}
fmt.Println(values["user.name"]) // 输出：CyberGo

Processor.GetMultiple

签名：func (p *Processor) GetMultiple(jsonStr string, paths []string, cfg ...Config) (map[string]any, error)

批量获取多个路径的值。

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

jsonStr := `{"user": {"name": "CyberGo", "age": 30, "email": "[email protected]"}}`

paths := []string{"user.name", "user.age", "user.email"}
values, err := p.GetMultiple(jsonStr, paths)
if err != nil {
    panic(err)
}
fmt.Println(values["user.name"]) // 输出：CyberGo

相关类型

AccessResult

SafeGet 使用的 AccessResult 结构体字段：

字段	类型	说明
Value	any	获取到的值
Exists	bool	路径是否存在
Type	string	检测到的值类型

方法：Ok() · Unwrap() · UnwrapOr() · AsString() · AsStringConverted() · AsInt() · AsFloat64() · AsBool()

详见 AccessResult 类型。

Result[T]

Result[T] 泛型结构体字段：

字段	类型	说明
Value	T	获取到的值
Exists	bool	值是否被找到
Error	error	错误信息

相关

• 解析与验证函数 - Parse, Valid, ValidateSchema 等解析与验证操作
• 批量操作函数 - ProcessBatch 批量处理
• 修改函数 - Set, Delete 等修改操作
• 编码输出 - Marshal, Unmarshal 等序列化操作
• 辅助函数 - CompareJSON, MergeJSON 等工具函数
• 配置选项 - Config 配置详解