Edited at

2-way SQLパーサとしてThymeleafが使えるか試してみた

ふと・・・SpringのJdbcTemplate(NamedParameterJdbcTemplate)などに指定するSQLを、2-way SQLとして定義できないかな〜と思い、いろいろ方法はありそうですが今回はThymeleaf(テンプレートエンジン)を使用してSQLの2-way SQL化を試みてみました。


開発プロジェクト


検証バージョン


  • Spring Boot 2.1.0.RELEASE

  • Thymeleaf 3.0.11.RELEASE


プロジェクトの作成

SPRING INITIALIZRを使用して、依存アーティファクトに「JDBC」「H2」「Thymeleaf」を選択してMavenプロジェクトを作成。

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>

<name>th-demo</name>
<description>Demo project for Spring Boot</description>

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.0.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>

</project>


NOTE:

Spring Bootを使う必要はありませんが、簡単にThymeleafを使用したSpringアプリを作ることができるのでSpring Bootを使いました。



SQLファイルの準備

2-way SQLはSQLファイルに記述。


src/main/resources/templates/users/findByName.sql

SELECT

id ,name
FROM
users
WHERE
1 = 1
/*[# th:if="${name} != null"]*/
AND name = /*[(|:name|)]*/ 'Kazuki'
/*[/]*/
ORDER BY
id


nameを指定した時に生成されるSQL

SELECT

id ,name
FROM
users
WHERE
1 = 1

AND name = :name

ORDER BY
id



nameを指定しない時に生成されるSQL

SELECT

id ,name
FROM
users
WHERE
1 = 1

ORDER BY
id



Thymeleafの設定

Thymeleafのテンプレートモードには残念ながらSQL用のモードはないのですが、コメントの形式が同じJavaScriptとCSS用のモードがあります。これらのモードを使用すると「2-way JavaScript」「2-way CSS」的なことができるので、今回はJavaScript用のテンプレートモードを指定するようにしてみました。また、Spring Bootのデフォルト設定ではテンプレートファイルのサフィックス(拡張子部分)がHTML用の設定(.html)になっているため、SQLファイル用の設定(.sql)へ変更。

spring.thymeleaf.mode=JAVASCRIPT

spring.thymeleaf.suffix=.sql


データベースのセットアップ

検証用にデータベース(テーブル作成+データ登録)をセットアップ。


テーブル作成


src/main/resources/schema.sql

DROP TABLE IF EXISTS users;

CREATE TABLE users
(
id int,
name varchar(128)
);


データ登録


src/main/resources/data.sql

INSERT INTO users VALUES(1, 'Kazuki');

INSERT INTO users VALUES(2, 'Shimizu');


動作検証

JUnitのテストケースを作成し、2-way SQLの動作を検証。

package com.example.demo;

import org.assertj.core.api.Assertions;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
import org.springframework.test.context.junit4.SpringRunner;
import org.thymeleaf.ITemplateEngine;
import org.thymeleaf.context.Context;

import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

@RunWith(SpringRunner.class)
@SpringBootTest
public class ThDemoApplicationTests {

@Autowired
NamedParameterJdbcOperations jdbcOperations;

@Autowired
ITemplateEngine templateEngine;

@Test
public void specifyName() {
Map<String, Object> params = new HashMap<>();
params.put("name", "Shimizu");
Context ctx = new Context(Locale.getDefault(), params);

String sql = templateEngine.process("users/findByName", ctx);
System.out.println(sql);

List<Map<String, Object>> records = jdbcOperations.queryForList(sql, params);
Assertions.assertThat(records).hasSize(1);
Assertions.assertThat(records.get(0)).containsEntry("ID", 2);
Assertions.assertThat(records.get(0)).containsEntry("NAME", "Shimizu");
}

@Test
public void nameNotSpecify() {
Map<String, Object> params = new HashMap<>();
Context ctx = new Context(Locale.getDefault(), params);

String sql = templateEngine.process("users/findByName", ctx);
System.out.println(sql);

List<Map<String, Object>> records = jdbcOperations.queryForList(sql, params);
Assertions.assertThat(records).hasSize(2);
Assertions.assertThat(records.get(0)).containsEntry("ID", 1);
Assertions.assertThat(records.get(0)).containsEntry("NAME", "Kazuki");
Assertions.assertThat(records.get(1)).containsEntry("ID", 2);
Assertions.assertThat(records.get(1)).containsEntry("NAME", "Shimizu");
}

}


まとめ

とりあえず、それっぽい動作をさせることができそうなことは確認できましたが・・・ThymeleafがSQLをサポートしているわけではない(=今回はJavaScript用のテンプレートモードを代用している)ので、やや微妙な気はしています。(→Thymeleafに「SQL」のサポートを提案してみるのは「あり」かも!?)

ThymeleafにIssueを作ってみました。