Aus öffentlichen Paketdaten erstellte Orientierung.
Ein Dart-Paket, das Pfadmuster wie '/user/:id' in reguläre Ausdrücke für die Routenübereinstimmung konvertiert. Es ermöglicht dynamische Pfadanalyse durch Unterstützung von Parametererfassung, Platzhaltern und optionalen Segmenten. Ideal für die Erstellung von Routing-Systemen in Flutter-Apps, bietet es eine leichte Lösung zur Übereinstimmung von URLs mit definierten Routen. Das Paket ist auf allen wichtigen Plattformen kompatibel und lässt sich nahtlos in bestehende Navigationslogik integrieren.
Anwendungsfälle
Dynamische Routenübereinstimmung
URL-Musteranalyse
Implementierung des Navigationsystems
Route-Parameter-Auszug
Benutzerdefinierte Routerentwicklung
API-Endpunktübereinstimmung
Hauptmerkmale
Unterstützt benannte Parameter (z. B. :id)
Behandelt optionale Segmente
Enthält Platzhalterübereinstimmung
Erzeugt wiederverwendbare RegExp-Objekte
Leicht und schnell
Plattformübergreifende Kompatibilität
Geeignet für
Entwickler, die benutzerdefinierte Router erstellen
Apps, die flexible URL-Routing benötigen
Frontend-Navigation mit dynamischen Pfaden
Komplexe Routenmuster analysieren
Integration mit bestehenden Routing-Bibliotheken
Hinweise
Verarbeitet Abfrageparameter nicht
Keine integrierte Middleware-Unterstützung
Benötigt manuelle Routenauflösung
Beschränkt auf Pfad-Level-Übereinstimmung
Nicht für den vollständigen Einsatz als HTTP-Server vorgesehen
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
path_to_regexp
Converts a path such as /user/:id into a regular expression.
Matching
pathToRegExp() converts a path specification into a regular expression that
matches conforming paths.
By default, parameters match anything until the next delimiter. This behavior
can be customized by specifying a regular expression in parentheses following
a parameter name.
Parameters can be extracted from a path specification during conversion into a
regular expression.
final parameters = <String>[];
final regExp = pathToRegExp('/user/:id', parameters: parameters);
parameters; // => ['id']
Extracting Arguments
extract() maps the parameters of a path specification to their corresponding
arguments in a match.
final parameters = <String>[];
final regExp = pathToRegExp('/user/:id', parameters: parameters);
final match = regExp.matchAsPrefix('/user/12');
extract(parameters, match); // => {'id': '12'}
Generating
pathToFunction() converts a path specification into a function that generates
matching paths.
final toPath = pathToFunction('/user/:id');
toPath({'id': '12'}); // => '/user/12'
Tokens
parse() converts a path specification into a list of tokens, which can be
used to create a regular expression or path generating function.
final tokens = parse('/users/:id');
final regExp = tokensToRegExp(tokens);
final toPath = tokensToFunction(tokens);
Similar to pathToRegExp(), parameters can also be extracted during parsing.
final parameters = <String>[];
final tokens = parse('/users/:id', parameters: parameters);
If you intend to match and generate paths from the same path specification,
parse() and the token-based functions should be preferred to their path-based
counterparts. This is because the token-based functions can reuse the same
tokens, whereas each path-based function must parse the path specification anew.
Options
Prefix Matching
By default, a regular expression created by pathToRegExp or tokensToRegExp
matches the entire input. However, if the optional prefix argument is true, it
may also match as a prefix until a delimiter.
final regExp = pathToRegExp('/user/:id', prefix: true);
regExp.hasMatch('/user/12/details'); // => true
Case Sensitivity
By default, a regular expression created by pathToRegExp or tokensToRegExp
is case sensitive. To create a case insensitive regular expression, set
caseSensitive to false.
final regExp = pathToRegExp('/user/:id', caseSensitive: false);
regExp.hasMatch('/USER/12'); // => true