本文内容主要来自:https://darjun.github.io/2020/03/24/godailylib/sjson/ sjson 库 GitHub 地址:https://github.com/tidwall/sjson

sjson用来设置 JSON 串,和gjson是相对的:Go 第三方库 - gjson

快速上手

安装:

  1. $ go get github.com/tidwall/sjson

使用:

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/tidwall/sjson"
  5. )
  6. const json = `{"name":{"first":"li","last":"dj"},"age":18}`
  7. func main() {
  8. value, _ := sjson.Set(json, "name.last", "dajun")
  9. fmt.Println(value)
  10. }

上面代码通过sjson.Set()将 JSON 串中name.last对应的值设置为dajun
gjson一样,sjson也通过键路径指定具体的位置,键路径即为一系列以.分隔的键。sjson支持的键路径语法是gjson的一个子集,不能使用通配符和一些条件语法,具体键路径的语法可以参见gjson键路径
sjson.Set()返回设置之后的 JSON 串。

最终程序输出:

  1. {"name":{"first":"li","last":"dajun"},"age":18}

支持的类型

sjson支持的类型包括nil/bool/int/float/string等。如果传入sjson不支持的类型,sjson会调用json.Marshal,然后将生成的字符串设置到对应的键路径上:

  1. type User struct {
  2. Name string `json:"name"`
  3. Age int `json:"age"`
  4. }
  5. func main() {
  6. nilJSON, _ := sjson.Set("", "key", nil)
  7. fmt.Println(nilJSON)
  8. boolJSON, _ := sjson.Set("", "key", false)
  9. fmt.Println(boolJSON)
  10. intJSON, _ := sjson.Set("", "key", 1)
  11. fmt.Println(intJSON)
  12. floatJSON, _ := sjson.Set("", "key", 10.5)
  13. fmt.Println(floatJSON)
  14. strJSON, _ := sjson.Set("", "key", "hello")
  15. fmt.Println(strJSON)
  16. mapJSON, _ := sjson.Set("", "key", map[string]interface{}{"hello": "world"})
  17. fmt.Println(mapJSON)
  18. u := User{Name: "dj", Age: 18}
  19. structJSON, _ := sjson.Set("", "key", u)
  20. fmt.Println(structJSON)
  21. }

注意,我们传入一个空字符串,sjson.Set()会生成一个空对象,然后按照键路径依次设置值。

下面分析上述程序输出:

  • nil:在 JSON 中用null表示,输出{"key":null}
  • false:在 JSON 中布尔值用true/false表示,输出{"key":false}
  • 110.5:整数和浮点数在 JSON 中都用number表示,分别输出{"key":1}{"key":10.5}
  • hello:输出{"key":"hello"}
  • map[string]interface{}sjson并不原生支持map类型,故通过json.Marshal将其序列化为{"hello":"world"}再设置到键key上,输出{"key":{"hello":"world"}}
  • User对象:先通过json.Marshal序列化为{"name":"dj","age":18}再设置;

修改数组

修改数组可以通过在键路径后添加索引,有两种特殊情况:

  • 使用-1或数组长度为索引表示在数组后添加一个新元素;
  • 使用的索引超出数组的长度,会在数组中添加很多null值。

看下面示例:

  1. func main() {
  2. fruits := `{"fruits":["apple", "orange", "banana"]}`
  3. var newValue string
  4. newValue, _ = sjson.Set(fruits, "fruits.1", "grape")
  5. fmt.Println(newValue)
  6. newValue, _ = sjson.Set(fruits, "fruits.3", "pear")
  7. fmt.Println(newValue)
  8. newValue, _ = sjson.Set(fruits, "fruits.-1", "strawberry")
  9. fmt.Println(newValue)
  10. newValue, _ = sjson.Set(fruits, "fruits.5", "watermelon")
  11. fmt.Println(newValue)
  12. }
  • fruits.1:设置第二个水果为grape索引从 0 开始),输出{"fruits":["apple", "grape", "banana"]}
  • fruits.3:由于数组长度为 3,使用 3 表示在数组后添加一个元素,输出{"fruits":["apple","orange","banana","pear"]}
  • fruits.-1:使用-1同样表示在数组后添加一个元素,输出{"fruits":["apple", "orange", "banana","strawberry"]};
  • fruits.5:索引 5 已经大于数组长度 3 了,所以会多出两个null,输出{"fruits":["apple","orange","banana",null,null,"watermelon"]}

删除元素

删除元素需要调用sjson.Delete()方法,键路径语法相同。如果键路径对应的值不存在,则Delete()无效果:

  1. func main() {
  2. var newValue string
  3. user := `{"name":{"first":"li","last":"dj"},"age":18}`
  4. newValue, _ = sjson.Delete(user, "name.first")
  5. fmt.Println(newValue)
  6. newValue, _ = sjson.Delete(user, "name.full")
  7. fmt.Println(newValue)
  8. fruits := `{"fruits":["apple", "orange", "banana"]}`
  9. newValue, _ = sjson.Delete(fruits, "fruits.1")
  10. fmt.Println(newValue)
  11. newValue, _ = sjson.Delete(fruits, "fruits.-1")
  12. fmt.Println(newValue)
  13. newValue, _ = sjson.Delete(fruits, "fruits.5")
  14. fmt.Println(newValue)
  15. }
  • name.first:删除字段name.first,输出{"name":{"last":"dj"},"age":18}
  • name.full:由于字段name.full不存在,无效果,输出{"name":{"first":"li","last":"dj"},"age":18}
  • fruits.1:删除数组fruits的第二个元素,输出{"fruits":["apple", "banana"]}
  • fruits.-1:删除数组最后一个元素,输出{"fruits":["apple", "orange"]}
  • fruits.5:索引 5 超出数组长度 3,无效果,输出{"fruits":["apple", "orange", "banana"]}

错误处理

使用sjson出现的错误分为两种,一种是传入的 JSON 串不是合法的串,另一种是键路径语法错误。
Set()Delete()方法返回的第二个参数为错误,只有非法的键路径会返回错误,非法 JSON 串不会。

非法 JSON 串

gjson一样,sjson同样不会检查传入的 JSON 串的合法性,它假设传入的是合法的串。如果传入一个非法的 JSON 串,程序输出不确定的结果:

  1. func main() {
  2. user := `{"name":dj,age:18}`
  3. newValue, err := sjson.Set(user, "name", "dajun")
  4. fmt.Println(err, newValue)
  5. }

上面程序中,故意传入一个非法的 JSON 串(djage漏掉了双引号)。最终程序输出:

  1. <nil> {"name":dj,age:"dajun"}

age变为了dajun,显然不正确。然而此时返回的err = nil

非法键路径

gjson相比,sjson能使用的键路径语法比较有限,不能使用通配符和一些条件语法。如果传入的键路径非法,将返回非空的错误值:

  1. func main() {
  2. user := `{"name":"dj","age":18}`
  3. newValue, err := sjson.Set(user, "na?e", "dajun")
  4. fmt.Println(err, newValue)
  5. }

上面使用了通配符?,输出:

  1. wildcard characters not allowed in path