Regex-Sonderzeichen für eine wörtliche Suche escapen

Wörtlicher Text lässt sich nicht immer direkt in einen regulären Ausdruck einsetzen. Zeichen wie Punkt, Fragezeichen, eckige Klammer oder Rückwärtsschrägstrich sind Anweisungen der Regex-Syntax. Ein nicht escapeter Wert kann deshalb den falschen Text treffen oder sogar das Muster ungültig machen. Diese Fähigkeit wandelt eine Zeichenfolge in ein ECMAScript-Musterfragment um, das jedes Regex-Metazeichen wörtlich behandelt. Sie eignet sich für Suchbegriffe, Dateinamen, Kennungen, Beschriftungen und andere von Benutzern gelieferte Werte, die ohne Bedeutungsänderung Teil eines regulären Ausdrucks werden sollen.

Wörtlichen Text in ein sicheres Musterfragment umwandeln

Senden Sie im Feld text genau den Wert, den ein regulärer Ausdruck finden soll. Das Ergebnis enthält escaped, ein Musterfragment, in dem jedem ECMAScript-Regex-Metazeichen ein Rückwärtsschrägstrich vorangestellt ist. Gewöhnliche Buchstaben, Ziffern, Leerzeichen, Satzzeichen ohne Regex-Bedeutung, Zeilenumbrüche und Unicode-Zeichen bleiben unverändert.

Ein Punkt steht in einem regulären Ausdruck beispielsweise normalerweise für ein beliebiges Zeichen; ein escapeter Punkt meint dagegen einen tatsächlichen Punkt. Runde Klammern bilden üblicherweise eine Gruppe, eckige Klammern öffnen eine Zeichenklasse, geschweifte Klammern können eine Wiederholungszahl einleiten und Fragezeichen oder Sternchen steuern Wiederholungen. Durch das Escapen dieser Symbole bleibt die wörtliche Bedeutung des ursprünglichen Werts erhalten.

Das zurückgegebene Fragment enthält weder Schrägstrich-Begrenzer noch Flags. Sie können es daher direkt an den RegExp-Konstruktor übergeben, in ein größeres Muster einbauen oder als Musterkörper speichern. Eine leere Zeichenfolge ist gültig und liefert einen leeren escaped-Wert, weil keine Zeichen umzuwandeln sind.

Escapeten Wert mit bewusster Regex-Syntax kombinieren

Das Escapen ist besonders nützlich, wenn ein Teil des Musters aus Daten stammt und ein anderer bewusst als Regex-Syntax geschrieben wird. Angenommen, eine Anwendung soll einen vom Benutzer angegebenen Produktcode nur am Anfang einer Zeile finden. Escapen Sie zuerst den Produktcode und fügen Sie anschließend selbst den Anfangsanker sowie die gewünschte Begrenzungslogik hinzu.

Diese Trennung hält die vertrauenswürdige Musterstruktur und den wörtlichen Inhalt auseinander. Escapen Sie nicht erst das vollständig zusammengesetzte Muster, denn dadurch würden auch absichtlich aktive Anker, Gruppen, Alternativen oder Quantifizierer neutralisiert. Die Ausgabe ist für den Körper eines ECMAScript-Musters bestimmt und nicht für JavaScript-Quelltextnotation.

Dieser Unterschied ist wichtig: Schrägstriche haben für den RegExp-Konstruktor keine besondere Bedeutung und bleiben daher erhalten. Soll das Ergebnis in einem mit Schrägstrichen begrenzten Regex-Literal in erzeugtem JavaScript-Quelltext stehen, ist das Escapen des Quelltextbegrenzers eine eigene Aufgabe. In normalem Anwendungscode sollten Sie die escapete Zeichenfolge an new RegExp übergeben und die Flags separat auswählen.

Garantie verstehen und umgebenden Entwurf prüfen

Die Umwandlung ist deterministisch und linear: Sie durchläuft die übergebene Zeichenfolge und stellt den Zeichen, welche die ECMAScript-Syntax regulärer Ausdrücke steuern, einen Rückwärtsschrägstrich voran. Sie nutzt kein Netzwerk, führt den erzeugten Ausdruck nicht aus, wählt keine Flags, ergänzt keine Anker und entscheidet nicht über Groß- und Kleinschreibung. Diese Entscheidungen gehören in die umgebende Anwendung, weil sie das Trefferverhalten und nicht die wörtliche Sicherheit verändern.

Jedes dieser Formate besitzt eigene Escape-Regeln; bei der Kombination mit Regex-Escaping muss jede Schicht an der richtigen Grenze angewendet werden. Testen Sie das vollständige Muster nach dem Zusammensetzen mit repräsentativen positiven und negativen Beispielen, besonders bei optionalen Abschnitten oder Alternativen um das escapete Fragment. So werden Zahlen, Arrays, Objekte, null oder boolesche Werte nicht unbemerkt zu überraschendem Mustertext.