Implementação do RFC 9535 - JSONPath: Expressões de consulta para JSON. Lê e escreve valores em objetos JSON analisados usando consultas como `$.store.book[2].price`.
Orientação gerada a partir de informações públicas. Apenas para referência.
json_path é um pacote Dart que implementa o RFC 9535 para JSONPath, permitindo consultas poderosas e manipulação de dados JSON. Ele permite aos usuários ler e escrever valores em objetos JSON analisados usando expressões de caminho expressivas, como `$.store.book[2].price`. O pacote suporta a sintaxe padrão do JSONPath e é compatível com múltiplas plataformas, incluindo Android, iOS, Web, macOS, Windows e Linux. Ideal para extração e transformação dinâmica de dados em aplicações Flutter.
Casos de uso
Extraindo valores JSON aninhados
Atualizando campos específicos do JSON
Filtrando arrays em dados JSON
Análise de estruturas JSON complexas
Manuseio de configuração dinâmica
Transformação de dados em APIs
Principais recursos
Conformidade total com o RFC 9535
Suporta operações de leitura e escrita
Sintaxe de caminho intuitiva, como `$.store.book[2].price`
Compatibilidade multiplataforma
Leve e rápido
Tratamento robusto de erros
Indicado para
Aplicativos Flutter que precisam de consultas JSON dinâmicas
Serviços de back-end processando cargas úteis JSON
Sistemas de gerenciamento de configuração
Clientes de API com estruturas de resposta variáveis
Pipelines de dados que exigem manipulação flexível de JSON
Considerações
Requer entrada JSON válida
O desempenho pode variar com JSONs profundamente aninhados ou grandes
Limitado à sintaxe JSONPath definida no RFC 9535
Não adequado para tipos de dados não JSON
Pode ser necessário validação cuidadosa em entradas não confiáveis
README original
Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.
RFC 9535 - JSONPath: Query Expressions for JSON in Dart
JSONPath defines a string syntax for selecting and extracting JSON (RFC 8259) values from within a given JSON value.
This library is a Dart implementation of the RFC 9535 JsonPath specification. It is also expected to pass the latest version
of the Compliance Test Suite. If you find a missing or incorrectly implemented feature, please open an issue.
For installation instructions and a detailed API documentation, see the pub.dev page.
Usage example:
import'dart:convert';
import'package:json_path/json_path.dart';
voidmain() {
final json = jsonDecode('''
{
"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
}
}
}
''');
final prices = JsonPath(r'$..price');
print('All prices in the store:');
/// The following code will print:////// $['store']['book'][0]['price']: 8.95/// $['store']['book'][1]['price']: 12.99/// $['store']['book'][2]['price']: 8.99/// $['store']['book'][3]['price']: 22.99/// $['store']['bicycle']['price']: 19.95
prices
.read(json)
.map((match) => '${match.path}:\t${match.value}')
.forEach(print);
}
Data manipulation
Each JsonPathMatch produced by the .read() method contains the .pointer property which is a valid JSON Pointer
and can be used to alter the referenced value. If you only need to manipulate JSON data,
check out my JSON Pointer implementation.
User-defined functions
The JSONPath parser may be extended with user-defined functions. The user-defined functions
take precedence over the built-in ones specified by the standard. Currently, only
functions of 1 and 2 arguments are supported.
To create your own function:
Import package:json_path/fun_sdk.dart.
Create a class implementing either Fun1 (1 argument) or Fun2 (2 arguments).
To use it:
Create a new JsonPathParser with your function: final parser = JsonPathParser(functions: [MyFunction()]);
Parse the expression: final jsonPath = parser.parse(r'$[?my_function(@)]');
For more details see the included example.
This package comes with a few non-standard functions which you might find useful.
count(<NodeList>) - returns the number of nodes selected by the argument
index(<SingularNodeList>) - returns the index under which the array element is referenced by the parent array
key(<SingularNodeList>) - returns the key under which the object element is referenced by the parent object
is_array(<Maybe>) - returns true if the value is an array
is_boolean(<Maybe>) - returns true if the value is a boolean
is_number(<Maybe>) - returns true if the value is a number
is_object(<Maybe>) - returns true if the value is an object
is_string(<Maybe>) - returns true if the value is a string
reverse(<Maybe>) - returns the reversed string
siblings(<NodeList>) - returns the siblings for the nodes
xor(<bool>, <bool>) - returns the XOR of two booleans arguments
To use them, import package:json_path/fun_extra.dart and pass the functions to the JsonPath() constructor:
final jsonPath = JsonPathParser(functions: [
constKey(),
constReverse(),
]).parse(r'$[?key(@) == reverse(key(@))]');