C++/Qt json转结构体库-xpack
前言
最近项目中用了go + Qt的方式开发,go写后端,通过http/websocket/udp等方式传输数据。所有数据都是json结构。其实Qt也自带有json解析的库,但是对于我项目json数据结构比较多来说并不适用,因此在百度找了一个比较好用的库: xpack。使用了xpack效率提升了几倍,我在使用xpack最大的优势有两点: 1. 让我少写了许多json解析的代码;2. 通过简单的api就可以将json字符串转成结构体,也可以将结构体很方便的转成json字符串。
xpack项目地址
https://gitee.com/xyz347/xpack
https://github.com/xyz347/xpack
xpack介绍与使用
xpack
- 用于在C++结构体和json/xml之间互相转换, bson在xbson中支持。
- 只有头文件, 无需编译库文件,所以也没有Makefile。
- 具体可以参考example的例子
基本用法
- 结构体后面用XPACK宏包含各个变量,XPACK内还需要一个字母,不同字母的意义请参考FLAG
- 用xpack::json::encode把结构体转json
- 用xpack::json::decode把json转结构体
#include <iostream>
#include "xpack/json.h" // Json包含这个头文件,xml则包含xpack/xml.h
using namespace std;
struct User {
int id;
string name;
XPACK(O(id, name)); // 添加宏定义XPACK在结构体定义结尾
};
int main(int argc, char *argv[]) {
User u;
string data = "{\"id\":12345, \"name\":\"xpack\"}";
xpack::json::decode(data, u); // json转结构体
cout<<u.id<<';'<<u.name<<endl;
string json = xpack::json::encode(u); // 结构体转json
cout<<json<<endl;
return 0;
}
容器支持
目前支持下列容器(std)
- vector
- set
- list
- map<string, T>
- map<integer, T> // 仅JSON,XML不支持
- unordered_map<string, T> (需要C++11支持)
- shared_ptr (需要C++11支持)
FLAG
宏XPACK里面,需要用字母将变量包含起来,比如XPACK(O(a,b)),XPACK可以包含多个字母,每个字母可以包含多个变量。目前支持的字母有:
- X。格式是X(F(flag1, flag2...), member1, member2,...) F里面包含各种FLAG,目前支持的有:
- 0 没有任何FLAG
- OE omitempty,encode的时候,如果变量是0或者空字符串或者false,则不生成对应的key信息
- M mandatory,decode的时候,如果这个字段不存在,则抛出异常,用于一些id字段。
- ATTR attribute,xml encode的时候,把值放到attribute里面。
- O。等价于X(F(0), ...) 没有任何FLAG。
- M。等价于X(F(M),...) 表示这些字段是必须存在的。
- A。别名,A(member1, alias1, member2, alias2...),用于变量和key名不一样的情况
- AF。带FLAG的别名,AF(F(flag1, flag2,...), member1, alias1, member2, alias2...)
- B。位域,B(F(flag1, flag2, ...), member1, member2, ...) 位域不支持别名
- I。继承,I(baseclass1, baseclass2....),里面放父类
- E。枚举:
- 如果编译器支持C++11,不需要用E,枚举可以放X/O/M/A里面。
- 否则枚举只能放E里面,不支持别名
别名
- 用于变量名和key名不一致的场景
- 格式是A(变量,别名....)或者AF(F(flags), 变量,别名....),别名的格式是"x t:n"的格式
- x表示全局别名,t表示类型(目前支持json、xml、bson),n表示类型下的别名
- 全局别名可以没有,比如"json:_id"是合法的
- 类型别名可以没有,比如"_id"是合法的
- 有类型别名优先用类型别名,否则用全局别名,都没有,则用变量名
#include <iostream>
#include "xpack/json.h"
using namespace std;
struct Test {
long uid;
string name;
XPACK(A(uid, "id"), O(name)); // "uid"的别名是"id"
};
int main(int argc, char *argv[]) {
Test t;
string json="{\"id\":123, \"name\":\"Pony\"}";
xpack::json::decode(json, t);
cout<<t.uid<<endl;
return 0;
}
位域
- 使用"B"来包含位域变量,位域不支持别名
#include <iostream>
#include "xpack/json.h"
using namespace std;
struct Test {
short ver:8;
short len:8;
string name;
XPACK(B(F(0), ver, len), O(name));
};
int main(int argc, char *argv[]) {
Test t;
string json="{\"ver\":4, \"len\":20, \"name\":\"IPv4\"}";
xpack::json::decode(json, t);
cout<<t.ver<<endl;
cout<<t.len<<endl;
return 0;
}
继承
- 使用"I"来包含父类。需要用到父类的变量就包含,用不到可以不包含。
- 父类的父类也需要包含,比如class Base; class Base1:public Base; class Base2:public Base1;那么在Base2中需要I(Base1, Base)
- 父类也需要定义XPACK/XPACK_OUT宏。
#include <iostream>
#include "xpack/json.h"
using namespace std;
struct P1 {
string mail;
XPACK(O(mail));
};
struct P2 {
long version;
XPACK(O(version));
};
struct Test:public P1, public P2 {
long uid;
string name;
XPACK(I(P1, P2), O(uid, name));
};
int main(int argc, char *argv[]) {
Test t;
string json="{\"mail\":\"pony@xpack.com\", \"version\":2019, \"id\":123, \"name\":\"Pony\"}";
xpack::json::decode(json, t);
cout<<t.mail<<endl;
cout<<t.version<<endl;
return 0;
}
枚举
- 如果编译器支持C++11,则枚举和普通变量名一样,放X/O/M/A里面皆可。
- 否则需要放到E里面,格式是E(F(...), member1, member2, ...)
#include <iostream>
#include "xpack/json.h"
using namespace std;
enum Enum {
X = 0,
Y = 1,
Z = 2,
};
struct Test {
string name;
Enum e;
XPACK(O(name), E(F(0), e));
};
int main(int argc, char *argv[]) {
Test t;
string json="{\"name\":\"IPv4\", \"e\":1}";
xpack::json::decode(json, t);
cout<<t.name<<endl;
cout<<t.e<<endl;
return 0;
}
自定义编解码
应用场景:部分类型可能不想按结构体变量逐个编码,比如定义了一个时间结构体:
struct Time {
long ts; //unix timestamp
};
并不希望编码成{"ts":1218196800} 这种格式,而是希望编码成"2008-08-08 20:00:00"这种格式,这个时候就可以用自定义编解码实现。
- 可以参考例子
支持新类型
- 可以用自定义编解码的机制来支持新类型,下面的例子是支持CString的方法
namespace xpack { // must define in namespace xpack
template<>
struct is_xpack_xtype<CString> {static bool const value = true;};
// implement decode
template<class OBJ>
bool xpack_xtype_decode(OBJ &obj, const char*key, CString &val, const Extend *ext) {
std::string str;
obj.decode(key, str, ext);
if (str.empty()) {
return false;
}
// TODO 把str转到val里面去
return true;
}
// implement encode
template<class OBJ>
bool xpack_xtype_encode(OBJ &obj, const char*key, const CString &val, const Extend *ext) {
std::string str;
// TODO 把val转到str里面去
return obj.encode(key, str, ext);
}
}
char数组
- 缺省是不支持char数组的
- 修改config.h,开启XPACK_SUPPORT_CHAR_ARRAY这个宏即可。也可以直接在编译选项加上这个定义。
- 除了char,其他类型不支持数组
#include <iostream>
#include "xpack/json.h"
using namespace std;
struct Test {
char name[64];
char email[64];
XPACK(O(name, email));
};
int main(int argc, char *argv[]) {
Test t;
string json="{\"name\":\"Pony\", \"email\":\"pony@xpack.com\"}";
xpack::json::decode(json, t);
cout<<t.name<<endl;
cout<<t.email<<endl;
return 0;
}
不定类型
- 用于json的schema不确定的场景
- 用xpack::JsonData来接收这些信息
- 可以参考例子
- xpack::JsonData主要的方法有:
- Type。用于获取类型
- IsXXX系列函数。用于判断是否是某种类型,基本等价于return Type()==xxxx;
- GetXXX系列函数。用来提取值。
- 重载bool。用来判断是否是一个合法的JsonData。
- Size。用于数组类型判断元素的个数
operator [](size_t index)
用来取数组的第index个元素(从0开始)operator [](const char *key)
用来根据key取Object类型的元素- Begin。用来遍历Object的元素,取第一个。
- Next。配合Begin使用,获取下一个元素。
- Key。配置Begin和Next使用,遍历的时候获取Key
第三方类和结构体
- 用XPACK_OUT而非XPACK来包含变量
- XPACK_OUT必须定义在全局命名空间
#include <sys/time.h>
#include <iostream>
#include "xpack/json.h"
using namespace std;
/*
struct timeval {
time_t tv_sec;
suseconds_t tv_usec;
};
*/
// timeval is thirdparty struct
XPACK_OUT(timeval, O(tv_sec, tv_usec));
struct T {
int a;
string b;
timeval t;
XPACK(O(a, b, t));
};
int main(int argc, char *argv[]) {
T t;
T r;
t.a = 123;
t.b = "xpack";
t.t.tv_sec = 888;
t.t.tv_usec = 999;
string s = xpack::json::encode(t);
cout<<s<<endl;
xpack::json::decode(s, r);
cout<<r.a<<','<<r.b<<','<<r.t.tv_sec<<','<<r.t.tv_usec<<endl;
return 0;
}
格式化缩进
- encode缺省生成的json/xml是没有缩进的,适合程序使用,如果让人读,可以进行缩进。
- encode的最后两个参数控制
- indentCount 表示缩进的字符数,<0表示不缩进,0则是换行但是不缩进
- indentChar 表示缩进的字符,用空格或者制表符
XML数组
- 数组默认会用"x"作为标签,比如"ids":[1,2,3],对应的xml是:
<ids>
<x>1</x>
<x>2</x>
<x>3</x>
</ids>
- 可以用别名的方式来控制数组的标签,比如A(ids,"xml:ids,vl@id"),vl后面跟着一个@xx,xx就是数组的标签,生成的结果就是:
<ids>
<id>1</id>
<id>2</id>
<id>3</id>
</ids>
Qt支持
- 修改config.h,开启XPACK_SUPPORT_QT这个宏(或者在编译选项开启)
- 当前支持 QString/QMap/QList/QVector
重要说明
版权声明:
作者:小何
链接:https://ligo100.cn/houduanjishu/qt/91.html
来源:小何博客
文章版权归作者所有,未经允许请勿转载。

小何
想请教一下,如果我要把一个map,转换成json这个T是我自定义的类,应该怎么搞?我这样子的就会报错
小何@11
下面是我开发中使用的,可以参考
computers;
QMap
QString createdAt; // 实体创建时间
....
XPACK(O(computers,content,createdAt,creatorSid,deletedAt,
清水
博主,您好,结构体当中嵌套结构体这种用XPACK应该怎么转json啊