Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev0.2.1

rfc_6901

JSON Pointer (RFC 6901). Lê/escrita valores referenciados em documentos JSON.

AndroidiOSWebmacOSWindowsLinux
Downloads em 30 dias
898 mil
Curtidas
32
Pontos Pub
160

Instalar pacote

flutter pub add rfc_6901

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

O pacote rfc_6901 implementa o JSON Pointer (RFC 6901) para Dart e Flutter, permitindo navegação segura e manipulação de documentos JSON. Ele permite ler e escrever valores em estruturas JSON aninhadas usando sintaxe de ponteiro, como /foo/0/bar. Isso é particularmente útil para manipulação dinâmica de dados em APIs, arquivos de configuração ou gerenciamento de estado, onde é necessário acesso preciso a campos JSON sem analisar toda a estrutura. O pacote suporta todas as principais plataformas, incluindo móvel, web e desktop.

Casos de uso

  • Acessando valores JSON aninhados dinamicamente
  • Atualizando campos específicos em um documento JSON
  • Análise de respostas da API com estrutura variável
  • Implementando atualizações parciais na gestão de estado
  • Trabalhando com arquivos de configuração que usam chaves aninhadas

Principais recursos

  • Suporta o padrão JSON Pointer RFC 6901
  • Recuperação e atribuição seguras de valores
  • Manipula arrays e objetos de forma uniforme
  • Compatibilidade multiplataforma
  • Pé de dependência mínima

Indicado para

  • Desenvolvedores trabalhando com dados JSON dinâmicos
  • Clientes de API que precisam de acesso seletivo a campos
  • Sistemas de gerenciamento de estado que exigem operações de patch
  • Analisadores de configuração com aninhamento profundo

Considerações

  • Requer sintaxe válida de JSON Pointer
  • Não valida caminhos de destino em tempo de execução
  • Limitado a operações de leitura/gravação em JSON existentes
  • Não adequado para transformações JSON complexas

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

RFC 6901 JSON Pointer

JSON Pointer (RFC 6901) implementation in Dart.

Features:

  • Reads, writes, removes values
  • Fully implements the standard, including the - character
  • Can build the entire path, e.g. /foo/bar/-/baz
  • No external dependencies
  • 100% test coverage

Constructing pointers

A JSON Pointer object can be parsed from a string expression. The expression MUST be a valid non-empty JSON Pointer expression with "/" and "~" escaped.

final pointer = JsonPointer('/foo/0/bar'); // a valid non-empty pointer
final alsoPointer = JsonPointer('/foo/-'); // a valid non-empty pointer with a special "-" reference
final emptyPointer = JsonPointer(); // an empty pointer

JsonPointer('oops'); // throws a FormatException: expression doesn't start with "/"
JsonPointer('/foo/~'); // throws a FormatException: unescaped "~"

It can also be built from individual reference tokens. In such case, it will escape the tokens automatically.

final pointer = JsonPointer.build(['foo', '0', 'bar/']); // Makes "/foo/0/bar~1"
final longerPointer = JsonPointerSegment('-', pointer); // Makes "/foo/0/bar~1/-"
final evenLongerPointer = JsonPointerSegment('wow', longerPointer); // Makes "/foo/0/bar~1/-/wow"

Reading and writing values

The read() method returns the referenced value. The write() method returns a copy of the document with the referenced value replaced by the new value.

import 'dart:convert';

import 'package:rfc_6901/rfc_6901.dart';

void main() {
  const json = '{"foo": [{"bar": 42}]}';
  final document = jsonDecode(json);
  print('Original document: $document');

  [
    '/foo', // reads the array
    '/foo/0', // reads the first element of the array
    '/foo/0/bar', // reads 42
  ].forEach((expression) {
    final pointer = JsonPointer(expression);
    print('Pointer "$pointer" reads ${pointer.read(document)}');
  });

  [
    '/foo/0/bar', // {foo: [{bar: banana}]}
    '/foo/-', // {foo: [{bar: 42}, banana]}
    '/a/b/-/c/d', // {foo: [{bar: 42}], a: {b: [{c: {d: banana}}]}}
  ].forEach((expression) {
    final pointer = JsonPointer(expression);
    final d = pointer.write(document, 'banana');
    print('Add a banana at "$pointer": $d');
  });
}

Categorias

Repositório-fonte

Projetos que usam este pacote