写点什么

PHP 转 Go 实践:xjson 解析神器「开源工具集」

作者:王中阳Go
  • 2023-01-28
    北京
  • 本文字数:1890 字

    阅读完需:约 6 分钟

PHP转Go实践:xjson解析神器「开源工具集」

前言

近期会更新一系列开源项目的文章,新的一年会和大家做更多的开源项目,也欢迎大家加入进来。

xutil

今天分享的文章源自于开源项目jinzaigo/xutil的封装。


在封装过程中,劲仔将实现原理以及相关实践思考,写成文章分享出来,从而汇总系列文章集合。

PHP 转 Go

我和劲仔都是 PHP 转 Go,身边越来越多做 PHP 的朋友也逐渐在用 Go 进行重构,重构过程中,会发现 php 的 json 解析操作(系列化与反序列化)是真的香,弱类型语言的各种隐式类型转换,很大程度的减低了程序的复杂度。


反观 go 使用标准库 encoding/json,来做 json 解析就没有那么愉快了(只要数据类型定义不对,就很容易抛 error)

JSON 解析实践

案例:用 go 重构的服务,对接的上游还是 php 服务,这时 php 接口输出的 json 串为{"name":"AppleWatchS8","price":"3199"}


其中 price 字段应该得为 float 类型,但由于 php 弱类型语言,没有强制约束输出类型的机制,就很容易出现这种输出类型不对的情况,然后到 go 服务里得怎么处理呢?

标准库 encoding/json

package main
import ( "encoding/json" "fmt")
type ProductInfo struct { Name string `json:"name"` Price float32 `json:"price"`}
func main() { str := "{"name":"AppleWatchS8","price":"3199"}" data := ProductInfo{} if err := json.Unmarshal([]byte(str), &data); err != nil { fmt.Println("error: " + err.Error()) } else { fmt.Println(data) }}
//输出结果//error: json: cannot unmarshal string into Go struct field ProductInfo.price of type float32
复制代码


显然,使用 go 标准库做 json 解析,是应对不了这种类型不一致的情况的。下面则借助第三方库的能力来做处理

第三方库 json-iterator

简单介绍:


执行速度:jsoniter 的 Golang 版本可以比标准库(encoding/json)快 6 倍之多


两个特点:


  1. 完全兼容标准库,也就是 API 用法完全一样,原有逻辑代码不需要改动,只需要替换 import 包名

  2. 提供了一个 PHP 兼容模式,可以自动转换字符串/数字弱类型问题,可以将空数组[]转换为空结构体(解决 PHP 中的 array 输出为[]的问题)。注意,该兼容模式需要手动开启


安装方式:


go get -u github.com/json-iterator/go
复制代码


具体代码实现:


package main
import ( "fmt" jsoniter "github.com/json-iterator/go" "github.com/json-iterator/go/extra")
var json = jsoniter.ConfigCompatibleWithStandardLibrary
func init() { extra.RegisterFuzzyDecoders() //开启PHP兼容模式}
type ProductInfo struct { Name string `json:"name"` Price float32 `json:"price"`}
func main() { str := "{"name":"AppleWatchS8","price":"3199"}" data := ProductInfo{} if err := json.Unmarshal([]byte(str), &data); err != nil { fmt.Println("error: " + err.Error()) } else { fmt.Println(data) }}
//输出结果//{AppleWatchS8 3199}
复制代码


看输出结果,会发现用了这个库并且开启了 PHP 兼容模式,json 中 price 字段 string 类型,就会自动转换为结构体中定义的 float32 类型。


这样我们在使用 price 字段处理业务逻辑时,就只需要按 float32 做处理就行,不用进行类型断言。这个库解决了 json 解析类型转换问题的同时,也能极大的提高我们开发效率。

收集到开源工具包 xutil 中

这个第三库用起来如此方便,那肯定是要收录进来的,将替换包名、手动开启 PHP 兼容模式、还有常用的 API 方法(系列化与反序列化操作),统一封装进来,简化使用流程。


同时,为了便于后续扩展更多的兼容模式,所以将代码都放在 xjson 目录下



以上这个思路也适用于大家封装自己内部使用的工具库。


使用示例:


go get -u github.com/jinzaigo/xutil之后,


import github.com/jinzaigo/xutil/xjson


即可通过 xjson.Unmarshal()等方法,进行 json 解析操作。


示例代码:


package main
import ( "fmt" "github.com/jinzaigo/xutil/xjson")
type ProductInfo struct { Name string `json:"name"` Price float32 `json:"price"`}
func main() { str := "{"name":"AppleWatchS8","price":"3199"}" data := ProductInfo{} if err := xjson.Unmarshal([]byte(str), &data); err != nil { fmt.Println("error: " + err.Error()) } else { fmt.Println(data) }}
复制代码

总结

业务系统从 php 转 go,或 go 对接 php 服务,都会遇到这个因为数据类型不一致导致 json 解析错误的共性问题。


使用第三方库 json-iterator 能很好的解决我们的痛点,并且比标准库执行速度还更快。


收录到开源项目中,更好的帮助到需要的朋友。


一起学习

欢迎使用、star 与 PR 共同建设:https://github.com/jinzaigo/xutil

发布于: 2023-01-28阅读数: 43
用户头像

王中阳Go

关注

靠敲代码在北京买房的程序员 2022-10-09 加入

【微信】wangzhongyang1993【公众号】程序员升职加薪之旅【成就】InfoQ专家博主👍掘金签约作者👍B站&掘金&CSDN&思否等全平台账号:王中阳Go

评论 (1 条评论)

发布
用户头像
近期会更新一系列开源项目的文章,新的一年会和大家做更多的开源项目,也欢迎大家加入进来。
2023-01-28 08:00 · 北京
回复
没有更多了
PHP转Go实践:xjson解析神器「开源工具集」_php_王中阳Go_InfoQ写作社区