Flutter数据处理与查询插件jsonata的使用

特性

Jsonata插件为Flutter提供了使用Jsonata表达式查询和转换JSON数据的功能。

开始使用

权限设置

由于该插件使用了最新版本的jsonata，因此需要启用互联网权限：

Android:

在AndroidManifest.xml文件中，添加以下权限以允许访问互联网：

<uses-permission android:name="android.permission.INTERNET" />

macOS / iOS:

对于macOS和iOS，你需要配置权限。在DebugProfile.entitlements和ReleaseProfile.entitlements文件中，添加以下键以允许网络访问：

DebugProfile.entitlements:

<key>com.apple.security.network.client</key>
<true/>

ReleaseProfile.entitlements:

<key>com.apple.security.network.client</key>
<true/>

Info.plist:

<key>NSAllowsArbitraryLoads</key>
<true/>

使用方法

插件允许你通过应用Jsonata查询来提取特定信息。以下是三种使用方式：

方式一

直接评估Jsonata表达式（jql）。

var json = await Jsonata(jql).evaluate(data);

方式二

创建一个Jsonata表达式对象，然后对其数据进行评估。

var expression = Jsonata(jql);
var json = await expression.evaluate(data);

方式三

先显式设置Jsonata实例的数据，然后用指定表达式查询。

var jsonata = Jsonata();
jsonata.set(data: data);
var json = await jsonata.query(jql);

示例代码

以下是完整的示例代码，展示了如何在Flutter应用中使用Jsonata插件。

import 'package:flutter/material.dart';
import 'package:jsonata/jsonata.dart';

void main() {
  runApp(
    const MaterialApp(home: MyHomePage()), // 使用MaterialApp
  );
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  [@override](/user/override)
  // ignore: library_private_types_in_public_api
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String data = '''{
        "FirstName": "Fred",
        "Surname": "Smith",
        "Age": 28,
        "Gender": "Male",
        "Married": false,
        "Address": {
          "Street": "Hursley Park",
          "City": "Winchester",
          "Postcode": "SO21 2JN"
        },
        "Children": ["John","Jane","Jill"]
      }''';
  String jql = "Address.City='Winchester'";
  String result = "";

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  query() async {
    try {
      // 方式一:
      //var json = await Jsonata(jql).evaluate(data);

      // 方式二:
      //var expression = Jsonata(jql);
      //var json = await expression.evaluate(data);

      // 方式三:
      var jsonata = Jsonata();
      jsonata.set(data: data);
      var json = await jsonata.query(jql);

      setState(() {
        result = json.toString();
      });
    } catch (e) {
      setState(() {
        result = 'Error: ${e.toString()}';
      });
    }
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: const Text('Jsonata查询应用'),
      ),
      body: SingleChildScrollView(
        child: Padding(
          padding: const EdgeInsets.all(16.0),
          child: Column(
            children: [
              TextFormField(
                style: Theme.of(context).textTheme.bodySmall,
                maxLines: null,
                maxLength: 120,
                decoration: InputDecoration(
                  hintText: data,
                  border: const OutlineInputBorder(),
                ),
                onChanged: (value) => data = value,
              ),
              TextFormField(
                style: Theme.of(context).textTheme.bodySmall,
                maxLines: 3,
                maxLength: 120,
                decoration: InputDecoration(
                  hintText: jql,
                  border: const OutlineInputBorder(),
                ),
                onChanged: (value) => jql = value,
              ),
              const SizedBox(height: 20),
              ElevatedButton(
                onPressed: query,
                child: const Text('查询'),
              ),
              const SizedBox(height: 20),
              Text(
                result,
                style: Theme.of(context).textTheme.bodySmall,
              ),
            ],
          ),
        ),
      ),
    );
  }
}