Thymeleafでのフラグメントの操作

投稿日: 2019-10-18 2022-11-08
タグ: Spring MVC, Thymeleaf

1. 概要

このチュートリアルでは、 Thymeleafフラグメントを使用して、サイトのいくつかの一般的な部分を再利用する方法を示します。非常に単純なSpringMVCプロジェクトを設定した後、ビューに焦点を当てます。

Thymeleafを初めて使用する場合は、この紹介や、このエンジンの3.0バージョンに関する記事など、このサイトの他の記事を確認できます。

2. Mavenの依存関係

Thymeleafを有効にするには、いくつかの依存関係が必要です。

<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf</artifactId>
    <version>3.0.11.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf-spring5</artifactId>
    <version>3.0.11.RELEASE</version>
</dependency>

thymeleafおよびthymeleaf-spring5の最新バージョンは、MavenCentralにあります。

3. 春のプロジェクト

3.1. SpringMVC構成

Thymeleafを有効にしてテンプレートのサフィックスを設定するには、ビューリゾルバーとテンプレートリゾルバーを使用してMVCを構成する必要があります。

また、いくつかの静的リソースのディレクトリを設定します。

@Bean
public ViewResolver htmlViewResolver() {
    ThymeleafViewResolver resolver = new ThymeleafViewResolver();
    resolver.setTemplateEngine(templateEngine(htmlTemplateResolver()));
    resolver.setContentType("text/html");
    resolver.setCharacterEncoding("UTF-8");
    resolver.setViewNames(ArrayUtil.array("*.html"));
    return resolver;
}

private ITemplateResolver htmlTemplateResolver() {
    SpringResourceTemplateResolver resolver
      = new SpringResourceTemplateResolver();
    resolver.setApplicationContext(applicationContext);
    resolver.setPrefix("/WEB-INF/views/");
    resolver.setCacheable(false);
    resolver.setTemplateMode(TemplateMode.HTML);
    return resolver;
}

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/resources/**", "/css/**")
      .addResourceLocations("/WEB-INF/resources/", "/WEB-INF/css/");
}

Spring Bootを使用している場合は、独自のカスタマイズを適用する必要がない限り、この構成は必要ない場合があることに注意してください。

3.2. コントローラー

この場合、コントローラーはビューの単なる手段です。各ビューは、異なるフラグメント使用シナリオを示しています。

最後の1つは、モデルを通過してビューに表示されるデータをロードします。

@Controller
public class FragmentsController {

    @GetMapping("/fragments")
    public String getHome() {
        return "fragments.html";
    }

    @GetMapping("/markup")
    public String markupPage() {
        return "markup.html";
    }

    @GetMapping("/params")
    public String paramsPage() {
        return "params.html";
    }

    @GetMapping("/other")
    public String otherPage(Model model) {
        model.addAttribute("data", StudentUtils.buildStudents());
        return "other.html";
    }
}

リゾルバーの構成方法により、ビュー名には「.html」サフィックスが含まれている必要があることに注意してください。フラグメント名を参照するときにサフィックスも指定します。

4. ビュー

4.1. 単純なフラグメントの包含

まず、ページで共通部分を再利用します。

これらの部分は、分離されたファイルまたは共通のページのいずれかでフラグメントとして定義できます。このプロジェクトでは、これらの再利用可能なパーツは、Fragmentsという名前のフォルダーで定義されています。

フラグメントのコンテンツを含めるには、次の3つの基本的な方法があります。

insert –はタグ内にコンテンツを挿入します
replace – は、現在のタグをフラグメントを定義するタグに置き換えます
include – これは非推奨ですが、レガシーコードに引き続き表示される可能性があります

次の例fragments.html、は、3つの方法すべての使用法を示しています。このThymeleafテンプレートは、ドキュメントの先頭と本文にフラグメントを追加します。

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>Thymeleaf Fragments: home</title>
<!--/*/ <th:block th:include="fragments/general.html :: headerfiles">
        </th:block> /*/-->
</head>
<body>
    <header th:insert="fragments/general.html :: header"> </header>
    <p>Go to the next page to see fragments in action</p>
    <div th:replace="fragments/general.html :: footer"></div>
</body>
</html>

次に、いくつかのフラグメントを保持するページを見てみましょう。 general.html と呼ばれ、使用できるフラグメントとして定義された一部の部分を含むページ全体のようなものです。

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head th:fragment="headerfiles">
<meta charset="UTF-8" />
<link th:href="@{/css/styles.css}" rel="stylesheet">
</head>
<body>
    <div th:fragment="header">
        <h1>Thymeleaf Fragments sample</h1>
    </div>
    <p>Go to the next page to see fragments in action</p>
    <aside>
        <div>This is a sidebar</div>
    </aside>
    <div class="another">This is another sidebar</div>
    <footer th:fragment="footer">
        <a th:href="@{/fragments}">Fragments Index</a> | 
        <a th:href="@{/markup}">Markup inclussion</a> | 
        <a th:href="@{/params}">Fragment params</a> | 
        <a th:href="@{/other}">Other</a>
    </footer>
</body>
</html>

The セクションにはスタイルシートのみが含まれていますが、Bootstrap、jQuery、Foundationなどの他のツールを直接またはWebjarを使用して適用できます。

このテンプレートのすべての再利用可能なタグには属性th：fragment があることに注意してください。ただし、次に、ページの他の部分を含める方法を説明します。

レンダリングとフラグメントのインクルード後、返されるコンテンツは次のとおりです。

<!DOCTYPE HTML>
<html>
<head>
<title>Thymeleaf Fragments: home</title>
<meta charset="UTF-8" />
<link href="/spring-thymeleaf/css/styles.css" rel="stylesheet">
</head>
<body>
    <header>
        <div>
            <h1>Thymeleaf Fragments sample</h1>
        </div>
    </header>
    <p>Go to the next page to see fragments in action</p>
    <footer>
        <a href="/spring-thymeleaf/fragments">Fragments Index</a> | 
        <a href="/spring-thymeleaf/markup">Markup inclussion</a> | 
        <a href="/spring-thymeleaf/params">Fragment params</a> | 
        <a href="/spring-thymeleaf/other">Other</a>
    </footer>
</body>
</html>

4.2. フラグメントのマークアップセレクター

Thymeleafフラグメントの優れた点の1つは、単純なセレクターを使用するだけで、クラス、ID、または単にタグを使用して、テンプレートの任意の部分を取得できることです。

たとえば、このページには、 general.htmlファイルのいくつかのコンポーネントが含まれています。asideブロックとdiv.anotherブロック：

<body>
    <header th:insert="fragments/general.html :: header"> </header>
    <div th:replace="fragments/general.html :: aside"></div>
    <div th:replace="fragments/general.html :: div.another"></div>
    <div th:replace="fragments/general.html :: footer"></div>
</body>

4.3. パラメータ化されたフラグメント

フラグメントにパラメーターを渡して、その特定の部分を変更することができます。そのためには、フラグメントを関数呼び出しとして定義する必要があります。ここで、パラメーターのリストを宣言する必要があります。

この例では、汎用フォームフィールドのフラグメントを定義します。

<div th:fragment="formField (field, value, size)">
    <div>
        <label th:for="${#strings.toLowerCase(field)}"> <span
            th:text="${field}">Field</span>
        </label>
    </div>
    <div>
        <input type="text" th:id="${#strings.toLowerCase(field)}"
            th:name="${#strings.toLowerCase(field)}" th:value="${value}"
            th:size="${size}">
    </div>
</div>

そして、パラメータを渡すフラグメントの簡単な使用法は次のとおりです。

<body>
    <header th:insert="fragments/general.html :: header"> </header>
    <div th:replace="fragments/forms.html
      :: formField(field='Name', value='John Doe',size='40')">
    </div>
    <div th:replace="fragments/general.html :: footer"></div>
</body>

そして、これは返されるフィールドがどのように見えるかです：

<div>
    <div>
        <label for="name"> <span>Name</span>
        </label>
    </div>
    <div>
        <input type="text" id="name"
        name="name" value="John Doe"
        size="40">
    </div>
</div>

4.4. フラグメント包含式

Thymeleafフラグメントは、フラグメントを含めるかどうかを決定するための条件式のサポートなど、他の興味深いオプションを提供します。

Elvis 演算子を、Thymeleafが提供する式（セキュリティ、文字列、コレクションなど）のいずれかで使用すると、さまざまなフラグメントをロードできます。

たとえば、特定の条件に応じて表示するコンテンツを使用して、このフラグメントを定義できます。これは、さまざまな種類のブロックを含むファイルである可能性があります。

<div th:fragment="dataPresent">Data received</div>
<div th:fragment="noData">No data</div>

そして、これは私たちがそれらに式をロードする方法です：

<div
    th:replace="${#lists.size(data) > 0} ? 
        ~{fragments/menus.html :: dataPresent} : 
        ~{fragments/menus.html :: noData}">
</div>

Thymeleaf式の詳細については、記事こちらを確認してください。

4.5. 柔軟なレイアウト

次の例は、データを含むテーブルをレンダリングするためのフラグメントの他の2つの興味深い使用法も示しています。これは再利用可能なテーブルフラグメントであり、2つの重要な部分があります。変更可能なテーブルヘッダーと、データがレンダリングされる本文です。

<table>
    <thead th:fragment="fields(theadFields)">
        <tr th:replace="${theadFields}">
        </tr>
    </thead>
    <tbody th:fragment="tableBody(tableData)">
        <tr th:each="row: ${tableData}">
            <td th:text="${row.id}">0</td>
            <td th:text="${row.name}">Name</td>
        </tr>
    </tbody>
    <tfoot>
    </tfoot>
</table>

このテーブルを使用する場合は、fields関数を使用して独自のテーブルヘッダーを渡すことができます。ヘッダーは、クラスmyFieldsで参照されます。テーブル本体は、tableBody関数にパラメーターとしてデータを渡すことによってロードされます。

<body>
    <header th:replace="fragments/general.html :: header"> </header>
    <table>
        <thead th:replace="fragments/tables.html
              :: fields(~{ :: .myFields})">
            <tr class="myFields">

                <th>Id</th>
                <th>Name</th>
            </tr>
        </thead>
        <div th:replace="fragments/tables.html
          :: tableBody(tableData=${data})">
        </div>
    </table>
    <div th:replace="fragments/general.html :: footer"></div>
</body>

そして、これが最終ページの外観です。

<body>
    <div>
        <h1>Thymeleaf Fragments sample</h1>
    </div>
    <div>Data received</div>
    <table>
        <thead>
            <tr class="myFields">

                <th>Id</th>
                <th>Name</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>1001</td>
                <td>John Smith</td>
            </tr>
            <tr>
                <td>1002</td>
                <td>Jane Williams</td>
            </tr>
        </tbody>
    </table>
    <footer>
        <a href="/spring-thymeleaf/fragments">Fragments Index</a> |
        <a href="/spring-thymeleaf/markup">Markup inclussion</a> |
        <a href="/spring-thymeleaf/params">Fragment params</a> |
        <a href="/spring-thymeleaf/other">Other</a>
    </footer>
</body>

5. 結論

この記事では、テンプレート管理を容易にする強力なツールであるThymeleafFragmentsを使用してビューコンポーネントを再利用する方法を示しました。

また、基本を超えた他の興味深い機能もいくつか紹介しました。ビューレンダリングエンジンとしてThymeleafを選択するときは、これらを考慮に入れる必要があります。

他のThymeleaf機能について知りたい場合は、レイアウト方言に関する記事を必ずご覧ください。

いつものように、例の完全な実装コードは、GitHubでから入手できます。

getdocs

13036