Java 中 Snack3 的使用

JSON 是一种文本形式的数据交换格式，从Ajax的时候开始流行，它比XML更轻量、比二进制容易阅读和编写；解析和生成的方式很多，Java中最常用的类库有：JSON-Java、Gson、Jackson、FastJson、Snack3等。

Snack3 基于jdk8，80kb大小，非常小巧。

<dependency>
  <groupId>org.noear</groupId>
  <artifactId>snack3</artifactId>
  <version>3.2.122</version>
</dependency>

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

强调文档树的操控和构建能力
做为中间媒体，方便不同格式互转
高性能Json path查询（兼容性和性能很赞）
支持序列化、反序列化

一、Snack3 的基本用法

Snack3提供了几个快捷函数：

load(strOrObj), loadStr(str), loadObj(obj) 用于解析和加载；
stringify(obj), serialize(obj), deserialize(str,clz) 用于序列化和反序列化

（1）基本数据类型的解析

int i = ONode.load("100").getInt(); //100
double d = ONode.load("\"99.99\"").getDouble();  //99.99
boolean b = ONode.load("true").getBoolean();     // true
String str = ONode.load("String").getString();   // String

（2）基本数据类型的生成　

String jsonNumber = ONode.load(100).toJson();       // 100
String jsonBoolean = ONode.load(false).toJson();    // false
String jsonString = ONode.load("String").toString(); //"String"

（3）POJO类的生成与解析

public class User {
    public String name;
    public int age;
    public String emailAddress;
}

生成JSON：　

User user = new User("张三",24);

//输出： {"name":"张三","age":24}
String json = ONode.stringify(user); //JSON字符化

//输出： {"@type":"demo.User","name":"\u5F20\u4E09","age":24}
String json2 = ONode.serialize(user); //JSON序列化

解析并反序列化JSON：　

String json = "{name:'张三',age:24}";
User user = ONode.deserialize(json, User.class);//JSON反序列化

二、序列化事项补充说明

从上面示例可以看出json的字段和值是的名称和类型是一一对应的，Snack3不支持直接改名称，但可以通过transient关键字进行排除，例：

public class User {
    public String name;
    public int age;
    public String emailAddress;
    public transient Date date;
}

或者，加载后再重改名称，例：

User user = new User("name", 12, "xxx@mail.cn");

//输出： {"name":"name","age":12,"email":"xxx@mail.cn"}
ONode.load(user).rename("emailAddress","email").toJson();

//o.rename(key,newKey); //重命名子节点，并返回自己

Snack3在序列化和反序列化时需要使用反射，且只对字段进行序列化（不管属性）。

特性总结：

只对字段进行序列化（包括私有）
使用transient 对字段排除
加载后可进行修改（重命名，改值，删除）

三、Snack3 中使用泛型

例如：JSON字符串数组：["Android","Java","PHP"]

当要通过Snack3解析这个json时，一般有三种方式：使用ONode，使用数组，使用List；而List对于增删都是比较方便的，所以实际使用是还是List比较多

数组比较简单：

String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = ONode.deserialize(jsonArray,String[].class);

对于List将上面的代码中的 String[].class 直接改为 List<String>.class 是不行的，对于Java来说List<String> 和List<User> 这俩个的字节码文件只一个那就是List.class，这是Java泛型使用时要注意的问题泛型擦除。

为了解决的上面的问题，Snack3提供了2种方式来实现对泛型的支持，所以将以上的数据解析为List<String>时需要这样写：

String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
ONode ary0 		  = ONode.load(jsonArray);
List<String> ary1 = ONode.deserialize(jsonArray,(new ArrayList<String>(){}).getClass());
List<String> ary2 = ONode.deserialize(jsonArray,(new TypeRef<List<String>>(){}).getClass());

//(new ArrayList<String>(){}).getClass() 	    //方式1，通过临时类形（最终都是产生Class）
//(new TypeRef<List<String>>(){}).getClass() 	//方式2，通过TypeRef（最终都是产生Class）

泛型的引入还可以减少无关的代码：　

{"code":"0","message":"success","data":{}}
{"code":"0","message":"success","data":[]}

像上面这段代码，code只使用一次，message则几乎不用；我们真正需要的data所包含的数据，但它可能对象也可能是数组。如果Snack3不支持泛型或不知道Snack3支持泛型的同学一定会这么定义POJO：

public class UserResponse {
    public int code;
    public String message;
    public User data;
}

当设计其它接口的时候又重新定义一个XxxResponse将data的类型改成Xxx，很明显code，和message被重复定义了多次，会产大量的POJO。。。通过泛型可以将code和message字段抽取到一个Result的类中，这样只需要编写data字段所对应的POJO即可：

public class Result<T> {
    public int code;
    public String message;
    public T data;
}

四、Snack3 的序列化与反序列化

（1）自动方式

Snack3提供了serialize(obj)和deserialize(str,clz) 前者实现序列化，后者实现了反序列化。

ONode.serialize(obj);       //序列化
ONode.deserialize(str,clz); //反序列化

(2)手动方式：

手动的方式使用load(obj),toObject(clz),toJson() 来手动实现序列化和反序列化：

String json = "{\"name\":\"张三\",\"age\":\"24\"}";

//反序列化
User user = ONode.load(json,Options.serialize()).toObject(User.class);

//序列化
ONode.load(user,Options.serialize()).toJson();

自动方式最终都是通过load(obj),toObject(clz),toJson() 进行操作。

内部代码：

/**
 * 序列化为 string（由序列化器决定格式）
 *
 * @param source java object
 * @throws Exception
 */
public static String serialize(Object source) {
    //加载java object，须指定Fromer
    return load(source, Options.serialize(), DEFAULTS.DEF_OBJECT_FROMER).toJson();
}


/**
 * 反序列化为 java object（由返序列化器决定格式）
 *
 * @param source string
 * @throws Exception
 */
public static <T> T deserialize(String source, Class<?> clz) {
    //加载String，不需指定Fromer
    return load(source,  Options.serialize(), null).toObject(clz);
}

(3)使用 ONodeAttr 定制

定制枚举

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;
}

五、使用 Snack3 的 Options 和 Feature

一般情况下ONode类提供的 API已经能满足大部分的使用场景，但有时需要更多特殊、强大的功能时，这时候就引入一个新的类 Options 和 Feature。

Options 从名字上看它是一个提供配置的类，要想改变ONode默认的设置必须使用该类进行配置。用法：　

Options.of(..)                      //全新定义一份配置
Options.def().add(..).sub(..)       //在默认配置基础上，添加或减少特性
Options.serialize().add(..).sub(..) //在序列化配置基础上，添加或减少特性

（1）例：Snack3在默认情况下是不动导出值null的键的

User user = new User("张三", 24);
System.out.println(ONode.stringify(user)); //{"name":"张三","age":24}

//使用 Options(支持高级定制)
Options opts = Options.def().add(Feature.SerializeNulls); //导出null
System.out.println(ONode.load(user, cfg).toJson()); //{"name":"张三","age":24,"emailAddress":null}

//使用 Feature(快捷)
System.out.println(ONode.load(user, Feature.SerializeNulls).toJson());

（2）例：自动解析 json 内的 json string

String json = "{a:1,b:{l:'[{c:1},{c:2}]'}}";

//使用 Options(支持高级定制)
Options opts = Options.def().add(Feature.StringJsonToNode); //导出null
System.out.println(ONode.load(json, cfg).toJson()); //{a:1,b:{l:[{c:1},{c:2}]}}

//使用 Feature(快捷)
System.out.println(ONode.load(user, Feature.StringJsonToNode).toJson());

（3）例：格式化输出、日期时间及其它（是用于输出的）

Date date = new Date();

Options cfg = Options.of(Feature.WriteDateUseFormat) //使用格式化特性（才会让下面的 setDateFormat 起效）
        .build(c-> c.setDateFormat("yyyy-MM-dd")); //设置格式符（默认为："yyyy-MM-dd'T'HH:mm:ss"）;

System.out.println(ONode.load(date, cfg).toJson()); //2019-12-06

六、使用 Snack3 进行 JSONPath 查询

在网上找了一份经典的JSON样本：

{
    "store": {
        "bicycle": {
            "color": "red",
            "price": 19.95
        },
        "book": [
            {
                "author": "刘慈欣",
                "price": 8.95,
                "category": "科幻",
                "title": "三体"
            },
            {
                "author": "itguang",
                "price": 12.99,
                "category": "编程语言",
                "title": "go语言实战"
            }
        ]
    }
}

Snack3 可以提供高速的 JSONPath 查询，JSONPath 更给日常的查询节省了大量代码：

ONode o = ONode.load(jsonStr);

//得到所有的书
ONode books = o.select("$.store.book");
System.out.println("books=::" + books);

//得到所有的书名
ONode titles = o.select("$.store.book.title");
System.out.println("titles=::" + titles);

//第一本书title
ONode title = o.select("$.store.book[0].title");
System.out.println("title=::" + title);

//price大于10元的book
ONode list = o.select("$.store.book[?(price > 10)]");
System.out.println("price大于10元的book=::" + list);

//price大于10元的title
ONode list2 = o.select("$.store.book[?(price > 10)].title");
System.out.println("price大于10元的title=::" + list2);

//category(类别)为科幻的book
ONode list3 = o.select("$.store.book[?(category == '科幻')]");
System.out.println("category(类别)为科幻的book=::" + list3);


//bicycle的所有属性值
ONode values = o.select("$.store.bicycle.*");
System.out.println("bicycle的所有属性值=::" + values);


//bicycle的color和price属性值
ONode read = o.select("$.store.bicycle['color','price']");
System.out.println("bicycle的color和price属性值=::" + read);

（1）支持的 JSONPath 语法

字符串使用单引号，例：['name']
过滤操作用空隔号隔开，例：[?(@.type == 1)]

支持操作	说明
`$`	表示根元素
`@`	当前节点（做为过滤表达式的谓词使用）
`*`	通用配配符，可以表示一个名字或数字。
`..`	深层扫描。可以理解为递归搜索。
`.<name>`	表示一个子节点
`['<name>' (, '<name>')]`	表示一个或多个子节点
`[<number> (, <number>)]`	表示一个或多个数组下标（负号为倒数）
`[start:end]`	数组片段，区间为[start,end),不包含end（负号为倒数）
`[?(<expression>)]`	过滤表达式。表达式结果必须是一个布尔值。

支持过滤操作符	说明
`==`	left等于right（注意1不等于'1'）
`!=`	不等于
`<`	小于
`<=`	小于等于
`>`	大于
`>=`	大于等于
`=~`	匹配正则表达式[?(@.name =~ /foo.*?/i)]
`in`	左边存在于右边 [?(@.size in ['S', 'M'])]
`nin`	左边不存在于右边

支持尾部函数	说明
`min()`	计算数字数组的最小值
`max()`	计算数字数组的最大值
`avg()`	计算数字数组的平均值
`sum()`	计算数字数组的汇总值（新加的）

像这两种写法的语义是差不多：

$.store.book[0].title //建议使用这种

$['store']['book'][0]['title']

（2）语法示例说明

JSONPath	说明
`$`	根对象
`$[-1]`	最后元素
`$[:-2]`	第0个至倒数第2个
`$[1:]`	第1个之后所有元素（0为首个）
`$[1,2,3]`	集合中1,2,3个元素（0为首个）

七、数据格式互转

Snack3是采用(Fromer)->(ONode)->(Toer)的架构。非常适合格式的转换，开发时只需要完成与ONode的对接即可：

（1）将Xml转为Ymal

String xml = "<xml>....</xml>";
XmlFromer xmlFromer = new XmlFromer();
YmalToer  ymalToer  = new YmalToer();

//加载xml，输出ymal
String ymal = ONode.load(xml,Options.def(),xmlFromer).to(ymalToer);

（2）加载Xml，去掉手机号，转为java object

ONode tmp =ONode.load(xml,Options.def(),xmlFromer);

//找到有手机号的，然后移除手机号
tmp.select("$..[?(@.mobile)]").forEach(n->n.remove("mobile"));

XxxModel m =tmp.toObject(XxxModel.class);

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

文章_Java_中_Snack3的使用.md

文章_Java_中_Snack3的使用.md

Java 中 Snack3 的使用

一、Snack3 的基本用法

（1）基本数据类型的解析

（2）基本数据类型的生成

（3）POJO类的生成与解析

生成JSON：

解析并反序列化JSON：

二、序列化事项补充说明

特性总结：

三、Snack3 中使用泛型

四、Snack3 的序列化与反序列化

（1）自动方式

(2)手动方式：

(3)使用 ONodeAttr 定制

五、使用 Snack3 的 Options 和 Feature

（1）例：Snack3在默认情况下是不动导出值null的键的

（2）例：自动解析 json 内的 json string

（3）例：格式化输出、日期时间及其它（是用于输出的）

六、使用 Snack3 进行 JSONPath 查询

（1）支持的 JSONPath 语法

（2）语法示例说明

七、数据格式互转

（1）将Xml转为Ymal

（2）加载Xml，去掉手机号，转为java object

Files

文章_Java_中_Snack3的使用.md

Latest commit

History

文章_Java_中_Snack3的使用.md

File metadata and controls

Java 中 Snack3 的使用

一、Snack3 的基本用法

（1）基本数据类型的解析

（2）基本数据类型的生成

（3）POJO类的生成与解析

生成JSON：

解析并反序列化JSON：

二、序列化事项补充说明

特性总结：

三、Snack3 中使用泛型

四、Snack3 的序列化与反序列化

（1）自动方式

(2)手动方式：

(3)使用 ONodeAttr 定制

五、使用 Snack3 的 Options 和 Feature

（1）例：Snack3在默认情况下是不动导出值null的键的

（2）例：自动解析 json 内的 json string

（3）例：格式化输出、日期时间及其它（是用于输出的）

六、使用 Snack3 进行 JSONPath 查询

（1）支持的 JSONPath 语法

（2）语法示例说明

七、数据格式互转

（1）将Xml转为Ymal

（2）加载Xml，去掉手机号，转为java object

（2）基本数据类型的生成　

生成JSON：　

解析并反序列化JSON：　