使用 JSONPath 解析 JSON 完整内容详解

冷不防 2022-04-16 02:41 327阅读 0赞

# jsonpath的介绍: #

JsonPath是一种简单的方法来提取给定JSON文档的部分内容。 JsonPath有许多编程语言，如Javascript，Python和PHP，Java。

JsonPath提供的json解析非常强大，它提供了类似正则表达式的语法，基本上可以满足所有你想要获得的json内容。

# github上有它的应用:[https://github.com/json-path/JsonPath][https_github.com_json-path_JsonPath] #

# JsonPath可在Central Maven存储库中找到。 Maven用户将其添加到您的POM: #

<dependency>
        <groupId>com.jayway.jsonpath</groupId>
        <artifactId>json-path</artifactId>
        <version>2.2.0</version>
    </dependency>

JsonPath表达式总是以与XPath表达式结合使用XML文档相同的方式引用JSON结构。

JsonPath中的“根成员对象”始终称为$，无论是对象还是数组。

JsonPath表达式可以使用点表示法

`$.store.book [0].title`

或括号表示法

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

# `jsonpath操作符：` #

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>操作</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>$</td> 
   <td>查询根元素。这将启动所有路径表达式。</td> 
  </tr> 
  <tr> 
   <td>@</td> 
   <td>当前节点由过滤谓词处理。</td> 
  </tr> 
  <tr> 
   <td>*</td> 
   <td>通配符，必要时可用任何地方的名称或数字。</td> 
  </tr> 
  <tr> 
   <td>..</td> 
   <td>深层扫描。 必要时在任何地方可以使用名称。</td> 
  </tr> 
  <tr> 
   <td>.&lt;name&gt;</td> 
   <td> 
    <table> 
     <tbody> 
      <tr> 
       <td>点，表示子节点</td> 
      </tr> 
     </tbody> 
    </table></td> 
  </tr> 
  <tr> 
   <td>['&lt;name&gt;' (, '&lt;name&gt;')]</td> 
   <td> 
    <table> 
     <tbody> 
      <tr> 
       <td>括号表示子项</td> 
      </tr> 
     </tbody> 
    </table></td> 
  </tr> 
  <tr> 
   <td>[&lt;number&gt; (, &lt;number&gt;)]</td> 
   <td> 
    <table> 
     <tbody> 
      <tr> 
       <td>数组索引或索引</td> 
      </tr> 
     </tbody> 
    </table></td> 
  </tr> 
  <tr> 
   <td>[start:end]</td> 
   <td> 
    <table> 
     <tbody> 
      <tr> 
       <td>数组切片操作</td> 
      </tr> 
     </tbody> 
    </table></td> 
  </tr> 
  <tr> 
   <td>[?(&lt;expression&gt;)]</td> 
   <td>过滤表达式。 表达式必须求值为一个布尔值。</td> 
  </tr> 
 </tbody> 
</table>

### 函数 ###

函数可以在路径的尾部调用，函数的输出是路径表达式的输出，该函数的输出是由函数本身所决定的。

<table> 
 <thead> 
  <tr> 
   <th>函数</th> 
   <th>描述</th> 
   <th>输出</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>min()</code></td> 
   <td>提供数字数组的最小值</td> 
   <td><code>Double</code></td> 
  </tr> 
  <tr> 
   <td><code>max()</code></td> 
   <td>提供数字数组的最大值</td> 
   <td><code>Double</code></td> 
  </tr> 
  <tr> 
   <td><code>avg()</code></td> 
   <td>提供数字数组的平均值</td> 
   <td><code>Double</code></td> 
  </tr> 
  <tr> 
   <td><code>stddev()</code></td> 
   <td>提供数字数组的标准偏差值</td> 
   <td><code>Double</code></td> 
  </tr> 
  <tr> 
   <td><code>length()</code></td> 
   <td>提供数组的长度</td> 
   <td>Integer</td> 
  </tr> 
 </tbody> 
</table>

### 过滤器运算符 ###

过滤器是用于筛选数组的逻辑表达式。一个典型的过滤器将是\[?(@.age > 18)\]，其中@表示正在处理的当前项目。 可以使用逻辑运算符&&和||创建更复杂的过滤器。 字符串文字必须用单引号或双引号括起来(\[?(@.color == 'blue')\] 或者 \[?(@.color == "blue")\]).

<table> 
 <thead> 
  <tr> 
   <th>操作符</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>==</code></td> 
   <td>left等于right（注意1不等于'1'）</td> 
  </tr> 
  <tr> 
   <td><code>!=</code></td> 
   <td>不等于</td> 
  </tr> 
  <tr> 
   <td><code>&lt;</code></td> 
   <td>小于</td> 
  </tr> 
  <tr> 
   <td><code>&lt;=</code></td> 
   <td>小于等于</td> 
  </tr> 
  <tr> 
   <td><code>&gt;</code></td> 
   <td>大于</td> 
  </tr> 
  <tr> 
   <td><code>&gt;=</code></td> 
   <td>大于等于</td> 
  </tr> 
  <tr> 
   <td><code>=~</code></td> 
   <td>匹配正则表达式[?(@.name =~ /foo.*?/i)]</td> 
  </tr> 
  <tr> 
   <td><code>in</code></td> 
   <td>左边存在于右边 [?(@.size in ['S', 'M'])]</td> 
  </tr> 
  <tr> 
   <td><code>nin</code></td> 
   <td>左边不存在于右边</td> 
  </tr> 
  <tr> 
   <td><code>size</code></td> 
   <td>（数组或字符串）长度</td> 
  </tr> 
  <tr> 
   <td><code>empty</code></td> 
   <td>（数组或字符串）为空</td> 
  </tr> 
 </tbody> 
</table>

接下来我们就用java代码来写一个案例:

### Java操作示例 ###

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
    }

<table> 
 <thead> 
  <tr> 
   <th>JsonPath (点击链接测试)</th> 
   <th>结果</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$.store.book%5B*%5D.author" rel="nofollow"><code>$.store.book[*].author</code></a></td> 
   <td>获取json中store下book下的所有author值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..author" rel="nofollow"><code>$..author</code></a></td> 
   <td>获取所有json中所有author的值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$.store.*" rel="nofollow"><code>$.store.*</code></a></td> 
   <td>所有的东西，书籍和自行车</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$.store..price" rel="nofollow"><code>$.store..price</code></a></td> 
   <td>获取json中store下所有price的值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B2%5D" rel="nofollow"><code>$..book[2]</code></a></td> 
   <td>获取json中book数组的第3个值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B2%5D" rel="nofollow"><code>$..book[-2]</code></a></td> 
   <td>倒数的第二本书</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B0,1%5D" rel="nofollow"><code>$..book[0,1]</code></a></td> 
   <td>前两本书</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B:2%5D" rel="nofollow"><code>$..book[:2]</code></a></td> 
   <td>从索引0（包括）到索引2（排除）的所有图书</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B1:2%5D" rel="nofollow"><code>$..book[1:2]</code></a></td> 
   <td>从索引1（包括）到索引2（排除）的所有图书</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B-2:%5D" rel="nofollow"><code>$..book[-2:]</code></a></td> 
   <td>获取json中book数组的最后两个值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B2:%5D" rel="nofollow"><code>$..book[2:]</code></a></td> 
   <td>获取json中book数组的第3个到最后一个的区间值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B?%28@.isbn%29%5D" rel="nofollow"><code>$..book[?(@.isbn)]</code></a></td> 
   <td>获取json中book数组中包含isbn的所有值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$.store.book%5B?%28@.price%20%3C%2010%29%5D" rel="nofollow"><code>$.store.book[?(@.price &lt; 10)]</code></a></td> 
   <td>获取json中book数组中price&lt;10的所有值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B?%28@.price%20%3C=%20$%5B%27expensive%27%5D%29%5D" rel="nofollow"><code>$..book[?(@.price &lt;= $['expensive'])]</code></a></td> 
   <td>获取json中book数组中price&lt;=expensive的所有值</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book%5B?%28@.author%20=~%20/.*REES/i%29%5D" rel="nofollow"><code>$..book[?(@.author =~ /.*REES/i)]</code></a></td> 
   <td>获取json中book数组中的作者以REES结尾的所有值（REES不区分大小写）</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..*" rel="nofollow"><code>$..*</code></a></td> 
   <td>逐层列出json中的所有值，层级由外到内</td> 
  </tr> 
  <tr> 
   <td><a href="http://jsonpath.herokuapp.com/?path=$..book.length%28%29" rel="nofollow"><code>$..book.length()</code></a></td> 
   <td>获取json中book数组的长度</td> 
  </tr> 
 </tbody> 
</table>

上面的json字符串的读取案例:

(1)

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

(2)

如果你只想读取一次，那么上面的代码就可以了

如果你还想读取其他路径，现在上面不是很好的方法，因为他每次获取都需要再解析整个文档。所以，我们可以先解析整个文档，再选择调用路径。

String json = "...";  
Object document = Configuration.defaultConfiguration().jsonProvider().parse(json);

String author0 = JsonPath.read(document, "$.store.book\[0\].author");  
String author1 = JsonPath.read(document, "$.store.book\[1\].author");

(3)

当在java中使用JsonPath时，重要的是要知道你在结果中期望什么类型。 JsonPath将自动尝试将结果转换为调用者预期的类型。

// 抛出 java.lang.ClassCastException 异常  
List<String> list = JsonPath.parse(json).read("$.store.book\[0\].author")

// 正常  
String author = JsonPath.parse(json).read("$.store.book\[0\].author")

(4)

默认情况下，MappingProvider SPI提供了一个简单的对象映射器。 这允许您指定所需的返回类型，MappingProvider将尝试执行映射。 在下面的示例中，演示了Long和Date之间的映射。

String json = "\{\\"date\_as\_long\\" : 1411455611975\}";  
Date date = JsonPath.parse(json).read("$\['date\_as\_long'\]", Date.class);

(5)

如果您将JsonPath配置为使用JacksonMappingProvider或GsonMappingProvider，您甚至可以将JsonPath输出直接映射到POJO中。

Book book = JsonPath.parse(json).read("$.store.book\[0\]", Book.class);

# 另外一个案例: #

`private` `static` `void` `jsonPathTest() {`

`    ``JSONObject json = jsonTest();``//调用自定义的jsonTest()方法获得json对象，生成上面的json`

`    ``//输出book[0]的author值`

`    ``String author = JsonPath.read(json,``"$.store.book[0].author"``);   `

`    ``//输出全部author的值，使用Iterator迭代`

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

`    ``//输出book[*]中category == 'reference'的book`

`    ``List<Object> books = JsonPath.read(json,``"$.store.book[?(@.category == 'reference')]"``);              `

`    ``//输出book[*]中price>10的book`

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

`    ``//输出book[*]中含有isbn元素的book`

`    ``List<Object> books = JsonPath.read(json,``"$.store.book[?(@.isbn)]"``);`

`    ``//输出该json中所有price的值`

`    ``List<Double> prices = JsonPath.read(json,``"$..price"``);`

`    ``//可以提前编辑一个路径，并多次使用它`

`    ``JsonPath path = JsonPath.compile(``"$.store.book[*]"``);`

`    ``List<Object> books = path.read(json);`

`}`

装载于:[http://www.ibloger.net/article/2329.html][http_www.ibloger.net_article_2329.html]，更加详细的内容请看这篇文章。

[https_github.com_json-path_JsonPath]: https://github.com/json-path/JsonPath
[http_www.ibloger.net_article_2329.html]: http://www.ibloger.net/article/2329.html