Flutter正则表达式构建插件regex_builder的使用

Flutter正则表达式构建插件regex_builder的使用

特性

RegexBuilder 遵循 RegExp 的规范，因此所有方法和属性都可以使用。

示例：查找HTML标签

以下示例展示了如何在字符串中找到所有的HTML标签。

import 'package:regex_builder/regex_builder.dart';

void main() {
  final regex = RegexBuilder([
    Group([
      Literal('<'),                                   // &
      Group([
          CharacterSet.letter(LetterCase.lower),      // [a-z]
          ZeroOrMore(
            CharacterSet([
              CharacterSet.letter(),                  // [a-zA-Z]
              CharacterSet.number(0, 9),              // [0-9]
            ]),                                       // [a-zA-Z0-9]
          ),                                          // [a-zA-Z0-9]*
        ],                                            // [a-z][a-zA-Z0-9]*
        behavior: GroupBehavior.capture('tag'),
      ),                                              // (?<tag>[a-z][a-zA-Z0-9]*)?
      Literal('>'),                                   // >
    ]),                                               // <(?<tag>[a-z][a-zA-Z0-9]*)>
    Group(
      OneOrMore(AnyCharacter(), greedy: false),       // .+?
      behavior: GroupBehavior.capture(),
    ),                                                // (.+?)
    Literal('</'),                                    // </
    Reference('tag'),                                 // \k<tag>
    Literal('>'),                                     // >
  ]);                                                 // <(?<tag>[a-z][a-zA-Z0-9]*)>(.+?)</\k<tag>>

  final html = '<h1>Hello, world!</h1><a>Google</a>';

  for (final match in regex.allMatches(html)) {
    print('All Match: ${match.group(0)}');
    print('Tag: ${match.group(1)}');
    print('Content: ${match.group(2)}');
  }
}

输出结果

All Match: <h1>Hello, world!</h1>
Tag: h1
Content: Hello, world!
All Match: <a>Google</a>
Tag: a
Content: Google

组件

一个 RegexBuilder 由一组组件组成。可用的组件包括：

• 字面量 (Literal)
• 通配符 (AnyCharacter)
• 选择器 (ChoiceOf)
• 量词 (ZeroOrMore, OneOrMore, Optionally, Repeat)
• 字符集 (CharacterSet)
• 组 (Group)
• 锚点 (Anchor)

字面量

字面量是一个必须精确匹配的字符串。

Literal('abc'); // 这表示模式 'abc'

通配符

通配符是一个匹配任何字符的字符。

AnyCharacter(); // 这表示模式 '.'

注意：要匹配一个字面量的点，应使用 Literal('.')。

选择器

选择器是一组组件，其中任何一个都可能匹配。

ChoiceOf([
  Literal('cat'),
  Literal('dog'),
]); // 这表示模式 'cat|dog'

量词

量词用于指定某个组件应该匹配多少次。

ZeroOrMore

匹配零次或一次。

ZeroOrMore(Literal('a')); // 这表示模式 'a*'

OneOrMore

匹配一次或多次。

OneOrMore(Literal('a')); // 这表示模式 'a+'

Optionally

匹配零次或一次。

Optionally(Literal('a')); // 这表示模式 'a?'

Repeat

匹配特定次数。

Repeat(
  Literal('a'),
  range: RepeatRange.atLeast(3),
); // 这表示模式 'a{3,}'

Repeat(
  Literal('a'),
  range: RepeatRange.atMost(3),
); // 这表示模式 'a{0,3}'

Repeat(
  Literal('a'),
  range: RepeatRange.exactly(3),
); // 这表示模式 'a{3}'

Repeat(
  Literal('a'),
  range: RepeatRange.between(3, 5),
); // 这表示模式 'a{3,5}'

字符集

字符集表示一组字符中的任意一个。

CharacterSet([
  CharacterSet.letter(),
  CharacterSet.number(0, 9),
]); // 这表示模式 '[a-zA-Z0-9]'

组

组是一组必须一起匹配的组件。默认情况下，组是非捕获的。

Group([
  Literal('a'),
  Literal('b'),
]); // 这表示模式 '(?:ab)'

捕获组

捕获组是一组必须一起匹配且会被捕获的组件。

Group([
  Literal('a'),
  Literal('b'),
], behavior: GroupBehavior.capture()); // 这表示模式 '(ab)'

Group([
  Literal('a'),
  Literal('b'),
], behavior: GroupBehavior.capture('group_name')); // 这表示模式 '(?<group_name>ab)'

锚点

锚点是一个匹配字符串开始或结束位置的组件。

Anchor.startOfLine; // 这表示模式 '^'
Anchor.endOfLine; // 这表示模式 '$'

示例代码

import 'package:regex_builder/regex_builder.dart';

void main() {
  final regex = RegexBuilder([
    Group([
      Literal('<'),                                   // &
      Group([
          CharacterSet.letter(LetterCase.lower),      // [a-z]
          ZeroOrMore(
            CharacterSet([
              CharacterSet.letter(),                  // [a-zA-Z]
              CharacterSet.number(0, 9),              // [0-9]
            ]),                                       // [a-zA-Z0-9]
          ),                                          // [a-zA-Z0-9]*
        ],                                            // [a-z][a-zA-Z0-9]*
        behavior: GroupBehavior.capture('tag'),
      ),                                              // (?<tag>[a-z][a-zA-Z0-9]*)?
      Literal('>'),                                   // >
    ]),                                               // <(?<tag>[a-z][a-zA-Z0-9]*)>
    Group(
      OneOrMore(AnyCharacter(), greedy: false),       // .+?
      behavior: GroupBehavior.capture(),
    ),                                                // (.+?)
    Literal('</'),                                    // </
    Reference('tag'),                                 // \k<tag>
    Literal('>'),                                     // >
  ]);                                                 // <(?<tag>[a-z][a-zA-Z0-9]*)>(.+?)</\k<tag>>

  final html = '<h1>Hello, world!</h1><a>Google</a>';

  for (final match in regex.allMatches(html)) {
    print('All Match: ${match.group(0)}');
    print('Tag: ${match.group(1)}');
    print('Content: ${match.group(2)}');
  }
}