Reguläre Ausdrücke
Mit Hilfe von regulären Ausdrücken kann man den Aufbau von Zeichenketten formal beschreiben. Dabei lassen sich direkt die gewünschten Zeichen einsetzen, oder man nutzt Zeichenklassen oder vordefinierte Ausdrücke. Teilausdrücke lassen sich gruppieren und über Quantifier kann definiert werden, wie oft ein Teilausdruck vorkommen soll. Die Quantifier sind per Default greedy und versuchen so viel wie möglich zu matchen.
Auf der Java-Seite stellt man reguläre Ausdrücke zunächst als String
dar. Dabei
muss darauf geachtet werden, dass ein Backslash im regulären Ausdruck im Java-String
geschützt (escaped) werden muss, indem jeweils ein weiterer Backslash voran gestellt
wird. Mit Hilfe der Klasse java.util.regex.Pattern
lässt sich daraus ein Objekt
mit dem kompilierten regulären Ausdruck erzeugen, was insbesondere bei mehrfacher
Verwendung günstiger in der Laufzeit ist. Dem Pattern-Objekt kann man dann den
Suchstring übergeben und bekommt ein Objekt der Klasse java.util.regex.Matcher
(dort sind regulärer Ausdruck/Pattern und der Suchstring kombiniert). Mit den
Methoden Matcher#find
und Matcher#matches
kann dann geprüft werden, ob das Pattern
auf den Suchstring passt: find
sucht dabei nach dem ersten Vorkommen des Patterns
im Suchstring, match
prüft, ob der gesamte String zum Pattern passt.
- (K1) Wichtigste Methoden von
java.util.regex.Pattern
undjava.util.regex.Matcher
- (K2) Unterschied zwischen
Matcher#find
undMatcher#matches
- (K2) Unterscheidung zwischen greedy und non-greedy Verhalten
- (K3) Bildung einfacher regulärer Ausdrücke
- (K3) Nutzung von Zeichenklassen und deren Negation
- (K3) Nutzung der vordefinierten regulären Ausdrücke
- (K3) Nutzung von Quantifizierern
- (K3) Zusammenbauen von komplexen Ausdrücken (u.a. mit Gruppen)
Suchen in Strings
Gesucht ist ein Programm zum Extrahieren von Telefonnummern aus E-Mails.
=> Wie geht das?
Leider gibt es unzählig viele Varianten, wie man eine Telefonnummer (samt Vorwahl und ggf. Ländervorwahl) aufschreiben kann:
030 - 123 456 789, 030-123456789, 030/123456789,
+49(30)123456-789, +49 (30) 123 456 - 789, ...
Definition Regulärer Ausdruck
Ein regulärer Ausdruck ist eine Zeichenkette, die zur Beschreibung von Zeichenketten dient.
Anwendungen
- Finden von Bestandteilen in Zeichenketten
- Aufteilen von Strings in Tokens
- Validierung von textuellen Eingaben => "Eine Postleitzahl besteht aus 5 Ziffern"
- Compilerbau: Erkennen von Schlüsselwörtern und Strukturen und Syntaxfehlern
Einfachste reguläre Ausdrücke
Zeichenkette | Beschreibt |
---|---|
x |
"x" |
. |
ein beliebiges Zeichen |
\t |
Tabulator |
\n |
Newline |
\r |
Carriage-return |
\\ |
Backslash |
Beispiel
abc
=> "abc"A.B
=> "AAB" oder "A2B" oder ...a\\bc
=> "a\bc"
Anmerkung
In Java-Strings leitet der Backslash eine zu interpretierende Befehlssequenz ein.
Deshalb muss der Backslash i.d.R. geschützt ("escaped") werden.
=> Statt "\n
" müssen Sie im Java-Code "\\n
" schreiben!
Zeichenklassen
Zeichenkette | Beschreibt |
---|---|
[abc] |
"a" oder "b" oder "c" |
[^abc] |
alles außer "a", "b" oder "c" (Negation) |
[a-zA-Z] |
alle Zeichen von "a" bis "z" und "A" bis "Z" (Range) |
[a-z&&[def]] |
"d","e" oder "f" (Schnitt) |
[a-z&&[^bc]] |
"a" bis "z", außer "b" und "c": [ad-z] (Subtraktion) |
[a-z&&[^m-p]] |
"a" bis "z", außer "m" bis "p": [a-lq-z] (Subtraktion) |
Beispiel
[abc]
=> "a" oder "b" oder "c"[a-c]
=> "a" oder "b" oder "c"[a-c][a-c]
=> "aa", "ab", "ac", "ba", "bb", "bc", "ca", "cb" oder "cc"A[a-c]
=> "Aa", "Ab" oder "Ac"
Vordefinierte Ausdrücke
Zeichenkette | Beschreibt |
---|---|
^ |
Zeilenanfang |
$ |
Zeilenende |
\d |
eine Ziffer: [0-9] |
\w |
beliebiges Wortzeichen: [a-zA-Z_0-9] |
\s |
Whitespace (Leerzeichen, Tabulator, Newline) |
\D |
jedes Zeichen außer Ziffern: [^0-9] |
\W |
jedes Zeichen außer Wortzeichen: [^\w] |
\S |
jedes Zeichen außer Whitespaces: [^\s] |
Beispiel
\d\d\d\d\d
=> "12345"\w\wA
=> "aaA", "a0A", "a_A", ...
Nutzung in Java
-
java.lang.String
:public String[] split(String regex) public boolean matches(String regex)
-
java.util.regex.Pattern
:public static Pattern compile(String regex) public Matcher matcher(CharSequence input)
- Schritt 1: Ein Pattern compilieren (erzeugen) mit
Pattern#compile
=> liefert ein Pattern-Objekt für den regulären Ausdruck zurück - Schritt 2: Dem Pattern-Objekt den zu untersuchenden Zeichenstrom
übergeben mit
Pattern#matcher
=> liefert ein Matcher-Objekt zurück, darin gebunden: Pattern (regulärer Ausdruck) und die zu untersuchende Zeichenkette
- Schritt 1: Ein Pattern compilieren (erzeugen) mit
-
java.util.regex.Matcher
:public boolean find() public boolean matches() public int groupCount() public String group(int group)
-
Schritt 3: Mit dem Matcher-Objekt kann man die Ergebnisse der Anwendung des regulären Ausdrucks auf eine Zeichenkette auswerten
Bedeutung der unterschiedlichen Methoden siehe folgende Folien
Matcher#group
: Liefert die Sub-Sequenz des Suchstrings zurück, die erfolgreich gematcht wurde (siehe unten "Fangende Gruppierungen")
-
Hinweis:
In Java-Strings leitet der Backslash eine zu interpretierende Befehlssequenz ein. Deshalb muss der Backslash i.d.R. extra geschützt ("escaped") werden.
=> Statt "\n
" (regulärer Ausdruck) müssen Sie im Java-String "\\n
" schreiben!
=> Statt "a\\bc
" (regulärer Ausdruck, passt auf die Zeichenkette "a\bc") müssen
Sie im Java-String "a\\\\bc
" schreiben!
Unterschied zw. Finden und Matchen
-
Matcher#find
:Regulärer Ausdruck muss im Suchstring enthalten sein. => Suche nach erstem Vorkommen
-
Matcher#matches
:Regulärer Ausdruck muss auf kompletten Suchstring passen.
Beispiel
- Regulärer Ausdruck:
abc
, Suchstring: "blah blah abc blub"Matcher#find
: erfolgreichMatcher#matches
: kein Match - Suchstring entspricht nicht dem Muster
Quantifizierung
Zeichenkette | Beschreibt |
---|---|
X? |
ein oder kein "X" |
X* |
beliebig viele "X" (inkl. kein "X") |
X+ |
mindestens ein "X", ansonsten beliebig viele "X" |
X{n} |
exakt $n$ Vorkommen von "X" |
X{n,} |
mindestens $n$ Vorkommen von "X" |
X{n,m} |
zwischen $n$ und $m$ Vorkommen von "X" |
Beispiel
\d{5}
=> "12345"-?\d+\.\d*
=> ???
Interessante Effekte
Pattern p = Pattern.compile("A.*A");
Matcher m = p.matcher("A 12 A 45 A");
if (m.matches())
String result = m.group(); // ???
Matcher#group
liefert die Inputsequenz, auf die der Matcher angesprochen hat.
Mit Matcher#start
und Matcher#end
kann man sich die Indizes des ersten und
letzten Zeichens des Matches im Eingabezeichenstrom geben lassen. D.h. für einen
Matcher m
und eine Eingabezeichenkette s
ist m.group()
und
s.substring(m.start(), m.end())
äquivalent.
Da bei Matcher#matches
das Pattern immer auf den gesamten Suchstring passen
muss, verwundert das Ergebnis für Matcher#group
nicht. Bei Matcher#find
wird im Beispiel allerdings ebenfalls der gesamte Suchstring "gefunden" ...
Dies liegt am "greedy" Verhalten der Quantifizierer.
Nicht gierige Quantifizierung mit "?"
Zeichenkette | Beschreibt |
---|---|
X*? |
non-greedy Variante von X* |
X+? |
non-greedy Variante von X+ |
Beispiel
- Suchstring "A 12 A 45 A":
-
A.*A
findet/passt auf "A 12 A 45 A"normale greedy Variante
-
A.*?A
- findet "A 12 A"
- passt auf "A 12 A 45 A" (!)
non-greedy Variante der Quantifizierung;
Matcher#matches
muss trotzdem auf den gesamten Suchstring passen!
-
(Fangende) Gruppierungen
Studi{2}
passt nicht auf "StudiStudi" (!)
Quantifizierung bezieht sich auf das direkt davor stehende Zeichen. Ggf. Gruppierungen durch Klammern verwenden!
Zeichenkette | Beschreibt |
---|---|
X|Y |
X oder Y |
(C) |
Gruppierung |
Beispiel
(A)(B(C))
- Gruppe 0:
ABC
- Gruppe 1:
A
- Gruppe 2:
BC
- Gruppe 3:
C
- Gruppe 0:
Die Gruppen heißen auch "fangende" Gruppen (engl.: "capturing groups").
Damit erreicht man eine Segmentierung des gesamten regulären Ausdrucks, der in seiner Wirkung aber nicht durch die Gruppierungen geändert wird. Durch die Gruppierungen von Teilen des regulären Ausdrucks erhält man die Möglichkeit, auf die entsprechenden Teil-Matches (der Unterausdrücke der einzelnen Gruppen) zuzugreifen:
-
Matcher#groupCount
: Anzahl der "fangenden" Gruppen im regulären Ausdruck -
Matcher#group(i)
: Liefert die Subsequenz der Eingabezeichenkette zurück, auf die die jeweilige Gruppe gepasst hat. Dabei wird von links nach rechts durchgezählt, beginnend bei 1(!).Konvention: Gruppe 0 ist das gesamte Pattern, d.h.
m.group(0) == m.group();
...
Hinweis: Damit der Zugriff auf die Gruppen klappt, muss auch erst ein Match gemacht
werden, d.h. das Erzeugen des Matcher-Objekts reicht noch nicht, sondern es muss auch
noch ein matcher.find()
oder matcher.matches()
ausgeführt werden. Danach kann man
bei Vorliegen eines Matches auf die Gruppen zugreifen.
(Studi){2}
=> "StudiStudi"
Gruppen und Backreferences
Matche zwei Ziffern, gefolgt von den selben zwei Ziffern
(\d\d)\1
-
Verweis auf bereits gematchte Gruppen:
\num
num
Nummer der Gruppe (1 ... 9)=> Verweist nicht auf regulären Ausdruck, sondern auf jeweiligen Match!
Anmerkung: Laut Literatur/Doku nur 1 ... 9, in Praxis geht auch mehr per Backreference ...
-
Benennung der Gruppe:
(?<name>X)
X
ist regulärer Ausdruck für Gruppe, spitze Klammern wichtig=> Backreference:
\k<name>
Beispiel Gruppen und Backreferences
Regulärer Ausdruck: Namen einer Person matchen, wenn Vor- und Nachname identisch sind.
Lösung: ([A-Z][a-zA-Z]*)\s\1
Umlaute und reguläre Ausdrücke
-
Keine vordefinierte Abkürzung für Umlaute (wie etwa
\d
) -
Umlaute nicht in
[a-z]
enthalten, aber in[a-ü]
"helloüA".matches(".*?[ü]A"); "azäöüß".matches("[a-ä]"); "azäöüß".matches("[a-ö]"); "azäöüß".matches("[a-ü]"); "azäöüß".matches("[a-ß]");
-
Strings sind Unicode-Zeichenketten
=> Nutzung der passenden Unicode Escape Sequence
\uFFFF
System.out.println("\u0041 :: A"); System.out.println("helloüA".matches(".*?A")); System.out.println("helloüA".matches(".*?\u0041")); System.out.println("helloü\u0041".matches(".*?A"));
-
RegExp vordefinieren und mit Variablen zusammenbauen ala Perl nicht möglich => Umweg String-Repräsentation
Wrap-Up
- RegExp: Zeichenketten, die andere Zeichenketten beschreiben
java.util.regex.Pattern
undjava.util.regex.Matcher
- Unterschied zwischen
Matcher#find
undMatcher#matches
! - Quantifizierung ist möglich, aber greedy (Default)
In den Vorgaben
finden Sie in der Klasse Lexer
eine einfache Implementierung
eines Lexers, worin ein einfaches
Syntax-Highlighting für Java-Code realisiert ist.
Dazu arbeitet der Lexer mit sogenannten "Token" (Instanzen der Klasse Token
).
Diese haben einen regulären Ausdruck, um bestimmte Teile im Code zu erkennen,
beispielsweise Keywords oder Kommentare und anderes. Der Lexer wendet alle Token
auf den aktuellen Eingabezeichenstrom an (Methode Token#test()
), und die Token
prüfen mit "ihrem" regulären Ausdruck, ob die jeweils passende Eingabesequenz
vorliegt. Die regulären Ausdrücke übergeben Sie dem Token
-Konstruktor als
entsprechendes Pattern
-Objekt.
Neben dem jeweiligen Pattern kennt jedes Token noch eine matchingGroup
: Dies
ist ein Integer, der die relevante Matching-Group im regulären Ausdruck bezeichnet.
Wenn Sie keine eigenen Gruppen in einem regulären Ausdruck eingebaut haben, nutzen
Sie hier einfach den Wert 0.
Zusätzlich kennt jedes Token noch die Farbe für das Syntax-Highlighting in der
von uns als Vorgabe realisierten Swing-GUI (Instanz von Color
).
Erstellen Sie passende Token
-Instanzen mit entsprechenden Pattern für die
folgenden Token:
- Einzeiliger Kommentar: beginnend mit
//
bis zum Zeilenende - Mehrzeiliger Kommentar: alles zwischen
/*
und dem nächsten*/
- Javadoc-Kommentar: alles zwischen
/**
und dem nächsten*/
- Strings: alles zwischen
"
und dem nächsten"
- Character: genau ein Zeichen zwischen
'
und'
- Keywords:
package
,import
,class
,public
,private
,final
,return
,null
,new
(jeweils freistehend, also nicht "newx" o.ä.) - Annotation: beginnt mit
@
, enthält Buchstaben oder Minuszeichen
Die Token-Objekte fügen Sie im Konstruktor der Klasse Lexer
durch den
Aufruf der Methode tokenizer.add(mytoken)
hinzu. Sie können Sich an den
Kommentaren im Lexer
-Konstruktor orientieren.
Sollten Token ineinander geschachtelt sein, erkennt der Lexer dies automatisch. Sie brauchen sich keine Gedanken dazu machen, in welcher Reihenfolge die Token eingefügt und abgearbeitet werden. Beispiel: Im regulären Ausdruck für den einzeiligen Kommentar brauchen Sie keine Keywords, Annotationen, Strings usw. erkennen.
- [Java-SE-Tutorial] The Java Tutorials
Oracle Corporation, 2022.
Essential Java Classes \> Regular Expressions