クエリと取得関数

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 設定の詳細