4.6 Reguläre Ausdrücke

Ein regulärer Ausdruck (engl. regular expression) ist eine Beschreibung eines Musters (engl. pattern). Reguläre Ausdrücke werden bei der Zeichenkettenverarbeitung beim Suchen und Ersetzen eingesetzt. Für folgende Szenarien bietet die Java-Bibliothek entsprechende Methoden an:

• Frage nach dem kompletten Übereinstimmen: Passt eine Zeichenfolge komplett auf ein Muster? Wir nennen das match.

• Finde Teilstrings: Das Pattern beschreibt nur einen Teilstring, und gesucht sind alle Vorkommen dieses Musters in einem Suchstring.

• Ersetze Teilfolgen: Das Pattern beschreibt Wörter, die durch andere Wörter ersetzt werden.

• Zerlegen einer Zeichenfolge: Das Muster steht für Trennzeichnen, sodass nach dem Zerlegen eine Sammlung von Zeichenfolgen entsteht.

Ein Pattern-Matcher ist die »Maschine«, die reguläre Ausdrücke verarbeitet. Zugriff zu dieser Mustermaschine bietet die Klasse Matcher. Dazu kommt die Klasse Pattern, die die regulären Ausdrücke in einem vorcompilierten Format repräsentiert. Beide Klassen befinden sich im Paket java.util.regex. Um die Sache etwas zu vereinfachen, gibt es bei String zwei kleine Hilfsmethoden, die im Hintergrund auf die Klassen verweisen, um eine einfachere API anbieten zu können; das nennt sich auch Fassaden-Methoden.

4.6.1 Arbeiten mit der Fassade: String.matches()

Die statische Funktion Pattern.matches() und die Objektmethode matches() der Klasse String testen, ob ein regulärer Ausdruck eine Zeichenfolge komplett beschreibt.

System.out.println( Pattern.matches( "'.*'", "'Hallo Welt'" ) ); // true 
System.out.println( "'Hallo Welt'".matches( "'.*'" ) );          // true 
System.out.println( Pattern.matches( "'.*'", "''" ) );           // true 
System.out.println( Pattern.matches( "'.*'", "Hallo Welt" ) );   // false 
System.out.println( Pattern.matches( "'.*'", "'Hallo Welt" ) );  // false

Der Punkt im regulären Ausdruck steht für ein beliebiges Zeichen, und der folgende Stern ist ein Quantifizierer, der wahllos viele beliebige Zeichen erlaubt.

Regeln für reguläre Ausdrücke

Für reguläre Ausdrücke existiert eine ganze Menge von Regeln. Während die meisten Zeichen aus dem Alphabet erlaubt sind, besitzen Zeichen wie der Punkt, die Klammer, ein Sternchen und einige weitere Sonderfunktionen. So maskiert auch ein vorgestelltes »\« das folgende Sonderzeichen aus, was bei besonderen Zeichen wie ».« oder »\« wichtig ist.

Zunächst gilt es, die Anzahl Wiederholungen zu bestimmen. Dazu dient ein Quantifizierer (auch Wiederholungsfaktor genannt). Drei wichtige gibt es. Für eine Zeichenkette X gilt:

Eine Sonderform ist X(?!Y) – das drückt aus, dass der reguläre Ausdruck Y dem regulären Ausdruck X nicht folgen darf. (Die API-Dokumentation spricht von »zero-width negative lookahead«.)

Listing 4.11 RegExDemo.java, main(), Ausschnitt

System.out.println( Pattern.matches( "0", "0" ) );               // true 
System.out.println( Pattern.matches( "0", "1" ) );               // false 
System.out.println( Pattern.matches( "0", "00" ) );              // false 
System.out.println( Pattern.matches( "0*", "0000" ) );           // true 
System.out.println( Pattern.matches( "0*", "01" ) );             // false 
System.out.println( Pattern.matches( "0\\*", "01" ) );           // false 
System.out.println( Pattern.matches( "0\\*", "0*" ) );           // true

Da in regulären Ausdrücken oftmals ein Bereich von Zeichen, etwa alle Buchstaben, abgedeckt werden muss, gibt es die Möglichkeit, Zeichenklassen zu definieren.

Das ›^‹ definiert negative Zeichenklassen, also Zeichen, die nicht vorkommen dürfen. Mit dem ›-‹ lässt sich ein Bereich von Zeichen angeben.

Listing 4.12 RegExDemo.java, main(), Ausschnitt

System.out.println( Pattern.matches( "[01]*", "0" ) );           // true 
System.out.println( Pattern.matches( "[01]*", "01001" ) );       // true 
System.out.println( Pattern.matches( "[0123456789]*", "112" ) ); // true

Daneben gibt es vordefinierte Zeichenklassen, die in erster Linie Schreibarbeit ersparen. Die wichtigsten sind:

Bei den Wortzeichen handelt es sich standardmäßig um die ASCII-Zeichen und nicht um deutsche Zeichen mit unseren Umlauten oder allgemeine Unicode-Zeichen. Eine umfassende Übersicht liefert die API-Dokumentation der Klasse java.util.regex.Pattern.

Listing 4.13 RegExDemo.java, main(), Ausschnitt

System.out.println( Pattern.matches( "\\d*", "112" ) );          // true 
System.out.println( Pattern.matches( "\\d*", "112a" ) );         // false 
System.out.println( Pattern.matches( "\\d*.", "112a" ) );        // true 
System.out.println( Pattern.matches( ".\\d*.", "x112a" ) );      // true

4.6.2 Die Klassen Pattern und Matcher

Der einfache Aufruf matches() auf einem String-Objekt beziehungsweise Pattern.matches() ist nur eine Abkürzung für die Übersetzung eines Patterns und Anwendung von matches():

public boolean 
matches( String regex ) 
{ 
 return Pattern.matches( regex, this ); 
}

public static boolean 
matches( String regex,  
         CharSequence input ) 
{ 
 Pattern p = Pattern.compile( regex ); 
 Matcher m = p.matcher( input ); 
 return m.matches(); 
}

Während String’s Mitläufer-Methode matches() zur Pattern.matches() delegiert, steht hinter der statischen Fassadenfunktion Pattern.matches() die wirkliche Nutzung der beiden zentralen Klassen Pattern für das Muster und Matcher für die Mustermaschine. Für unser erstes Beispiel Pattern.matches("'.*'", "'Hallo Welt'") hätten wir also äquivalent schreiben können:

Pattern p = Pattern.compile( "'.*'" ); 
Matcher m = p.matcher( "'Hallo Welt'" ); 
boolean b = m.matches();

final class java.util.regex.Pattern 
implements Serializable

• static Pattern compile( String regex ) Übersetzt den regulären Ausdruck in ein Pattern-Objekt.

• static Pattern compile( String regex, int flags ) Übersetzt den regulären Ausdruck in ein Pattern-Objekt mit Flags. Als Flags sind CASE_INSENSITIVE, MULTILINE, DOTALL, UNICODE_CASE und CANON_EQ erlaubt.

• int flags()
  Liefert die Flags, nach denen geprüft wird.

• Matcher matcher( CharSequence input )
  Liefert ein Matcher-Objekt, das prüft.

• static boolean matches( String regex, CharSequence input )
  Liefert true, wenn der reguläre Ausdruck regex auf die Eingabe passt.

• String pattern()
  Liefert den regulären Ausdruck, den das Pattern repräsentiert.

4.6.3 Quantifizierer und Wiederholungen

Neben den Quantifizierern ? (einmal oder keinmal), * (keinmal oder beliebig oft) und + (einmal oder beliebig oft) gibt es drei weitere Quantifizierer, die es erlauben, die Anzahl eines Vorkommens genauer zu beschreiben.

• X{n}. X muss genau n-mal vorkommen.

• X{n,}. X kommt mindestens n-mal vor.

• X{n,m}. X kommt mindestens n-, aber maximal m-mal vor.

static Pattern p = Pattern.compile( "[\\w|-]+@\\w[\\w|-]*\\.[a-z]{2,3}" );

4.6.4 Finden und nicht matchen

Bisher haben wir mit regulären Ausdrücken lediglich festgestellt, ob eine Zeichenfolge vollständig auf ein Muster passt. Die Matcher-Klasse kann jedoch auch feststellen, ob sich eine durch ein Muster beschriebene Teilfolge im String befindet. Dazu dient die Methode find(). Sie hat zwei Aufgaben: Zunächst sucht sie nach einer Fundstelle und gibt bei Erfolg true zurück. Das Nächste ist, dass jedes Matcher-Objekt einen Zustand mit Fundstellen besitzt, den find() aktualisiert. Einem Matcher-Objekt entlockt die Methode group() den erkannten Substring und start()/end() die Positionen. Wiederholte Aufrufe von find() setzen die Positionen weiter.

Listing 4.14 RegExAllNumbers.java, main()

String s = "'Demnach, welcher verheiratet, der tut wohl; welcher aber nicht  
verheiratet, der tut besser.'" + " 1. Korinther 7, 38"; 
Matcher matcher = Pattern.compile( "\\d+" ).matcher( s ); 
while ( matcher.find() ) 
  System.out.printf( "%s an Postion [%d,%d]%n",  
                      matcher.group(), matcher.start(),  
                      matcher.end() );

Die Ausgabe des Zahlenfinders ist:

1 an Postion [94,95] 
7 an Postion [107,108] 
38 an Postion [110,112]

4.6.5 Gierige und nicht gierige Operatoren

Die drei Operatoren ?, * und + haben die Eigenschaft, die längste mögliche Zeichenfolge abzudecken – das nennt sich gierig (engl. greedy). Deutlich wird diese Eigenschaft bei dem Versuch, in einem HTML-String alle fett gesetzten Teile zu finden. Gesucht ist also ein Ausdruck, der im String

String string = "Echt <b>fett</b>. <b>Cool</b>!";

die Teilfolgen <b>fett</b> und <b>Cool</b> erkennt. Der erste Versuch für ein Programm:

Pattern pattern = Pattern.compile( "<b>.*</b>" ); 
Matcher matcher = pattern.matcher( string ); 
while ( matcher.find() ) 
  System.out.println( matcher.group() );

Nun ist die Ausgabe aber <b>fett</b>. <b>Cool</b>! Das verwundert nicht, denn mit dem Wissen, dass * gierig ist, passt <b>.*</b> auf die Zeichenkette vom ersten <b> bis zum letzten </b>.

Die Lösung ist der Einsatz eines nicht gierigen Operators (auch »genügsam«, »zurückhaltend«, »non-greedy«, »reluctant« genannt). In diesem Fall wird hinter dem Qualifizierer einfach ein Fragezeichen gestellt.

Mit diesem nicht gierigen Operator lösen wir einfach das Fettproblem:

Listing 4.15 RegExFindBold.java, main()

Pattern pattern = Pattern.compile( "<b>.*?</b>" ); 
Matcher matcher = pattern.matcher( "Echt <b>fett</b>. <b>Cool</b>!" ); 
while ( matcher.find() ) 
  System.out.println( matcher.group() );

Wie gewünscht ist die Ausgabe:

<b>fett</b> 
<b>Cool</b>

4.6.6 Mit MatchResult alle Ergebnisse einsammeln

Die Schnittstelle java.util.regex.MatchResult deklariert Operationen, die Zugriff auf das Ergebnis (String, Start-, Endposition, Anzahl Gruppen) eines Matches ermöglichen. Ein Matcher-Objekt wird dafür mit toMatchResult() nach dem MatchResult-Objekt gefragt.

Ein einfaches Beispiel verdeutlicht die Arbeitsweise: Die eigene Utility-Funktion findMatches() soll für ein Muster und eine Zeichenkette alle Ergebnisse zurückliefern.

Listing 4.16 MatchResultDemo.java, Teil 1

static Iterable<MatchResult> findMatches( String pattern, CharSequence s ) 
{ 
  List<MatchResult> results = new ArrayList<MatchResult>(); 
 
  for ( Matcher m = Pattern.compile(pattern).matcher(s); m.find(); ) 
    results.add( m.toMatchResult() ); 
 
  return results; 
}

Die Methode liefert ein einfaches Iterable zurück, was in unserem Beispiel ausreicht, um die Funktion auf der rechten Seite des Doppelpunktes vom erweiterten for nutzen zu können. Vor dem Schleifendurchlauf übersetzt compile() den Muster-String in ein Pattern-Objekt, und matcher() gibt Zugang zum konkreten Mustererkenner, also Matcher-Objekt. Die Bedingung der Schleife ist so, dass pro Durchlauf ein Muster erkannt wird. Im Rumpf der Schleife sammelt die Ergebnisliste die MatchResult-Objekte, welche die Funddaten repräsentieren. Nach Ablauf der Schleife liefert die Methode die gesammelten Objekte zurück.

Ein paar Programmzeilen zeigen schnell die Möglichkeiten. Ein einfaches Muster soll für ISBN-10-Nummern stehen – ohne Leerzeichen oder Bindestriche.

Listing 4.17 MatchResultDemo.java, Teil 2

String pattern = "\\d{9,10}[\\d|x|X]"; 
String s = "Insel: 3898425266, Reguläre Ausdrücke: 3897213494"; 
 
for ( MatchResult r : findMatches( pattern, s ) ) 
  System.out.println( r.group() + " von " + r.start() + " bis " + r.end() );

Das Ergebnis auf der Konsole ist:

3898425266 von 7 bis 17 
3897213494 von 39 bis 49

Die Informationen in einem MatchResult entsprechen also einem Zustand eines Matcher während des Parsens, genauer gesagt nach dem Erkennen einer Zeichenfolge. Daher implementiert auch die Klasse Matcher die Schnittstelle MatchResult.

Ihr Kommentar