snackjson

本文资源均来自互联网，仅供学习交流使用，请于24小时内删除

项目介绍

新一代高性能 Jsonpath 框架。同时兼容 jayway.jsonpath 和 IETF JSONPath (RFC 9535) 标准规范（支持开放式定制）。

项目详情

SnackJson

一个 Json 框架，支持 JsonDom、JsonPath、JsonSchema（for Java）

兼容 `jayway.jsonpath` 和 IETF JSONPath (RFC 9535) 标准。兼容 JsonSchema draft-07 标准。支持开放式定制。

https://solon.noear.org/article/snack

语言： 中文 | English

SnackJson 借鉴了 Javascript 所有变量由 var 申明，及 Xml dom 一切都是 Node 的设计。其下一切数据都以ONode表示，ONode也即 One node 之意，代表任何类型，也可以转换为任何类型。

• 强调 Json dom 的构建和操控能力
• 可以 Json path 高性能查询（比 jayway.jsonpath 快很多），同时兼容 jayway.jsonpath 和 IETF JSONPath (RFC 9535) 标准 (用 options 切换)。提供新一代 JsonPath 体验。
• 提供 Json schema 构建与校验，兼容 JsonSchema draft-07、draft-2019 标准
• 支持 json5 部分特性（无键字段，注释，等...）
• 优先使用 无参构造函数 + 字段 编解码（可减少注入而触发动作的风险）

| 依赖包 | 描述 |
|-------------------------------|------------------------|
| org.noear:snack4 | 提供 json dom 构建和编解码支持 |
| org.noear:snack4-jsonpath | 提供 json path 查询支持 |
| org.noear:snack4-jsonschema | 提供 json schema 校验支持 |

JSONPath 语法参考（ IETF JSONPath (RFC 9535) ）

过滤选择器语法参考：

IETF JSONPath (RFC 9535) 标准定义操作符（支持）

jayway.jsonpath 增量操作符（支持）

IETF JSONPath (RFC 9535) 标准定义函数（支持）

jayway.jsonpath 函数（支持）

snack-jsonpath 增量操作符（支持）

JSONPath 语法示例

JSON 样本数据

{ "store": {
"book": [
{ "category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{ "category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
{ "category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99
},
{ "category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99
}
],
"bicycle": {
"color": "red",
"price": 399
}
  }
}

示例JSONPath表达式及其应用于示例JSON值时的预期结果

o.addNew().set("title", "开始").set("type", "start");
o.addNew().set("title", "结束").set("type", "end");
});

oNode.get("id").getInt();
oNode.get("layout").get(0).get("title").getString();

oNode.getOrNew("list").fillJson("[1,2,3,4,5,6]");

支持 `json path` 查询、构建、删除

ONode.ofBean(store).select("$..book[?@.tags contains 'war'].first()").toBean(Book.class); //RFC9535 规范，可以没有括号
ONode.ofBean(store).select("$..book[?(!(@.category == 'fiction') && @.price (){}).getClass()); //泛型
ONode.ofJson("[{},{}]").toBean(new TypeRef>(){}); //泛型

//快捷方式
String json = ONode.serialize(user);
User user = ONode.deserialize(json, User.class);

### 路径树接口

//case1
ONode o = ONode.ofJson(json);
ONode rst = o.select("$.data.list[*].mobile"); //自动为查询到的节点，生成 path 属性
List rstPaths = rst.pathList(); //获取结果节点的路径列表
for(ONode n1 : rst.getArray()) {
n1.path(); //当前路径
n1.parent(); //父级节点
}

//case2
ONode o = ONode.ofJson(json).usePaths(); //手动为每个子节点，生成 path 属性
ONode rst = o.get("data").get("list").get(2);
rst.path();
rst.parent();

### 高级定制

Json 编解码定制

Options options = Options.of();
//添加检测器（for Feature.Read_AutoType）
options.addChecker(clzName -> {
//通过
if (clzName.startsWith("com.ok.xxx.")) {
return TypeChecker.ALLOW;
}

//拒绝
if (clzName.startsWith("com.no.yyy.")) {
return TypeChecker.DENY;
}

//跳过
return TypeChecker.SKIP;
});
//添加编码器
options.addEncoder(Date.class, (ctx, value, target) -> {
target.setValue(DateUtil.format(data, "yyyy-MM-dd"));
});
//添加解码器
options.addDecoder(Date.class, ...);
//添加创建器（接管类实例化）
options.addCreator(...);

//添加特性
options.addFeature(Feature.Write_PrettyFormat);

//移除特性
options.removeFeature(Feature.Write_PrettyFormat);

//设置日期格式附
options.addFeature(Feature.Write_UseDateFormat); //使用日期格式
options.dateFormat("yyyy-MM");

//..

String json = ONode.ofBean(orderModel, options).toJson();

JsonPath 函数与操作符定制

import org.noear.snack4.ONode;
import org.noear.snack4.jsonpath.FunctionLib;

public class FunctionDemo {
public static void main(String[] args) {
//定制 floor 函数
FunctionLib.register("floor", (ctx, argNodes) -> {
ONode arg0 = argNodes.get(0); //节点列表（选择器的结果）

if (ctx.isDescendant()) {
for (ONode n1 : arg0.getArray()) {
if (n1.isNumber()) {
n1.setValue(Math.floor(n1.getDouble()));
}
}

return arg0;
} else {
ONode n1 = arg0.get(0);

if (n1.isNumber()) {
return ctx.newNode(Math.floor(n1.getDouble()));
} else {
return ctx.newNode();
}
}
});

//检验效果（在 IETF 规范里以子项进行过滤，即 1,2） //out: 1.0
System.out.println(ONode.ofJson("{'a':1,'b':2}")
.select("$.a.floor()")
.toJson());

//参考 //out: 2.0
System.out.println(ONode.ofJson("{'a':1,'b':2}")
.select("$[?floor(@) > 1].first()")
.toJson());
}
}

import org.noear.snack4.ONode;
import org.noear.snack4.jsonpath.OperatorLib;

public class OperationDemo {
public static void main(String[] args) {
//定制操作符
OperatorLib.register("startsWith", (ctx, node, term) -> {
ONode leftNode = term.getLeftNode(ctx, node);

if (leftNode.isString()) {
ONode rightNode = term.getRightNode(ctx, node);
if (rightNode.isNull()) {
return false;
}

return leftNode.getString().startsWith(rightNode.getString());
}
return false;
});

//检验效果
assert ONode.ofJson("{'list':['a','b','c']}")
.select("$.list[?@ startsWith 'a']")
.size() == 1;
}
}

### 特别感谢JetBrains对开源项目支持：

![项目截图](https://user-images.githubusercontent.com/8643542/160519107-199319dc-e1cf-4079-94b7-01b6b8d23aa6.png)

## ⬇️ 下载地址 ##

{cloud title="snackjson 源码下载" type="gitee" url="https://gitee.com/noear/snackjson/repository/archive/master.zip" /}

下载后请先检查文件完整性，如有问题请在评论区反馈