JavaのPatternSyntaxExceptionクラスとは？正規表現の構文エラー処理方法を解説

PatternSyntaxException クラスは、正規表現（regex）の文字列に構文エラーが含まれている場合にスローされる非検査例外（unchecked exception）です。この例外は java.util.regex パッケージに属しており、Pattern.compile() メソッドなどで不正な正規表現をコンパイルしようとした際に発生します。

このクラスには、エラーの詳細情報を取得するための主要なメソッドが用意されています。

• getDescription() − エラーの説明（description）を返します。

• getIndex() − エラーが発生した位置のインデックスを返します。

• getPattern() − エラーが含まれている正規表現パターンそのものを返します。

• getMessage() − エラーの説明、インデックス、エラーのある正規表現パターン、およびパターン内のエラー箇所を示す記号（^）を含む完全なメッセージを返します。

これらのメソッドを活用することで、ユーザーに対して「どの部分の正規表現が間違っているのか」を分かりやすく伝えることができます。

サンプルコード

以下は、ユーザーから入力された文字列に対して正規表現を適用する例です。ここでは意図的に不正な正規表現 [ を使用し、PatternSyntaxException をキャッチして各メソッドの出力を確認しています。

import java.util.Scanner;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

public class PatternSyntaxExceptionExample {
    public static void main(String args[]) {
        // ユーザーから文字列を読み込む
        System.out.println("Enter a String");
        Scanner sc = new Scanner(System.in);
        String input = sc.nextLine();

        // 正規表現（意図的に不正なパターンを指定）
        String regex = "["; //\s+

        // 正規表現をコンパイル
        try {
            Pattern pattern = Pattern.compile(regex);
            // Matcherオブジェクトを取得
            Matcher matcher = pattern.matcher(input);
            // 余分な空白を1つの空白に置換
            String result = matcher.replaceAll(" ");
            System.out.print("Text after removing unwanted spaces: \n" + result);
        } catch(PatternSyntaxException ex) {
            System.out.println("Description: " + ex.getDescription());
            System.out.println("Index: " + ex.getIndex());
            System.out.println("Message: " + ex.getMessage());
            System.out.println("Pattern: " + ex.getPattern());
        }
    }
}

実行結果

Enter a String
this is a [sample text [
Description: Unclosed character class
Index: 0
Message: Unclosed character class near index 0
[
^
Pattern: [

解説

この例では、正規表現として閉じられていない文字クラス [ を指定しているため、Pattern.compile() の呼び出し時に PatternSyntaxException がスローされます。catch ブロック内で各メソッドを呼び出すことで、以下の情報が出力されます。

• Description: 「Unclosed character class（閉じられていない文字クラス）」というエラーの説明。
• Index: エラーが発生した位置（この場合は 0）。
• Message: エラーの説明、インデックス、問題のあるパターン、エラー箇所を示す ^ マークを含む詳細メッセージ。
• Pattern: エラーの原因となった正規表現パターン [。

このように PatternSyntaxException を適切にキャッチして処理することで、プログラムが異常終了するのを防ぎ、ユーザーにとって分かりやすいエラーメッセージを提供できます。特に、ユーザー入力や外部ファイルから正規表現を受け取るアプリケーションでは、必ず try-catch 構文による例外処理を実装することをおすすめします。