searcher

简体中文

Searcher

Searcher is a go package providing simple field access from json document. The interface of this module will be as simple and easy to use as possible

Getting start

Installing

$ go get github.com/markity/searcher

Usage

Given json data here

var jsonString = `
{
  "name":"Markity",
  "age":"16",
  "friends":[
    {
      "name":"Jack",
      "age":17
    },
    {
      "name":"Mary",
      "age":18,
      "email":"3402002560@qq.com"
    }
  ],
  "details":{
    "interests":["golang","python"]
  }
}
`

New a searcher with json data

import "github.com/markity/searcher"

// The error is not nil when the json data is invalid
s, err := searcher.New([]byte(jsonString))
if err != nil {
	fmt.Printf("invalid json data: %v", err)
	return
}

Get a value

// Get a field. The args' type must be int or string
result := s.Query("friends", 0, "name")

// You can check if the filed exists
if !result.Exists() {
    fmt.Println("the result does not exist")
    return
}

// You can check the type of the field. The types contain TypeNumber, TypeBool, TypeString, TypeArray, TypeObject and TypeNull
if result.Type != searcher.TypeString {
    fmt.Println("wrong type of the field")
    return
}

// You can get the value of the field by using GetXXX function(GetInt64, GetUint64, GetFloat64, GetBool, GetString, GetObject, GetArray, GetValue)
// Before getting a value, it's necessary to judge it's type(using wrong "Get function" would cause the program panic)
// For emample, if the result.Type is TypeNumber, you can use GetInt64, GetUint64 and GetFloat64
fmt.Printf("My first friend's name is %s\n", result.GetString())

Change logs

Version: v0.1.1
Data: 2020/2/1
Content:
  Fixed the bug of array length judgment
  More testing

Version: v0.1
Data: 2020/2/1
Content:
  Perfect module function