Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noear/snack3
High-performance Jsonpath framework
https://github.com/noear/snack3
java json jsonpath serialization
Last synced: about 9 hours ago
JSON representation
High-performance Jsonpath framework
- Host: GitHub
- URL: https://github.com/noear/snack3
- Owner: noear
- License: apache-2.0
- Created: 2019-02-12T10:03:49.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T02:27:17.000Z (13 days ago)
- Last Synced: 2024-12-24T20:06:01.782Z (7 days ago)
- Topics: java, json, jsonpath, serialization
- Language: Java
- Homepage:
- Size: 1.25 MB
- Stars: 133
- Watchers: 6
- Forks: 25
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Snack3 for java
一个高性能的 JsonPath 框架
基于jdk8，80kb。支持：序列化反序列化、解析和转换、构建、查找、Json path 查询。
```xml
org.noear
snack3
3.2.123
```
Snack3 借鉴了 `Javascript` 所有变量由 `var` 申明，及 `Xml dom` 一切都是 `Node` 的设计。其下一切数据都以`ONode`表示，`ONode`也即 `One node` 之意，代表任何类型，也可以转换为任何类型。
* 强调文档树的操控和构建能力
* 高性能`Json path`查询（兼容性和性能很赞；暂不支持多条件）
* 顺带支持`序列化、反序列化`
* 基于 无参构造函数 + 字段 操作实现（因注入而触发动作的风险，不会有）
## 性能测试
每个表达式，跑 1_000_000 次的时间：
| Json path 表达式 | 数据 | fastjson2 | jayway.jsonpath | snack3 |
|-------------------------------------| --- |------------| --- | -- |
| `$..a` | A | 764ms | 2633ms | 225ms |
| `$..*` | A | (不兼容1) | 3220ms | 315ms |
| `$.data.list[1,4]` | A | 524ms | 782ms | 133ms |
| `$.data.list[1:4]` | A | 367ms | 941ms | 145ms |
| `$.data.ary2[1].a` | A | 329ms | 663ms | 84ms |
| `$.data.ary2[*].b.c` | A | 642ms | 1050ms | 237ms |
| `$..b[?(@.c == 12)]` | B | (不兼容2) | 5636ms | 535ms |
| `$..c.min()` | B | (不兼容2) | (不兼容2) | 282ms |
| `$[?(@.c =~ /a+/)]` | C | (不兼容2) | 3591ms | 429ms |
| `$..ary2[0].a` | A | 735ms | 2551ms | 311ms |
| `$.data.list[?(@ in $..ary2[0].a)]` | A | (不兼容2) | 5483ms | 674ms |
具体可见：
* [文章_JsonPath_性能测试.md](文章_JsonPath_性能测试.md)
* [文章_JsonPath_性能测试之2022.md](文章_JsonPath_性能测试之2022.md)
## 放几个示例
```java
//demo0::字符串化
String json = ONode.stringify(user);
//美化格式的字符串化
String json = ONode.load(user, Feature.PrettyFormat).toJson();
//demo1::序列化
// -- 输出带@type
String json = ONode.serialize(user);
//demo2::反序列化
// -- json 有已带@type
UserModel user = ONode.deserialize(json);
// -- json 可以不带@type (clz 申明了)
UserModel user = ONode.deserialize(json, UserModel.class);
// -- json 可以不带@type，泛型方式输出（类型是已知的）
List list = ONode.deserialize(json, (new ArrayList(){}).getClass());
// -- 或者
List list = ONode.deserialize(json, (new TypeRef>(){}).getType());
//demo3::转为ONode
ONode o = ONode.loadStr(json); //将json String 转为 ONode
ONode o = ONode.loadObj(user); //将java Object 转为 ONode
//demo3.1::转为ONode，取子节点进行序列化
ONode o = ONode.loadStr(json);
UserModel user = o.get("user").toObject(UserModel.class);
//demo4:构建json数据(极光推送的rest api调用)
ONode data = new ONode();
data.set("platform","val");
data.getOrNew("audience").getOrNew("alias").addAll(alias_ary);
data.getOrNew("options").set("apns_production", false);
String message = data.toJson();
//或者....用 build 表达式单行构建
public static void push(Collection alias_ary, String text) {
ONode data = new ONode().build((d)->{
d.set("platform", "all");
d.getOrNew("audience").getOrNew("alias").addAll(alias_ary);
d.getOrNew("options")
.set("apns_production",false);
d.getOrNew("notification").build(n->{
n.getOrNew("ios")
.set("alert",text)
.set("badge",0)
.set("sound","happy");
});
});
String message = data.toJson();
String author = Base64Util.encode(appKey+":"+masterSecret);
Map headers = new HashMap<>();
headers.put("Content-Type","application/json");
headers.put("Authorization","Basic "+author);
HttpUtil.postString(apiUrl, message, headers);
}
//demo5:取值
o.get("name").getString();
o.get("num").getInt();
o.get("list").get(0).get("lev").getInt();
//demo5.1::取值并转换
UserModel user = o.get("user").toObject(UserModel.class); //取user节点，并转为UserModel
//demo5.2::取值或新建并填充
o.getOrNew("list2").fill("[1,2,3,4,5,5,6]");
//demo6::json path //不确定返回数量的，者会返回array类型
//找到所有的187开头的手机号，改为186，最后输出修改后的json
o.select("$..mobile[?(@ =~ /^187/)]").forEach(n->n.val("186")).toJson();
//找到data.list[1]下的的mobile字段，并转为long
o.select("$.data.list[1].mobile").getLong();
//如果没有则创建，并赋值
o.selectOrNew("$.test.list[2]").val(12);
//查找所有手机号，并转为List
List list = o.select("$..mobile").toObject(List.class);
//查询data.list下的所有mobile，并转为List
List list = o.select("$.data.list[*].mobile").toObject(List.class);
//找到187手机号的用户，并输出List
List list = o.select("$.data.list[?(@.mobile =~ /^187/)]")
.toObjectList(UserModel.class);
//或
List list = o.select("$.data.list[?(@.mobile =~ /^187/)]")
.toObjectList(UserModel.class);
//demo7:遍历
//如果是个Object
o.forEach((k,v)->{
//...
});
//如果是个Array
o.forEach((v)->{
//...
});
```
#### 路径树接口
```java
ONode o = ONode.loadStr(json).usePaths(); //会为每个子节点，生成 path 属性
ONode rst = o.select("$.data.list[*].mobile");
List rstPaths = rst.pathList(); //获取结果节点的路径列表
for(ONode n1 : rst.ary()) {
n1.path(); //当前路径
n1.parent(); //父级节点
}
ONode rst = o.get("data").get("list").get(2);
rst.path();
rst.parent();
```
#### 高级定制
```java
Options options = Options.def();
//添加编码器
options.addEncoder(Date.class, (data, node) -> {
node.val().setString(DateUtil.format(data, "yyyy-MM-dd"));
});
//添加解码器
options.addDecoder(Date.class, ...);
//添加特性
options.add(Feature.PrettyFormat);
//移除特性
options.remove(Feature.PrettyFormat);
//设置日期格式附
options.add(Feature.WriteDateUseFormat); //使用日期格式
options.setDateFormat("yyyy-MM");
//..
String json = ONode.loadObj(orderModel, options).toJson();
```
## 关于序列化的特点
#### 对象（可以带type）
```json
{"a":1,"b":"2"}
//或
{"@type":"...","a":1,"b":"2"}
```
#### 数组
```json
[1,2,3]
//或
[{"@type":"...","a":1,"b":"2"},{"@type":"...","a":2,"b":"10"}]
```
#### 注解定制
```java
public enum BookType {
NOVEL(2,"小说"),
CLASSICS(3,"名著"),
;
@ONodeAttr public final int code; //使用 code 做为序列化的字段
public final String des;
BookType(int code, String des){this.code=code; this.des=des;}
}
public class Book {
String name;
BookType type;
@ONodeAttr(serialize=false) String author; //不序列化
@ONodeAttr(format="yyyy-MM-dd") Date releaseTime; //格式化时间输出
}
```
## 关于Json path的支持
* 字符串使用单引号，例：\['name']
* 过滤操作用空隔号隔开，例：\[?(@.type == 1)]
* 提醒：当有(注1)操作符时，会外面包了一层 array，后续操作符将作用于它的 item。
| 支持操作 | 说明 |
|----------------------------|------------------------------------|
| `$` | 表示根元素 |
| `@` | 当前节点（做为过滤表达式的谓词使用） |
| `*` | (注1)通用匹配符，可以表示一个名字或数字。 |
| `..` | (注1)深层扫描。 可以理解为递归搜索。 |
| `.` | 表示一个子节点 |
| `['' (, '')]` | 表示一个或多个子节点 |
| `[ (, )]` | 表示一个或多个数组下标（负号为倒数） |
| `[start:end]` | 数组片段，区间为\[start,end),不包含end（负号为倒数） |
| `[?()]` | (注1)过滤表达式。 表达式结果必须是一个布尔值。 |
| `[?(@.)]` | (注1)过滤表达式。 表示有一个子节点。 |
| 支持过滤操作符(`操作符两边要加空隔`) | 说明 |
| --- | --- |
| `==` | left等于right（注意1不等于'1'） |
| `!=` | 不等于 |
| `<` | 小于 |
| `<=` | 小于等于 |
| `>` | 大于 |
| `>=` | 大于等于 |
| `=~` | 匹配正则表达式[?(@.name =~ /foo.*?/i)] |
| `in` | 左边存在于右边 [?(@.size in ['S', 'M'])] |
| `nin` | 左边不存在于右边 |
| 支持尾部函数（对最后结果计算） | 说明 |
|-----------------|---------------------|
| `min()` | 计算数字数组的最小值 |
| `max()` | 计算数字数组的最大值 |
| `avg()` | 计算数字数组的平均值 |
| `sum()` | 计算数字数组的汇总值（新加的） |
| | |
| `size()` | 大小（当对象或数组时有效） |
| `length()` | 当字符串时，为字符串长度；否则为大小 |
| `keys()` | 当对象时返回所有key；否则为null |
| | |
| `first()` | 获取数组的第一项 |
| `last()` | 获取数组的最后项 |
例：`n.select("$.store.book[0].title")` 或 `n.select("$['store']['book'][0]['title']")`
例：`n.select("$..book.price.min()") //找到最低的价格`
# Snack3 接口字典
* [文章_Snack3_接口字典.md](文章_Snack3_接口字典.md)