Flutter构建HTTP查询字符串插件http_query_string的使用

Flutter构建HTTP查询字符串插件http_query_string的使用

http_query_string 是一个符合 RFC1867 规范的查询字符串编码和解码器，兼容 PHP 和 jQuery 传统的嵌套数组/对象语法。它受到 PHP 的 http_build_query() 和 parse_str() 函数以及 Node.js 的 qs 包的启发。

安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  http_query_string: ^1.0.0

然后运行 flutter pub get 来安装依赖。

使用示例

1. 编码查询字符串

下面是一个完整的示例，展示如何将 Dart 对象转换为查询字符串：

import 'package:http_query_string/http_query_string.dart';

void main() {
  // 创建一个 Encoder 实例
  var encoder = Encoder();

  // 定义一个包含各种数据类型的 Map
  var data = <String, dynamic>{
    "encode": "bar with space",
    "int": 42,
    "float": 42.367,
    "negative": -23,
    "true": true,
    "false": false,
    "null": null,
    "set": {"a", "b"},
    "list": [
      "bar",
      "foo",
    ],
    "map": {
      "key": "value"
    },
  };

  // 将 Map 转换为查询字符串
  var qs = encoder.convert(data);

  // 输出查询字符串
  print(qs);
}

输出结果：

encode=bar+with+space&int=42&float=42.367&negative=-23&true=1&false=0&set%5B0%5D=a&set%5B1%5D=b&list%5B0%5D=bar&list%5B1%5D=foo&map%5Bkey%5D=value

2. 解码查询字符串

接下来，我们展示如何将查询字符串转换回 Dart 对象：

import 'package:http_query_string/http_query_string.dart';

void main() {
  // 创建一个 Decoder 实例
  var decoder = Decoder();

  // 定义一个查询字符串
  var qs = "encode=bar+with+space&int=42&float=42.367&negative=-23&true=1&false=0&set%5B0%5D=a&set%5B1%5D=b&list%5B0%5D=bar&list%5B1%5D=foo&map%5Bkey%5D=value";

  // 将查询字符串转换为 Map
  var newObject = decoder.convert(qs);

  // 输出转换后的 Map
  print(newObject);
}

输出结果：

{
  "encode": "bar with space",
  "int": 42,
  "float": 42.367,
  "negative": -23,
  "true": true,
  "false": false,
  "null": null,
  "set": ["a", "b"],
  "list": ["bar", "foo"],
  "map": {"key": "value"}
}

3. 处理嵌套结构

http_query_string 还支持处理嵌套的数组和对象。以下是一个示例，展示如何处理嵌套结构：

import 'package:http_query_string/http_query_string.dart';

void main() {
  // 创建一个 Encoder 实例
  var encoder = Encoder();

  // 定义一个包含嵌套结构的 Map
  var nestedData = <String, dynamic>{
    "user": {
      "name": "John Doe",
      "age": 30,
      "address": {
        "street": "123 Main St",
        "city": "Anytown"
      }
    },
    "hobbies": ["reading", "coding", "traveling"]
  };

  // 将嵌套的 Map 转换为查询字符串
  var nestedQs = encoder.convert(nestedData);

  // 输出查询字符串
  print(nestedQs);

  // 创建一个 Decoder 实例
  var decoder = Decoder();

  // 将查询字符串转换回嵌套的 Map
  var decodedNestedObject = decoder.convert(nestedQs);

  // 输出转换后的嵌套 Map
  print(decodedNestedObject);
}

输出结果：

user%5Bname%5D=John+Doe&user%5Bage%5D=30&user%5Baddress%5D%5Bstreet%5D=123+Main+St&user%5Baddress%5D%5Bcity%5D=Anytown&hobbies%5B0%5D=reading&hobbies%5B1%5D=coding&hobbies%5B2%5D=traveling

{
  "user": {
    "name": "John Doe",
    "age": 30,
    "address": {
      "street": "123 Main St",
      "city": "Anytown"
    }
  },
  "hobbies": ["reading", "coding", "traveling"]
}