ThymeleafでJavaのメソッドを呼び出す方法は？初心者向け解説

1. ThymeleafでJavaのメソッドを呼び出す基本

「1. ThymeleafでJavaのメソッドを呼び出す基本」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

1. ThymeleafでJavaのメソッドを呼び出す基本

Thymeleafでは、#で始まる「ユーティリティオブジェクト」や、Springの@Controllerから渡されたオブジェクトを使うことで、Javaのメソッドを呼び出すことができます。 例えば、以下のコードでは、StringUtils.capitalize()メソッドを使って文字列の先頭文字を大文字に変換しています。

<p th:text="${#strings.capitalize('thymeleaf')}"></p>

この例では、Thymeleafが提供する#stringsというユーティリティオブジェクトを使っています。このオブジェクトには、文字列操作に便利なメソッドが多数用意されています。

2. 独自メソッドを呼び出す方法

2. 独自メソッドを呼び出す方法

Springの@Controllerや@Serviceから渡されたオブジェクトを使って独自メソッドを呼び出すことも可能です。以下は、その例です。

@Controller
public class DemoController {

    @GetMapping("/demo")
    public String demo(Model model) {
        model.addAttribute("helper", new Helper());
        return "demo";
    }

    public static class Helper {
        public String greet(String name) {
            return "Hello, " + name + "!";
        }
    }
}

上記のようにModelにオブジェクトを追加し、Thymeleafテンプレートで以下のように使用します。

<p th:text="${helper.greet('Thymeleaf')}"></p>

この結果、画面には「Hello, Thymeleaf!」と表示されます。

3. メソッドチェーンの利用

3. メソッドチェーンの利用

メソッドチェーンを使って複数の処理を連続で実行することも可能です。以下はその例です。

<p th:text="${#strings.capitalize(helper.greet('user').toLowerCase())}"></p>

このコードでは、helper.greet()で返された文字列をすべて小文字に変換し、その後で先頭文字を大文字にしています。

4. null値や例外に対応する方法

「4. null値や例外に対応する方法」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

4. null値や例外に対応する方法

メソッドを呼び出す際にnull値や例外が発生することがあります。こうした場合に安全に処理を行うために、th:ifや?:（Elvis演算子）を利用します。

<p th:text="${helper != null ? helper.greet('Thymeleaf') : 'デフォルトメッセージ'}"></p>

このコードでは、helperがnullの場合は「デフォルトメッセージ」を表示します。

5. 便利なユーティリティオブジェクトの活用

5. 便利なユーティリティオブジェクトの活用

Thymeleafには、文字列操作の#strings以外にも、日付操作の#datesや数値操作の#numbersといった便利なユーティリティオブジェクトが用意されています。以下は、それらを組み合わせた例です。

<p th:text="${#strings.concat('Today is ', #dates.format(today, 'yyyy-MM-dd'))}"></p>

この例では、現在の日付を取得して文字列に結合しています。ユーティリティオブジェクトを活用することで、テンプレート内の記述が非常に簡潔になります。

6. Spring Beanを直接呼び出す方法

6. Spring Beanを直接呼び出す方法

Modelにオブジェクトを追加しなくても、Springコンテキストで管理されているBeanを直接呼び出すことができます。これには@記号（Beanセレクタ）を使用します。

共通の変換ロジックを持つコンポーネントやサービスを、テンプレートから直接利用したい場合に非常に便利です。

<!-- userServiceという名前のBeanのメソッドを呼び出す -->
<p th:text="${@userService.getUserDisplayName(userId)}"></p>

この方法を使うことで、コントローラーで毎回同じヘルパークラスをモデルに追加する手間を省き、コードの重複を避けることができます。

7. 列挙型（Enum）のメソッドを活用する

「7. 列挙型（Enum）のメソッドを活用する」の重要ポイントを、初心者の方にも分かりやすく簡潔に解説します。

7. 列挙型（Enum）のメソッドを活用する

Javaの列挙型（Enum）で定義したメソッドを呼び出すことも可能です。ステータスに応じたラベルの取得や、特定の条件判定をEnum側に持たせている場合に役立ちます。

テンプレート内では、以下のようにEnum定数のメソッドにアクセスできます（T演算子を使用して完全修飾クラス名を指定します）。

<!-- Enumのメソッドを呼び出して日本語名を表示 -->
<span th:text="${T(com.example.constant.UserStatus).ACTIVE.getLabel()}"></span>

<!-- モデル内のEnumインスタンスからメソッドを呼び出す -->
<span th:text="${user.status.isArchived() ? 'アーカイブ済み' : '有効'}"></span>

ロジックをJava側に隠蔽できるため、テンプレートが複雑になりすぎるのを防ぐことができます。

8. メソッド呼び出し時の注意点

8. メソッド呼び出し時の注意点

ThymeleafからJavaメソッドを呼び出す際には、以下の点に注意してください。適切に設計しないと、保守性の低下やエラーの原因になります。

• 副作用のあるメソッドを避ける： テンプレートは「表示」のためのものです。DBの更新や状態の変更を伴うメソッドを呼び出すと、予期せぬ動作を引き起こす可能性があります。
• パフォーマンス： ループ（th:each）の中で重い処理を行うメソッドを呼び出すと、画面のレンダリング速度が著しく低下します。
• 可読性： 複雑なロジックをテンプレート内に書くとデバッグが困難になります。複雑な処理はJava側で済ませ、結果だけを渡すのがベストプラクティスです。

基本的には「表示データの整形」や「簡単な判定」に留め、ビジネスロジックはコントローラーやサービスで完結させるようにしましょう。

まとめ

まとめ

本記事では、Thymeleafを使用してJavaのメソッドを呼び出す方法を詳しく解説しました。#stringsなどのユーティリティオブジェクトを活用した基本的なメソッドの呼び出し方法から、独自のメソッドをSpringの@Controllerで渡してテンプレート内で利用する方法、さらにはメソッドチェーンやnull値への対応方法について学びました。

また、Thymeleafが提供する多くのユーティリティオブジェクト（#datesや#numbersなど）を使えば、テンプレートエンジンとしての機能を最大限に活用できることが分かりました。これにより、テンプレートのコードが簡潔で再利用性の高いものになります。

以下に、記事で紹介したサンプルコードをもう一度掲載しますので、ぜひご自身のプロジェクトで活用してください。

<p th:text="${#strings.capitalize('hello')}"></p>
<p th:text="${helper.greet('Thymeleaf')}"></p>
<p th:text="${#strings.concat('Today is ', #dates.format(today, 'yyyy-MM-dd'))}"></p>
<p th:text="${helper != null ? helper.greet('Guest') : 'デフォルトメッセージ'}"></p>

これらのコードは、実際のWebアプリケーション開発において役立つ実用的な例です。ThymeleafのテンプレートでJavaのメソッドを活用することで、柔軟性と効率性が大幅に向上します。