先生と生徒の会話形式で理解しよう

生徒

「先生、JakartaEEでフォームに入力した日本語が文字化けすることがあるんですが、どうしたら直せますか？」

先生

「それは文字エンコーディングの設定が正しくされていないのが原因だね。サーブレットやJSPでは、リクエストとレスポンスに統一した文字コードを設定しないと文字化けしてしまうんだ。」

生徒

「なるほど…。それを毎回サーブレットで書くのは大変そうですけど、もっと効率的な方法はありますか？」

先生

「そこで役立つのがJakartaEEのフィルタなんだ。文字エンコーディングフィルタを作れば、アプリ全体でUTF-8を強制できるよ。」

1. 文字エンコーディング問題とは

JakartaEEアプリケーションでは、日本語や多言語を扱う際に文字化けが発生することがあります。特にフォーム送信やクエリパラメータを受け取る場面では、文字コードが統一されていないと「？？？」や不明な記号になってしまうことがあります。これを防ぐために、リクエストとレスポンスの両方に同じ文字エンコーディングを設定する必要があります。一般的にはUTF-8を使うのが推奨されています。

2. フィルタで文字コードを設定する仕組み

JakartaEEのフィルタは、すべてのリクエストとレスポンスを通過する仕組みを提供します。そのため、ここで文字エンコーディングを統一的に設定すれば、アプリ全体での文字化けを防げます。個々のサーブレットで毎回設定する必要がなくなるため、コードの重複も減り、メンテナンス性が向上します。

3. 文字エンコーディングフィルタのサンプルコード

次のコードは、UTF-8を強制するシンプルな文字エンコーディングフィルタの実装例です。


@WebFilter("/*")
public class EncodingFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        chain.doFilter(request, response);
    }
}

このフィルタを設定すれば、アプリケーション全体でUTF-8が適用されます。

4. 実行結果の確認

例えば、フォームから「こんにちは」と入力して送信した場合でも、正しくUTF-8で処理されるため文字化けは発生しません。コンソールや画面表示で次のように確認できます。


入力値: こんにちは
出力値: こんにちは

5. web.xmlによる設定方法

アノテーションではなくweb.xmlを使って設定する方法もあります。レガシー環境やXMLで管理したい場合はこちらを利用します。


<filter>
    <filter-name>EncodingFilter</filter-name>
    <filter-class>com.example.EncodingFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>EncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

この設定により、アプリ全体にUTF-8の文字コード設定が反映されます。

6. 文字エンコーディングフィルタ導入のメリット

フィルタで文字エンコーディングを管理することで、以下のようなメリットがあります。

全ページで統一した文字コードを利用できる
文字化けトラブルを未然に防げる
個別のサーブレットに設定を記述する必要がなくなる
多言語対応が容易になる

特に初心者にとって、エンコーディングの問題は最初につまずきやすいポイントなので、このフィルタを導入するだけで大きく改善できます。

7. 実運用での注意点

文字エンコーディングフィルタを導入する際には、レスポンスのContent-TypeヘッダーもUTF-8に設定することを忘れないようにしましょう。また、外部システムやデータベースとの連携時には、それぞれの環境でも文字コードがUTF-8に統一されているかを確認する必要があります。さらに、既存システムからの移行では、ISO-8859-1やShift_JISといった異なる文字コードが使われている場合もあるため、事前にテストを行うことが重要です。