Flutter文本解析插件text_parser的使用

Flutter项目中，text_parser是一个非常实用的Dart包，用于根据预设或自定义正则表达式模式灵活地解析文本。它能够帮助开发者轻松识别和处理文本中的URL、电子邮件地址、电话号码等特定格式的内容。本文将详细介绍该插件的基本用法，并提供完整的示例代码。

一、基础用法

1. 使用预设匹配器（URL/电子邮件地址/电话号码）

text_parser提供了几个内置的匹配器，包括：

• EmailMatcher：用于匹配电子邮件地址。
• UrlMatcher：用于匹配以"http"开头的完整URL。
• TelMatcher：用于匹配电话号码。
• UrlLikeMatcher：除了标准URL外，还可以匹配类似URL的形式（如example.com）。

以下是一个简单的例子，展示了如何使用其中三个预设匹配器（不包括UrlLikeMatcher）来解析包含不同类型的文本字符串。

import 'package:text_parser/text_parser.dart';

void main() {
  const text = 'abc https://example.com/sample.jpg. def\n'
      'john.doe@example.com +1-012-3456-7890';

  final parser = TextParser(
    matchers: const [
      EmailMatcher(),
      UrlMatcher(),
      TelMatcher(),
    ],
  );
  final elements = parser.parseSync(text);
  elements.forEach(print);
}

输出结果为：

TextElement(matcherType: TextMatcher, matcherIndex null, offset: 0, text: abc , groups: [])
TextElement(matcherType: UrlMatcher, matcherIndex 1, offset: 4, text: https://example.com/sample.jpg, groups: [])
TextElement(matcherType: TextMatcher, matcherIndex null, offset: 34, text: . def\n, groups: [])
TextElement(matcherType: EmailMatcher, matcherIndex 0, offset: 40, text: john.doe@example.com, groups: [])
TextElement(matcherType: TextMatcher, matcherIndex null, offset: 60, text:  , groups: [])
TextElement(matcherType: TelMatcher, matcherIndex 2, offset: 61, text: +1-012-3456-7890, groups: [])

二、进阶功能

1. 同步与异步解析

parseSync()方法会同步执行解析操作，这可能会阻塞UI线程。为了避免这种情况，可以使用parse()方法，默认情况下会在独立的isolate中运行解析任务，从而避免影响主线程性能。对于Web平台，由于dart:isolate不受支持，因此在这种情况下useIsolate: true的效果等同于false。

2. 自定义模式匹配

除了使用预设的匹配器之外，你还可以通过继承TextMatcher类或者直接创建PatternMatcher实例来自定义匹配规则。例如，下面的例子演示了如何创建一个专门用于解析HTML链接标签<a>的匹配器。

class ATagMatcher extends TextMatcher {
  const ATagMatcher()
      : super(
          r'\<a\s(?:.+?\s)*?href="(.+?)".*?\>'
          r'\s*(.+?)\s*'
          r'\</a\>',
        );
}

然后可以在解析器中使用这个自定义匹配器：

const text = '''
<a class="bar" href="https://example.com/">
  Content inside tags
</a>
''';

final parser = TextParser(
  matchers: const [ATagMatcher()],
  dotAll: true,
);
final elements = parser.parseSync(text, onlyMatches: true);
print(elements.first.groups); // 输出: [https://example.com/, Content inside tags]

3. 精确匹配与分组捕获

ExactMatcher允许你指定一组确切的字符串进行匹配，而不会受到其他字符的影响。此外，每个TextElement对象都包含一个名为groups的属性，它可以用来获取正则表达式中所有被捕获的子串。

例如，对于Markdown风格的链接格式[foo](bar)，我们可以定义如下模式：

r'\[(.+?)\]\((.*?)\)'

当它匹配到[foo](bar)时，groups将返回['foo', 'bar']。

三、完整示例

接下来给出一个综合性的例子，涵盖了上述提到的各种特性。

import 'package:text_parser/text_parser.dart';

void main() {
  const text = '''
    abc https://example.com/sample.jpg. def
    john.doe@example.com 911 +1-012-3456-7890
    01111111111 tel:02222222222
    <a class="bar" href="https://example.com/">
      Content inside tags
    </a>
  ''';

  // 使用预设匹配器
  var parser = TextParser(
    matchers: const [
      EmailMatcher(),
      UrlMatcher(),
      TelMatcher(),
    ],
  );
  var elements = parser.parseSync(text);
  elements.forEach(print);

  print('-' * 20);

  // 提取仅限电话号码元素作为可迭代对象
  final telElements = elements.whereMatcherType<TelMatcher>();
  telElements.forEach(print);

  print('-' * 20);

  // 更换匹配器并重新解析
  parser.matchers = const [TelMatcher(r'(?<=tel:)\d{11}')];
  elements = parser.parseSync(text);
  elements.forEach(print);

  print('-' * 20);

  // 获取仅匹配项
  elements = parser.parseSync(text, onlyMatches: true);
  elements.forEach(print);

  print('-' * 20);

  // 多个相同类型的匹配器
  parser = TextParser(
    matchers: const [
      PatternMatcher('Pattern A'),
      PatternMatcher('Pattern B'),
    ],
  );
  elements = parser.parseSync('Pattern A & Pattern B');
  elements.forEach(print);

  print('-' * 20);

  // 捕获未命名和命名分组
  parser = TextParser(
    matchers: const [
      PatternMatcher(r'(?<year>\d{4})-(\d{2})-(?<day>\d{2})'),
    ],
  );
  elements = parser.parseSync('2020-01-23', onlyMatches: true);
  elements.forEach(print);

  print('-' * 20);

  // 自定义<a>标签匹配器
  parser = TextParser(matchers: const [ATagMatcher()], dotAll: true);
  elements = parser.parseSync(text, onlyMatches: true);
  elements.forEach(print);
}

class ATagMatcher extends TextMatcher {
  const ATagMatcher()
      : super(
          r'\&lt;a\s(?:.+?\s)*?href="(.+?)".*?\&gt;'
          r'\s*(.+?)\s*'
          r'\&lt;/a\&gt;',
        );
}

以上就是关于text_parser插件在Flutter项目中的使用介绍，希望对大家有所帮助！