Flutter数据缓存插件quote_buffer的使用

Flutter数据缓存插件quote_buffer的使用

在源代码生成过程中，通常需要将生成的字符串用（转义后的）引号包围。这种被引号包围的字符串被称为quoted strings。手动添加引号可能会导致错误和重复操作，特别是在处理一组字符串项时。

quote_buffer 包提供了一个名为 <code>Quote</code> 的扩展，该扩展基于 Dart 的 <code>StringBuffer</code> 类，并提供了方法来将单个对象或对象列表转换为 quoted strings。

使用

要使用此库，请在你的 pubspec.yaml 文件中包含 <code>quote_buffer</code> 作为依赖项。下面的章节列出了提供的方法并展示了通过打印缓冲区内容获得的控制台输出。

1. writeQ(Object obj, {QuotationMark delimiter})

   将 <em>delimiter</em>、<em>obj</em>、<em>delimiter</em> 写入缓冲区。

   import 'package:quote_buffer/quote_buffer.dart';
   
   final b = StringBuffer();
   b.writeQ(29);
   expect(b.toString(), '\'29\'');
   print(b.toString()); // 控制台输出如下
   

   控制台输出：

   '29'
   

2. writelnQ(Object obj, {QuotationMark delimiter})

   将 <em>delimiter</em>、<em>obj</em>、<em>delimiter</em>、<em>换行符号</em> 写入缓冲区。

   import 'package:quote_buffer/quote_buffer.dart';
   
   final b = StringBuffer();
   b.writelnQ('name', delimiter: QuotationMark.double);
   expect(b.toString(), '\"name\"\n');
   print(b.toString()); // 控制台输出如下
   print('--- ---');
   

   控制台输出：

   "name"
   
   --- ---
   

3. writeAllQ(Iterable objects, {String separator, QuotationMark delimiter})

   将 <em>delimiter</em>、<em>第一个对象</em>、<em>delimiter</em> 等写入缓冲区。

   import 'package:quote_buffer/quote_buffer.dart';
   
   final b = StringBuffer();
   b.writeAllQ(
     ['one', 'two', 'three'],
     separator: ', ',
   );
   expect(b.toString(), '\'one\', \'two\', \'three\'');
   print(b.toString()); // 控制台输出如下
   

   控制台输出：

   'one', 'two', 'three'
   

4. writelnAllQ(Iterable objects, {String separator1, String separator2, QuotationMark delimiter})

   按顺序写入 <em>objects</em>：<em>delimiter</em>、<em>objects[0]</em>、<em>separator1</em>、<em>delimiter</em>、<em>separator2</em>、<em>换行符号</em> 等。

   import 'package:quote_buffer/quote_buffer.dart';
   
   final b = StringBuffer();
   b.writelnAllQ(
     ['one', 'two', 'three'],
     separator1: ' #',
     separator2: ',',
     delimiter: QuotationMark.double,
   );
   expect(b.toString(), '\"one #\",\n\"two #\",\n\"three\"');
   print(b.toString()); // 控制台输出如下
   print('--- ---');
   

   控制台输出：

   "one #",
   "two #",
   "three"
   
   --- ---
   

示例

位于 <a href="https://github.com/simphotonics/quote_buffer/tree/main/example" rel="ugc">example</a> 文件夹中的示例展示了如何使用 <a href="https://pub.dev/documentation/quote_buffer/latest/quote_buffer/Quote.html"><code>Quote</code></a> 扩展简化生成包含转义引号的字符串字面量的过程。

一个演示程序可以在终端中运行，导航到你本地拷贝的库的根目录并使用以下命令：

$ dart example/bin/example.dart

示例代码如下：

import 'package:quote_buffer/quote_buffer.dart';

/// 要运行此程序，请导航至包 `quote_buffer` 的根目录并使用：
/// ```Console
/// $ dart example/bin/example.dart
/// ```
/// 然后按回车键。
void main(List<String> args) {
  final reset = '\u001B[0m';
  String green(String input) => '\u001B[32m$input$reset';
  String blue(String input) => '\u001B[34m$input$reset';
  String yellow(String input) => '\u001B[33m$input$reset';

  final strings = <String>['one', 'two', 'three'];
  strings.addAll(args);

  final buffer = StringBuffer();

  print(green('-------------------------------'));
  print(green('QuoteBuffer Extension - Example'));
  print(green('-------------------------------'));

  // 添加: '\'1\'' (注意: 对象会先转换为字符串)
  print(yellow('// 添加引号。'));
  print(blue('buffer.writeQ(29);'));
  buffer.writeQ(29);
  print(buffer.toString());
  buffer.clear();

  // 添加: '\'name\'\n'
  print(yellow('// 添加双引号和换行。'));
  print(blue('buffer.writelnQ(\'name\', delimiter: QuotationMark.double);'));
  buffer.writelnQ('name', delimiter: QuotationMark.double);
  print(buffer.toString());
  buffer.clear();

  // 输出:
  // 'one', 'two', 'three', 'four'
  print(yellow('// 添加分隔符和引号。'));
  buffer.writeAllQ(strings);
  print(blue('buffer.writeAllQ([\'one\',\'two\',\'three\',\'four\'], separator: \', \');'));
  print(buffer.toString());
  buffer.clear();

  print(yellow('// 添加分隔符1, 引号, 分隔符2, 换行。'));
  print(blue(
    'buffer.writelnAllQ([\'one\',\'two\',\'three\',\'four\'], separator1: \'#\', separator2: \',\');',
  ));
  buffer.writelnAllQ(
    strings,
    separator1: '#',
    separator2: ',',
    delimiter: QuotationMark.double,
  );
  print(buffer.toString());
}