JavaのMatcher.quoteReplacement()メソッドとは？使い方と実行例をわかりやすく解説

はじめに

Javaの正規表現処理において、MatcherクラスのappendReplacement()メソッドは、StringBufferオブジェクトと置換文字列を引数として受け取り、入力データをStringBufferに追加しながら、マッチした部分を指定した置換文字列に置き換えていくメソッドです。

内部的には、このメソッドは入力文字列から1文字ずつ読み取ってStringBufferへ追加していきます。マッチが発生すると、マッチした部分の代わりに置換文字列をバッファへ追加し、その後はマッチした部分文字列の次の位置から処理を続行します。

注意点：特殊文字「/」と「$」の扱い

appendReplacement()メソッドに渡す置換文字列の中に「/」や「$」が含まれている場合、これらは通常の文字として扱われず、例外が発生します。これは「$」がグループ参照、「/」（バックスラッシュ）がエスケープシーケンスとして解釈されるためです。

例1：quoteReplacement()を使わない場合（例外が発生）

import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class QuoteReplacement {
    public static void main(String[] args) {
        String str = " <p>This <b>is</b> an <b>example</b> HTML <b>script</b>.</p>";
        //太字タグの内容にマッチする正規表現
        String regex = "<b>(\\S+)</b>";
        System.out.println("Input string: \n"+str);
        //Patternオブジェクトを作成
        Pattern pattern = Pattern.compile(regex);
        //コンパイル済みパターンを文字列に対してマッチング
        Matcher matcher = pattern.matcher(str);
        //空のStringBufferを作成
        StringBuffer sb = new StringBuffer();
        while (matcher.find()) {
            matcher.appendReplacement(sb, "sampledata$" );
            //Matcher.quoteReplacement("Bo$ld/Data$"));
        }
        matcher.appendTail(sb);
        System.out.println("Contents of the StringBuffer: \n"+ sb.toString() );
    }
}

出力結果

Input string:
<p>This <b>is</b> an <b>example</b> HTML <b>script</b>.</p>
Exception in thread "main" java.lang.IllegalArgumentException: Illegal group reference: group index is missing
    at java.util.regex.Matcher.appendReplacement(Unknown Source)
    at OCTOBER.matcher.QuoteReplacement.main(QuoteReplacement.java:18)

上記のように、置換文字列に「$」が含まれていると、IllegalArgumentException（Illegal group reference）という例外がスローされます。

quoteReplacement()メソッドの役割

MatcherクラスのquoteReplacement()メソッドは、文字列を引数として受け取り、リテラルな（文字通りの）置換文字列を返します。つまり、指定された文字列内の「/」や「$」といった特殊文字は無効化され、その戻り値をappendReplacement()メソッドの引数として安全に使用できるようになります。

例2：quoteReplacement()を使った正しい置換

import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class QuoteReplacement {
    public static void main(String[] args) {
        String str = "<p>This <b>is</b> an <b>example</b> HTML <b>script</b>.</p>";
        //太字タグの内容にマッチする正規表現
        String regex = "<b>(\\S+)</b>";
        System.out.println("Input string: \n"+str);
        //Patternオブジェクトを作成
        Pattern pattern = Pattern.compile(regex);
        //コンパイル済みパターンを文字列に対してマッチング
        Matcher matcher = pattern.matcher(str);
        //空のStringBufferを作成
        StringBuffer sb = new StringBuffer();
        while (matcher.find()) {
            matcher.appendReplacement(sb, Matcher.quoteReplacement("Bo$ld/Data$"));
        }
        matcher.appendTail(sb);
        System.out.println("Contents of the StringBuffer: \n"+ sb.toString() );
    }
}

出力結果

Input string:
<p>This <b>is</b> an <b>example</b> HTML <b>script</b>.</p>
Contents of the StringBuffer:
<p>This Bo$ld/Data$ an Bo$ld/Data$ HTML Bo$ld/Data$.</p>

このように、Matcher.quoteReplacement()で置換文字列をラップすることで、特殊文字「$」や「/」が含まれていても、それらを通常の文字として扱い、例外を発生させることなく置換処理を実行できます。

例3：quoteReplacement()単体での動作確認

import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class QuoteReplacementExample {
    public static void main(String[] args) {
        String input = "This is sample text";
        String regex = "[#]";
        //Patternオブジェクトを作成
        Pattern pattern = Pattern.compile(regex);
        //コンパイル済みパターンを文字列に対してマッチング
        Matcher matcher = pattern.matcher(input);
        //quoteReplacement()の戻り値を確認
        String str = Matcher.quoteReplacement("sampledata");
        System.out.println(str);
    }
}

出力結果

sampledata

まとめ

• appendReplacement()は、マッチした部分を置換しながらStringBufferへ追加していくメソッドです。
• 置換文字列に「$」や「/」が含まれると、グループ参照やエスケープとして解釈され、例外が発生します。
• Matcher.quoteReplacement()を使えば、これらの特殊文字をリテラル文字として扱えるため、安全な置換処理が可能になります。