JavaでのHTMLエスケープ方法

HTMLエスケープに関する日本語解説

HTMLエスケープとは、HTML文書内で特殊な文字（たとえば、<, >, &, など）をそのまま表示するために、それらを特殊なシーケンスに変換する処理のことです。これにより、HTMLパーサーがこれらの文字をタグの開始や終了として誤解釈することを防ぎます。

Javaにおいて、HTMLエスケープを最も一般的な方法で実装するには、以下のライブラリを使用することをおすすめします：

Apache Commons Lang

Apache Commons Langは、Javaの標準ライブラリを拡張するユーティリティクラスを提供するライブラリです。HTMLエスケープについては、StringEscapeUtilsクラスを使用します。

import org.apache.commons.lang3.StringEscapeUtils;

String htmlText = "<p>This is some HTML text with & symbols.</p>";
String escapedHtml = StringEscapeUtils.escapeHtml4(htmlText);
System.out.println(escapedHtml); // 出力: <p>This is some HTML text with &amp; symbols.</p>

Java Standard Library

Javaの標準ライブラリでも、HTMLエスケープのための機能を提供しています。ただし、Apache Commons Langほど便利ではありません。

import java.net.URLEncoder;

String htmlText = "<p>This is some HTML text with & symbols.</p>";
String escapedHtml = URLEncoder.encode(htmlText, "UTF-8");
System.out.println(escapedHtml); // 出力: <p>This%20is%20some%20HTML%20text%20with%20%26%20symbols.</p>

注意

• HTML5では、新しいエスケープシーケンス（たとえば、&）が導入されています。必要に応じて、これらのシーケンスを使用することもできます。
• URLEncoder.encode()は、URLエンコーディングを使用するため、HTMLエスケープとは異なるエンコーディング方式となります。そのため、HTML文書内で使用する場合は、適切なエスケープ方法を選択してください。

JavaでのHTMLエスケープ例

Apache Commons Langを使用する場合

import org.apache.commons.lang3.StringEscapeUtils;

String htmlText = "<p>This is some HTML text with & symbols.</p>";
String escapedHtml = StringEscapeUtils.escapeHtml4(htmlText);
System.out.println(escapedHtml); // 出力: <p>This is some HTML text with &amp; symbols.</p>

• &
  エスケープされたHTMLテキストでは、&が&に変換されています。
• StringEscapeUtils.escapeHtml4(htmlText)
  このメソッドは、指定されたHTMLテキストをHTML4のエンコーディング規則に従ってエスケープします。

Java標準ライブラリを使用する場合

import java.net.URLEncoder;

String htmlText = "<p>This is some HTML text with & symbols.</p>";
String escapedHtml = URLEncoder.encode(htmlText, "UTF-8");
System.out.println(escapedHtml); // 出力: <p>This%20is%20some%20HTML%20text%20with%20%26%20symbols.</p>

• %26
  &は%26に変換されています。
• URLEncoder.encode(htmlText, "UTF-8")
  このメソッドは、指定されたHTMLテキストをURLエンコーディングに従ってエンコードします。

手動エスケープ

最も基本的な方法は、手動で各特殊文字をエスケープシーケンスに置き換えることです。ただし、この方法はエラーが発生しやすく、メンテナンスが困難になる可能性があります。

String htmlText = "<p>This is some HTML text with & symbols.</p>";
htmlText = htmlText.replace("&", "&amp;")
                  .replace("<", "&lt;")
                  .replace(">", "&gt;")
                  .replace("\"", "&quot;")
                  .replace("'", "&apos;");

正規表現を使用

正規表現を使用して、複数の特殊文字を一度にエスケープすることもできます。

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

String htmlText = "<p>This is some HTML text with & symbols.</p>";
Pattern pattern = Pattern.compile("[&<>\"']");
Matcher matcher = pattern.matcher(htmlText);
StringBuffer sb = new StringBuffer();
while (matcher.find()) {
    matcher.appendReplacement(s   b, "&" + matcher.group() + ";");
}
matcher.appendTail(sb);
htmlText = sb.toString();

サードパーティライブラリ

他にも、HTMLエスケープのためのサードパーティライブラリが存在します。例えば、Google GuavaやJoda-Timeは、HTMLエスケープ機能を提供しています。

• サードパーティライブラリを使用する場合は、ライブラリのドキュメントを参照して、正しい使用方法を確認してください。
• 手動エスケープや正規表現を使用する場合は、すべての特殊文字を適切にエスケープするように注意してください。