JSON携程文档

下面给出一个我国省份城市Json实例:

{"name": "中国","province": [{"name": "黑龙江","cities": {"city": ["哈尔滨", "大庆"]}}, {"name": "广东","cities": {"city": ["广州", "深圳", "珠海"]}}, {"name": "台湾","cities": {"city": ["台北", "高雄"]}}, {"name": "新疆","cities": {"city": ["乌鲁木齐"]}}]
}

其中, "province" 下是数组, 数组里包含各个省份对象, 省份下 "cities" 是城市对象,里面有对应的城市数组.

更通俗来说, 看见{ } 就去想对象, 看见[ ] 就去想数组.  

三、JSON数据类型

在上面JSON基础中已有提到Json数据类型,下面进一步说明.

3.1 有效和无效的数据类型

在 JSON 中，值必须是以下数据类型之一：

• 字符串
• 数字
• 对象（JSON 对象）
• 数组
• 布尔
• Null

---

JSON 的值不可以是以下数据类型之一：

• 函数
• 日期
• undefined

3.2 JSON 字符串

JSON 中的字符串必须用双引号包围。

实例

{ "name":"Bill" }

3.3 JSON 数字

JSON 中的数字必须是整数或浮点数。

实例

{ "age":30 }

3.4 JSON 对象

JSON 中的值可以是对象。

实例

{"employee":{ "name":"Bill Gates", "age":62, "city":"Seattle" }
}

JSON 中作为值的对象必须遵守与 JSON 对象相同的规则。

3.5 JSON 数组

JSON 中的值可以是数组。

实例

{
"employees":[ "Bill", "Steve", "David" ]
}

3.6 JSON 布尔

JSON 中的值可以是 true/false。

实例

{ "sale":true }

3.7 JSON null

JSON 中的值可以是 null。

实例

{ "middlename":null }

四、JsonPath 的使用 

参考至: JsonPath教程_koflance的博客-CSDN博客_jsonpath的用法

4.1 JsonPath 的介绍

通过名字可以知道,JsonPath和JSON文档有关系,JsonPath非常强大,通过JsonPath我们可以轻松的解析JSON,获取需要的内容.

4.2 JsonPath 语法

4.2.1 操作符

4.2.2 函数

4.2.3 过滤器

过滤器是用于过滤数组的逻辑表达式，一个通常的表达式形如：[?(@.age > 18)]，可以通过逻辑表达式&&或||组合多个过滤器表达式，例如[?(@.price < 10 && @.category == ‘fiction’)]，字符串必须用单引号或双引号包围，例如[?(@.color == ‘blue’)] or [?(@.color == “blue”)] 

 示例:

String 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": 19.95}},"expensive": 10
}";

/* 获取全部authors
["Nigel Rees","Evelyn Waugh","Herman Melville","J. R. R. Tolkien"]
*/
// 1. $.store.book[*].author
List authors1 = JsonPath.read(json, "$.store.book.[*].author");
// 2. $..author
List authors2 = JsonPath.read(json, "$..author");

在使用时,强烈建议按照第一种语法进行使用!

处理JSON数据时,一定要层层筛选,避免出错,不要图省事!

// [[{"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}],{"color":"red","price":19.95}]
List all = JsonPath.read(json, "$.store.*");

[8.95,12.99,8.99,22.99]

[8.95]

// [8.95,12.99,8.99,22.99]
List prices = JsonPath.read(json, "$.store.book.[*].price");
// 8.95
double priceOfBook1 = JsonPath.read(json, "$.store.book.[0].price");

// [{"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}]
List books1 = JsonPath.read(json, "$..book[0, 1]");
List books2 = JsonPath.read(json, "$..book[:2]");//[{"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}]
List books3 = JsonPath.read(json, "$..book[-2:]");//[{"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}]
List books4 = JsonPath.read(json, "$..book[2:]");

JSON数组跟Java、C数组一样,下标从0开始.

book[0, 1] 表示获取第一个,第二个书.

book[:2] 表示获取前两本书.

book[-2:] 表示获取最后两本书.

book[2:] 表示获取除前两本书外,剩余的书.

//[{"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}]
List books5 = JsonPath.read(json, "$..book[?(@.isbn)]");//[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99}]
List books6 = JsonPath.read(json, "$..book[?(@.price < 10)]");//[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99}]
List books7 = JsonPath.read(json, "$..book[?(@.price < $['expensive'])]");//[{”category” : “reference”,”author” : “Nigel Rees”,”title” : “Sayings of the Century”,”price” : 8.95}]
List books8 = JsonPath.read(json, "$..book[?(@.author =~ /.*Rees/i)]");

$..book[?(@.isbn)] 表示获取所有含有“isbn” 的书

$.store.book[?(@.price < 10)] 表示获取所有价格低于10的书

$..book[?(@.price <= $[‘expensive’])] 表示获取所有价格低于expensive字段的值的书

$..book[?(@.author =~ /.*REES/i)] 表示获取所有作者名包含"REES" (不区分大小写) 的书 

// 4
int len = JsonPath.read(json, "$.store.book.length()");

不使用函数,也可对JSON数据进行操作

List  prices = JsonPath.read(json, "$.store.book.[*].price");
Double max = Double.valueOf(0.00);
for (Double price : prices){if (price > max){max = price;}
}
// 22.99
System.out.println(max);

Tip: 贴两个在线资源 :  

        1. JSON在线格式化 : JSON在线视图查看器(Online JSON Viewer) 

        2. JsonPath在线编辑 : JSONPath Online Evaluator

4.3 JsonPath 常用用法

通常是直接使用静态方法API进行调用，例如：

String json = "...";List authors = JsonPath.read(json, "$.store.book[*].author");

但以上方式仅仅适用于解析一次json的情况，如果需要对同一个json解析多次，不建议使用，因为每次read都会重新解析一次json，针对此种情况，建议使用ReadContext、WriteContext，例如：

String json = "...";ReadContext ctx = JsonPath.parse(json);List authorsOfBooksWithISBN = ctx.read("$.store.book[?(@.isbn)].author");List> expensiveBooks = JsonPath.using(configuration).parse(json).read("$.store.book[?(@.price > 10)]", List.class);

4.4 JsonPath 返回值 

通常read后的返回值会进行自动转型到指定的类型，对应明确定义definite的表达式，应指定其对应的类型，对于indefinite含糊表达式，例如包括..、?()、[, (, )]，通常应该使用数组。如果需要转换成具体的类型，则需要通过configuration配置mappingprovider，如下：

String json = "{\"date_as_long\" : 1411455611975}";
//使用JsonSmartMappingProvider
Date date = JsonPath.parse(json).read("$['date_as_long']", Date.class);
//使用GsonMappingProvider
Book book = JsonPath.parse(json).read("$.store.book[0]", Book.class);

4.5 MappingProvider SPI反序列化器

在另一个文章有写到:MappingProvider 反序列化器_Reo_Accepted的博客-CSDN博客默认情况下，一个简单的对象映射器由MappingProviderSPI提供。JsonPath提供了默认的实现JsonSmartJsonProvider和JsonSmartMappingProvider。但是不能将json字符串转为POJO对象。计算路径时需要知道路径是明确的还是不明确的,明确的返回单个值,不明确的返回一个List.JsonPath将自动尝试将结果强制转换为调用方所期望的类型。JsonSmartMappingProvider(默认)......https://blog.csdn.net/qq_51490751/article/details/126009307?csdn_share_tail=%7B%22type%22%3A%22blog%22%2C%22rType%22%3A%22article%22%2C%22rId%22%3A%22126009307%22%2C%22source%22%3A%22qq_51490751%22%7D&ctrtid=YFj74

其中JsonSmartMappingProvider提供了如下基本数据类型的转换，此provider是默认设置的，在Configuration.defaultConfiguration()中返回的DefaultsImpl类，使用的就是JsonSmartMappingProvider。

DEFAULT.registerReader(Long.class, new LongReader());
DEFAULT.registerReader(long.class, new LongReader());
DEFAULT.registerReader(Integer.class, new IntegerReader());
DEFAULT.registerReader(int.class, new IntegerReader());
DEFAULT.registerReader(Double.class, new DoubleReader());
DEFAULT.registerReader(double.class, new DoubleReader());
DEFAULT.registerReader(Float.class, new FloatReader());
DEFAULT.registerReader(float.class, new FloatReader());
DEFAULT.registerReader(BigDecimal.class, new BigDecimalReader());
DEFAULT.registerReader(String.class, new StringReader());
DEFAULT.registerReader(Date.class, new DateReader());

切换Provider，如下： 

Configuration.setDefaults(new Configuration.Defaults() {private final JsonProvider jsonProvider = new JacksonJsonProvider();private final MappingProvider mappingProvider = new JacksonMappingProvider();@Overridepublic JsonProvider jsonProvider() {return jsonProvider;}@Overridepublic MappingProvider mappingProvider() {return mappingProvider;}@Overridepublic Set options() {return EnumSet.noneOf(Option.class);}
});

4.6 Predicates过滤器断言

有三种方式创建过滤器断言。

4.6.1 Inline Predicates

即使用过滤器断言表达式?(<@expression>)，例如：

List> books =  JsonPath.parse(json).read("$.store.book[?(@.price < 10)]");

4.6.2 Filter Predicates

使用Filter API。例如：

每一个语句的结果都以注释在上方给出

import static com.jayway.jsonpath.JsonPath.parse;
import static com.jayway.jsonpath.Criteria.where;
import static com.jayway.jsonpath.Filter.filter;
...
...// [?(@['category'] == 'fiction' && @['price'] <= 10.0)]
Filter cheapFictionFilter = filter(where("category").is("fiction").and("price").lte(10D)
);List> books =  parse(json).read("$.store.book[?]", cheapFictionFilter);// [?(@['foo'] || @['bar'])]
Filter fooOrBar = filter(where("foo").exists(true)).or(where("bar").exists(true)
);// [?(@['foo'] && @['bar'])]
Filter fooAndBar = filter(where("foo").exists(true)).and(where("bar").exists(true)
);

注意：

JsonPath表达式中必须要有断言占位符“?”，当有多个占位符时，会依据顺序进行替换。
多个filter之间还可以使用or或and。

4.6.3 Roll Your Own

自己实现Predicate接口。

ReadContext reader = JsonPath.parse(json);
Predicate booksWithISBN = new Predicate() {@Overridepublic boolean apply(PredicateContext ctx) {return ctx.item(Map.class).containsKey("isbn");}
};List> books = reader.read("$.store.book[?].isbn", List.class, booksWithISBN);

注意：在自定义过滤器中，context.item(Map.class) 这句话。这句中的Map.class是根据预定的结果类型定义的，如果返回的是String类型值，那就改为String.class 

4.7返回检索到的Path路径列表

有时候需要返回当前JsonPath表达式所检索到的全部路径，可以如下使用：

// 首先设置 Configuration
Configuration conf = Configuration.builder().options(Option.AS_PATH_LIST).build();// ["$['store']['book'][0]['author']",
//  "$['store']['book'][1]['author']",
//  "$['store']['book'][2]['author']",
//  "$['store']['book'][3]['author']"]
List pathList = using(conf).parse(json).read("$..author");

4.8 配置Options

4.8.1 DEFAULT_PATH_LEAF_TO_NULL

当检索不到时返回null对象，否则如果不配置这个，会直接抛出异常PathNotFoundException，例如：

[{"name" : "john","gender" : "male"},{"name" : "ben"}
]

Configuration conf = Configuration.defaultConfiguration();//Works fine
String gender0 = JsonPath.using(conf).parse(json).read("$[0]['gender']");
//PathNotFoundException thrown
String gender1 = JsonPath.using(conf).parse(json).read("$[1]['gender']");Configuration conf2 = conf.addOptions(Option.DEFAULT_PATH_LEAF_TO_NULL);//Works fine
String gender0 = JsonPath.using(conf2).parse(json).read("$[0]['gender']");
//Works fine (null is returned)
String gender1 = JsonPath.using(conf2).parse(json).read("$[1]['gender']");

4.8.2 ALWAYS_RETURN_LIST

总是返回list，即便是一个确定的非list类型，也会被包装成list。

Configuration conf = Configuration.defaultConfiguration().addOptions(Option.ALWAYS_RETURN_LIST);

4.8.3 SUPPRESS_EXCEPTIONS

不抛出异常，需要判断如下：

ALWAYS_RETURN_LIST开启，则返回空list
ALWAYS_RETURN_LIST关闭，则返回null

4.8.4 AS_PATH_LIST

返回path

Configuration conf = Configuration.builder().options(Option.AS_PATH_LIST).build();

4.8.5 REQUIRE_PROPERTIES

如果设置，则不允许使用通配符，比如$[*].b，会抛出PathNotFoundException异常。

Configuration conf = Configuration.builder().options(Option.REQUIRE_PROPERTIES).build();

4.9 Cache SPI

每次read时都会获取cache，以提高速度，但默认情况下是不启用的。

@Override
public  T read(String path, Predicate... filters) {notEmpty(path, "path can not be null or empty");Cache cache = CacheProvider.getCache();path = path.trim();LinkedList filterStack = new LinkedList(asList(filters));String cacheKey = Utils.concat(path, filterStack.toString());JsonPath jsonPath = cache.get(cacheKey);if(jsonPath != null){return read(jsonPath);} else {jsonPath = compile(path, filters);cache.put(cacheKey, jsonPath);return read(jsonPath);}
}

JsonPath 2.1.0提供新的spi，必须在使用前或抛出JsonPathException前配置。目前提供了两种实现：

com.jayway.jsonpath.spi.cache.NOOPCache (no cache)
com.jayway.jsonpath.spi.cache.LRUCache (default, thread safe)
如果想要自己实现，例如：

CacheProvider.setCache(new Cache() {//Not thread safe simple cacheprivate Map map = new HashMap();@Overridepublic JsonPath get(String key) {return map.get(key);}@Overridepublic void put(String key, JsonPath jsonPath) {map.put(key, jsonPath);}
});

五、日常使用中一些坑

5.1 数据类型问题

处理JSON文件之间一定要先弄清楚数据类型

       比如:json : { "soldNums" :  [ { "soldNum"  :  100 } , { "soldNum" : "1万+" } ] }

数组里的soldNum的数据类型既有整形也有字符串,出现不止一种数据类型的情况,有以下几种解决方案

1.统一用Object父类囊括

String json = "{\"soldNums\":[{\"soldNum\" : 100 },{\"soldNum\":\"1万+\"}]}";
List