19 |
20 | 
21 |
22 |
23 |
21 |
22 | -------------------------------------------------------------------------------- /src/test/resources/sql/PersonMapper/insertByBulk.sql: -------------------------------------------------------------------------------- 1 | -- 2 | -- Copyright 2018-2022 the original author or authors. 3 | -- 4 | -- Licensed under the Apache License, Version 2.0 (the "License"); 5 | -- you may not use this file except in compliance with the License. 6 | -- You may obtain a copy of the License at 7 | -- 8 | -- https://www.apache.org/licenses/LICENSE-2.0 9 | -- 10 | -- Unless required by applicable law or agreed to in writing, software 11 | -- distributed under the License is distributed on an "AS IS" BASIS, 12 | -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | -- See the License for the specific language governing permissions and 14 | -- limitations under the License. 15 | -- 16 | 17 | INSERT INTO persons (name) VALUES 18 | /*[# th:each="person : ${list}"]*/ 19 | ( 20 | /*[# mb:p="person.name"]*/ 'Taro Yamada' /*[/]*/ 21 | )/*[(${personStat.last} ? '' : ',')]*/ 22 | /*[/]*/ 23 | -------------------------------------------------------------------------------- /src/main/asciidoc/docinfos/docinfo-footer.html: -------------------------------------------------------------------------------- 1 | 18 |
19 |
23 |
--------------------------------------------------------------------------------
/src/main/java/org/mybatis/scripting/thymeleaf/support/spring/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2018-2022 the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | /**
17 | * The package that holds classes for supporting integration with Spring family.
18 | *
19 | * @since 1.0.2
20 | */
21 | package org.mybatis.scripting.thymeleaf.support.spring;
--------------------------------------------------------------------------------
/src/test/resources/sql/NameMapper/findByIdWithNestedParam.sql:
--------------------------------------------------------------------------------
1 | --
2 | -- Copyright 2018-2022 the original author or authors.
3 | --
4 | -- Licensed under the Apache License, Version 2.0 (the "License");
5 | -- you may not use this file except in compliance with the License.
6 | -- You may obtain a copy of the License at
7 | --
8 | -- https://www.apache.org/licenses/LICENSE-2.0
9 | --
10 | -- Unless required by applicable law or agreed to in writing, software
11 | -- distributed under the License is distributed on an "AS IS" BASIS,
12 | -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | -- See the License for the specific language governing permissions and
14 | -- limitations under the License.
15 | --
16 |
17 | SELECT * FROM names
18 | WHERE 1 = 1
19 | /*[# th:if="${p.id} != null"]*/
20 | AND id = /*[# mb:p="p.id,typeHandler=org.apache.ibatis.type.IntegerTypeHandler"]*/ 1 /*[/]*/
21 | /*[/]*/
22 |
--------------------------------------------------------------------------------
/src/test/resources/sql/OneWayNameMapper/insertByBulk.sql:
--------------------------------------------------------------------------------
1 | --
2 | -- Copyright 2018-2022 the original author or authors.
3 | --
4 | -- Licensed under the Apache License, Version 2.0 (the "License");
5 | -- you may not use this file except in compliance with the License.
6 | -- You may obtain a copy of the License at
7 | --
8 | -- https://www.apache.org/licenses/LICENSE-2.0
9 | --
10 | -- Unless required by applicable law or agreed to in writing, software
11 | -- distributed under the License is distributed on an "AS IS" BASIS,
12 | -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | -- See the License for the specific language governing permissions and
14 | -- limitations under the License.
15 | --
16 |
17 | INSERT INTO names (firstName, lastName) VALUES
18 | [# th:each="name : ${list}"]
19 | (
20 | [# mb:p="name.firstName" /], [# mb:p="name.lastName" /]
21 | )[(${nameStat.last ? '' : ','})]
22 | [/]
23 |
--------------------------------------------------------------------------------
/src/site/site.xml:
--------------------------------------------------------------------------------
1 |
18 |
20 |
22 | Copyright ©2018-{localyear} MyBatis.org. All rights reserved.
21 |19 | * The mybatis-thymeleaf provides utility expression object. 20 | *
-
21 | *
- #likes 22 | *
19 | * The mybatis-thymeleaf is a plugin that helps applying the 2-way SQL/dynamic SQL feature to the MyBatis 3 using the 20 | * template(or natural template) mechanism provided by Thymeleaf 3. 21 | */ 22 | package org.mybatis.scripting.thymeleaf; -------------------------------------------------------------------------------- /src/test/resources/sql/NameMapper/findByIdsWithoutParamAnnotation.sql: -------------------------------------------------------------------------------- 1 | -- 2 | -- Copyright 2018-2022 the original author or authors. 3 | -- 4 | -- Licensed under the Apache License, Version 2.0 (the "License"); 5 | -- you may not use this file except in compliance with the License. 6 | -- You may obtain a copy of the License at 7 | -- 8 | -- https://www.apache.org/licenses/LICENSE-2.0 9 | -- 10 | -- Unless required by applicable law or agreed to in writing, software 11 | -- distributed under the License is distributed on an "AS IS" BASIS, 12 | -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | -- See the License for the specific language governing permissions and 14 | -- limitations under the License. 15 | -- 16 | 17 | SELECT * FROM names 18 | WHERE 1 = 1 19 | /*[# th:if="${not #lists.isEmpty(list)}"]*/ 20 | AND id IN ( 21 | /*[# th:each="id : ${list}"]*/ 22 | /*[(${idStat.first ? '' : ','})]*/ 23 | /*[# mb:p="id"]*/ 1 /*[/]*/ 24 | /*[/]*/ 25 | ) 26 | /*[/]*/ 27 | ORDER BY id 28 | -------------------------------------------------------------------------------- /src/test/resources/sql/NameMapper/update.sql: -------------------------------------------------------------------------------- 1 | -- 2 | -- Copyright 2018-2022 the original author or authors. 3 | -- 4 | -- Licensed under the Apache License, Version 2.0 (the "License"); 5 | -- you may not use this file except in compliance with the License. 6 | -- You may obtain a copy of the License at 7 | -- 8 | -- https://www.apache.org/licenses/LICENSE-2.0 9 | -- 10 | -- Unless required by applicable law or agreed to in writing, software 11 | -- distributed under the License is distributed on an "AS IS" BASIS, 12 | -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | -- See the License for the specific language governing permissions and 14 | -- limitations under the License. 15 | -- 16 | 17 | UPDATE names 18 | SET id = id 19 | /*[# th:if="${firstName} != null"]*/ 20 | ,firstName = /*[# mb:p="firstName"]*/ 'Taro' /*[/]*/ 21 | /*[/]*/ 22 | /*[# th:if="${lastName} != null"]*/ 23 | ,lastName = /*[# mb:p="lastName"]*/ 'Yamada' /*[/]*/ 24 | /*[/]*/ 25 | WHERE id = /*[# mb:p="id"]*/ 1 /*[/]*/ 26 | -------------------------------------------------------------------------------- /.github/workflows/sonar.yaml: -------------------------------------------------------------------------------- 1 | name: SonarCloud 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | permissions: read-all 9 | 10 | jobs: 11 | build: 12 | if: github.repository_owner == 'mybatis' 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v6 16 | with: 17 | # Disabling shallow clone is recommended for improving relevancy of reporting 18 | fetch-depth: 0 19 | - name: Set up JDK 20 | uses: actions/setup-java@v5 21 | with: 22 | cache: maven 23 | distribution: temurin 24 | java-version: 21 25 | - name: Analyze with SonarCloud 26 | run: ./mvnw verify jacoco:report sonar:sonar -B -V -Dlog.level.thymeleaf.config=info -Dsonar.projectKey=mybatis_thymeleaf-scripting -Dsonar.organization=mybatis -Dsonar.host.url=https://sonarcloud.io -Dsonar.token=$SONAR_TOKEN -Dlicense.skip=true --no-transfer-progress 27 | env: 28 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 29 | SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} 30 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/scripting/thymeleaf/processor/package-info.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | /** 17 | * The package that holds classes for mybatis-thymeleaf's processor. 18 | *
19 | * The mybatis-thymeleaf provides processors for following custom attribute tag. 20 | *
-
21 | *
- mb:p 22 | *
- mb:bind 23 | *
24 | * If you want to customize a default {@code BindVariableRender}, you implements class of this interface and you need to 25 | * specify the 'dialect.bind-variable-render' property of mybatis-thymeleaf.properties.
26 | *
27 | * e.g.) Implementation class: 28 | * 29 | *
30 | * package com.example;
31 | *
32 | * // ...
33 | * public class R2dbcMySQLBindVariableRender extends EnclosingBasedBindVariableRender {
34 | * public R2dbcMySQLBindVariableRender() {
35 | * super("?", ""); // Render '?...' (e.g. ?id)
36 | * }
37 | * }
38 | *
39 | *
40 | * 41 | * e.g.) Configuration file (mybatis-thymeleaf.properties): 42 | * 43 | *
44 | * dialect.bind-variable-render = com.example.MyBindVariableRender 45 | *46 | * 47 | * @author Kazuki Shimizu 48 | * 49 | * @version 1.0.2 50 | */ 51 | @FunctionalInterface 52 | public interface BindVariableRender extends UnaryOperator
82 | * This is default. 83 | *
84 | */ 85 | MYBATIS(name -> "#{" + name + "}"), 86 | /** 87 | * The render for Spring JDBC named parameter format(.e.g {@literal :id}). 88 | */ 89 | SPRING_NAMED_PARAMETER(new SpringNamedParameterBindVariableRender()); 90 | 91 | private final BindVariableRender delegate; 92 | 93 | BuiltIn(BindVariableRender delegate) { 94 | this.delegate = delegate; 95 | } 96 | 97 | /** 98 | * {@inheritDoc} 99 | */ 100 | @Override 101 | public String render(String name) { 102 | return delegate.render(name); 103 | } 104 | 105 | /** 106 | * Get a type of the actual {@link BindVariableRender}. 107 | * 108 | * @return a type of delegating {@link BindVariableRender} 109 | */ 110 | public Class getType() { 111 | return delegate.getClass(); 112 | } 113 | 114 | } 115 | 116 | } 117 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/scripting/thymeleaf/ThymeleafLanguageDriver.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.scripting.thymeleaf; 17 | 18 | import org.apache.ibatis.executor.parameter.ParameterHandler; 19 | import org.apache.ibatis.mapping.BoundSql; 20 | import org.apache.ibatis.mapping.MappedStatement; 21 | import org.apache.ibatis.mapping.SqlSource; 22 | import org.apache.ibatis.parsing.XNode; 23 | import org.apache.ibatis.scripting.LanguageDriver; 24 | import org.apache.ibatis.scripting.defaults.DefaultParameterHandler; 25 | import org.apache.ibatis.session.Configuration; 26 | import org.mybatis.scripting.thymeleaf.support.TemplateFilePathProvider; 27 | import org.thymeleaf.ITemplateEngine; 28 | 29 | /** 30 | * The {@code LanguageDriver} for integrating with Thymeleaf. 31 | * 32 | * @author Kazuki Shimizu 33 | * 34 | * @version 1.0.0 35 | */ 36 | public class ThymeleafLanguageDriver implements LanguageDriver { 37 | 38 | private final SqlGenerator sqlGenerator; 39 | 40 | /** 41 | * Constructor for creating instance with default {@code TemplateEngine}. 42 | */ 43 | public ThymeleafLanguageDriver() { 44 | this.sqlGenerator = configure(new SqlGenerator(ThymeleafLanguageDriverConfig.newInstance())); 45 | } 46 | 47 | /** 48 | * Constructor for creating instance with user specified {@code Properties}. 49 | * 50 | * @param config 51 | * A user defined {@code ITemplateEngine} instance 52 | */ 53 | public ThymeleafLanguageDriver(ThymeleafLanguageDriverConfig config) { 54 | this.sqlGenerator = configure(new SqlGenerator(config)); 55 | TemplateFilePathProvider.setLanguageDriverConfig(config); 56 | } 57 | 58 | /** 59 | * Constructor for creating instance with user defined {@code ITemplateEngine}. 60 | * 61 | * @param templateEngine 62 | * A user defined {@code ITemplateEngine} instance 63 | */ 64 | public ThymeleafLanguageDriver(ITemplateEngine templateEngine) { 65 | this.sqlGenerator = configure(new SqlGenerator(templateEngine)); 66 | } 67 | 68 | private SqlGenerator configure(SqlGenerator sqlGenerator) { 69 | sqlGenerator.setContextFactory(new ThymeleafSqlSource.ContextFactory()); 70 | return sqlGenerator; 71 | } 72 | 73 | /** 74 | * {@inheritDoc} 75 | */ 76 | @Override 77 | public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, 78 | BoundSql boundSql) { 79 | return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql); 80 | } 81 | 82 | /** 83 | * {@inheritDoc} 84 | */ 85 | @Override 86 | public SqlSource createSqlSource(Configuration configuration, XNode script, Class parameterType) { 87 | return createSqlSource(configuration, script.getNode().getTextContent(), parameterType); 88 | } 89 | 90 | /** 91 | * {@inheritDoc} 92 | */ 93 | @Override 94 | public SqlSource createSqlSource(Configuration configuration, String script, Class parameterType) { 95 | return new ThymeleafSqlSource(configuration, sqlGenerator, script.trim(), parameterType); 96 | } 97 | 98 | } 99 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/scripting/thymeleaf/MyBatisDialectTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.scripting.thymeleaf; 17 | 18 | import java.io.Reader; 19 | import java.sql.Connection; 20 | 21 | import org.apache.ibatis.annotations.Select; 22 | import org.apache.ibatis.io.Resources; 23 | import org.apache.ibatis.jdbc.ScriptRunner; 24 | import org.apache.ibatis.mapping.Environment; 25 | import org.apache.ibatis.session.Configuration; 26 | import org.apache.ibatis.session.SqlSession; 27 | import org.apache.ibatis.session.SqlSessionFactory; 28 | import org.apache.ibatis.session.SqlSessionFactoryBuilder; 29 | import org.apache.ibatis.transaction.TransactionFactory; 30 | import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory; 31 | import org.hsqldb.jdbc.JDBCDataSource; 32 | import org.junit.jupiter.api.Assertions; 33 | import org.junit.jupiter.api.BeforeAll; 34 | import org.junit.jupiter.api.Test; 35 | import org.mybatis.scripting.thymeleaf.integrationtest.domain.Name; 36 | 37 | class MyBatisDialectTest { 38 | 39 | private static SqlSessionFactory sqlSessionFactory; 40 | 41 | @BeforeAll 42 | static void setUp() throws Exception { 43 | Class.forName("org.hsqldb.jdbcDriver"); 44 | JDBCDataSource dataSource = new JDBCDataSource(); 45 | dataSource.setUrl("jdbc:hsqldb:mem:dialect-db"); 46 | dataSource.setUser("sa"); 47 | dataSource.setPassword(""); 48 | 49 | TransactionFactory transactionFactory = new JdbcTransactionFactory(); 50 | Environment environment = new Environment("development", transactionFactory, dataSource); 51 | 52 | Configuration configuration = new Configuration(environment); 53 | configuration.getLanguageRegistry().register(new ThymeleafLanguageDriver( 54 | ThymeleafLanguageDriverConfig.newInstance(c -> c.getDialect().setPrefix("mybatis")))); 55 | configuration.setDefaultScriptingLanguage(ThymeleafLanguageDriver.class); 56 | configuration.getMapperRegistry().addMapper(Mapper.class); 57 | sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration); 58 | 59 | try (Connection conn = sqlSessionFactory.getConfiguration().getEnvironment().getDataSource().getConnection()) { 60 | try (Reader reader = Resources.getResourceAsReader("create-db.sql")) { 61 | ScriptRunner runner = new ScriptRunner(conn); 62 | runner.setLogWriter(null); 63 | runner.setErrorLogWriter(null); 64 | runner.runScript(reader); 65 | conn.commit(); 66 | } 67 | } 68 | } 69 | 70 | @Test 71 | void testCustomDialectPrefix() { 72 | try (SqlSession sqlSession = sqlSessionFactory.openSession()) { 73 | Mapper mapper = sqlSession.getMapper(Mapper.class); 74 | Name name = mapper.select(1); 75 | Assertions.assertEquals("Fred", name.getFirstName()); 76 | } 77 | } 78 | 79 | @Test 80 | void testDefaultConstructor() { 81 | MyBatisDialect dialect = new MyBatisDialect(); 82 | Assertions.assertEquals("mb", dialect.getPrefix()); 83 | } 84 | 85 | interface Mapper { 86 | @Select("SELECT * FROM names WHERE id = /*[# mybatis:p='id']*/ 1000 /*[/]*/") 87 | Name select(int id); 88 | } 89 | 90 | } 91 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/scripting/thymeleaf/TemplateEngineCustomizer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.scripting.thymeleaf; 17 | 18 | import java.util.Optional; 19 | import java.util.function.Consumer; 20 | 21 | import org.thymeleaf.TemplateEngine; 22 | import org.thymeleaf.templateresolver.ITemplateResolver; 23 | 24 | /** 25 | * The interface for customizing a default {@code TemplateEngine} instanced by the MyBatis Thymeleaf.26 | * If you want to customize a default {@code TemplateEngine}, you implements class of this interface and you need to 27 | * specify the 'customizer' property of mybatis-thymeleaf.properties.
28 | *
29 | * e.g.) Implementation class: 30 | * 31 | *
32 | * package com.example;
33 | *
34 | * // ...
35 | * public class MyTemplateEngineCustomizer implements TemplateEngineCustomizer {
36 | * public void customize(TemplateEngine defaultTemplateEngine) {
37 | * // ...
38 | * }
39 | * }
40 | *
41 | *
42 | * 43 | * e.g.) Configuration file (mybatis-thymeleaf.properties): 44 | * 45 | *
46 | * customizer = com.example.MyTemplateEngineCustomizer 47 | *48 | * 49 | * @author Kazuki Shimizu 50 | * 51 | * @version 1.0.0 52 | */ 53 | @FunctionalInterface 54 | public interface TemplateEngineCustomizer extends Consumer
101 | * This customizer instance do nothing. 102 | *
103 | */ 104 | DO_NOTHING { 105 | @Override 106 | public void customize(TemplateEngine defaultTemplateEngine) { 107 | // NOP 108 | } 109 | } 110 | 111 | } 112 | 113 | } 114 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/scripting/thymeleaf/processor/MyBatisBindTagProcessor.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.scripting.thymeleaf.processor; 17 | 18 | import java.util.List; 19 | import java.util.Objects; 20 | 21 | import org.mybatis.scripting.thymeleaf.MyBatisBindingContext; 22 | import org.thymeleaf.context.ITemplateContext; 23 | import org.thymeleaf.engine.AttributeName; 24 | import org.thymeleaf.exceptions.TemplateProcessingException; 25 | import org.thymeleaf.model.IProcessableElementTag; 26 | import org.thymeleaf.processor.element.AbstractAttributeTagProcessor; 27 | import org.thymeleaf.processor.element.IElementTagStructureHandler; 28 | import org.thymeleaf.standard.expression.Assignation; 29 | import org.thymeleaf.standard.expression.AssignationSequence; 30 | import org.thymeleaf.standard.expression.AssignationUtils; 31 | import org.thymeleaf.standard.expression.IStandardExpression; 32 | import org.thymeleaf.templatemode.TemplateMode; 33 | import org.thymeleaf.util.StringUtils; 34 | 35 | /** 36 | * The processor class for handling the {@code mybatis:bind} tag.37 | * This processor register an any value to the MyBatis’s bind variables (similar to that of the {@code
98 | * Variable name rule is {@code {objectName}_{status list index}_{status.getIndex()}}. 99 | * 100 | * @param objectName 101 | * base object name 102 | * @param status 103 | * iteration status object 104 | * 105 | * @return an unique variable name per iteration object 106 | */ 107 | public String generateUniqueName(String objectName, IterationStatusVar status) { 108 | return iterationStatusManager.generateUniqueName(objectName, status); 109 | } 110 | 111 | /** 112 | * Return whether use fallback parameter object when parameter is value object. 113 | * 114 | * @return If use fallback parameter object, return {@code true} 115 | */ 116 | boolean isFallbackParameterObject() { 117 | return fallbackParameterObject; 118 | } 119 | 120 | private static class IterationStatusManager { 121 | 122 | private final Map
38 | * This dialect provides following features. This dialect prefix is {@code "mb"} by default. 39 | *
-
40 | *
- {@code #likes} expression : {@link Likes} 41 | *
- {@code mb:p} attribute tag: {@link MyBatisParamTagProcessor} 42 | *
- {@code mb:bind} attribute tag : {@link MyBatisBindTagProcessor} 43 | *
76 | * 77 | * @param likes 78 | * An expression utility object that provide helper method for like feature 79 | */ 80 | public void setLikes(Likes likes) { 81 | this.likes = likes; 82 | } 83 | 84 | /** 85 | * Set a bind variable render. 86 | * 87 | * @param bindVariableRender 88 | * a bind variable render 89 | * 90 | * @since 1.0.2 91 | */ 92 | public void setBindVariableRender(BindVariableRender bindVariableRender) { 93 | this.bindVariableRender = bindVariableRender; 94 | } 95 | 96 | /** 97 | * {@inheritDoc} 98 | */ 99 | @Override 100 | public Set
27 | * This object can be access using {@code #likes}) as expression utility object. 28 | * 29 | * @author Kazuki Shimizu 30 | * 31 | * @version 1.0.0 32 | */ 33 | public class Likes { 34 | 35 | private char escapeChar = '\\'; 36 | 37 | private Set
50 | * By default configuration, this method escape the {@code "%"} and {@code "_"} using {@code "\"}. 51 | * 52 | * @param value 53 | * A target condition value 54 | * 55 | * @return A escaped value 56 | */ 57 | public String escapeWildcard(String value) { 58 | if (value == null || value.isEmpty()) { 59 | return ""; 60 | } 61 | StringBuilder sb = new StringBuilder(value.length() + 16); 62 | for (char c : value.toCharArray()) { 63 | if (c == escapeChar || c == '%' || c == '_' || additionalEscapeTargetChars.contains(c)) { 64 | sb.append(escapeChar); 65 | } 66 | sb.append(c); 67 | } 68 | return sb.toString(); 69 | } 70 | 71 | /** 72 | * Return a escape clause string of LIKE.
73 | * By default configuration, this method return {@code "ESCAPE '\'"}. 74 | * 75 | * @return A escape clause string of LIKE 76 | */ 77 | public String escapeClause() { 78 | return escapeClauseSupplier.apply(escapeChar); 79 | } 80 | 81 | /** 82 | * Creates a new builder instance for {@link Likes}. 83 | * 84 | * @return a new builder instance 85 | */ 86 | public static Builder newBuilder() { 87 | return new Builder(); 88 | } 89 | 90 | /** 91 | * The builder class for {@link Likes}. 92 | */ 93 | public static class Builder { 94 | 95 | private final Likes instance = new Likes(); 96 | 97 | private Builder() { 98 | // NOP 99 | } 100 | 101 | /** 102 | * Set an escape character for wildcard of LIKE.
103 | * The default value is {@code '\'} (backslash) 104 | * 105 | * @param escapeChar 106 | * A escape character 107 | * 108 | * @return A self instance 109 | */ 110 | public Builder escapeChar(Character escapeChar) { 111 | Optional.ofNullable(escapeChar).ifPresent(v -> instance.escapeChar = v); 112 | return this; 113 | } 114 | 115 | /** 116 | * Set additional escape target characters(custom wildcard characters) for LIKE condition.
117 | * The default value is nothing. 118 | * 119 | * @param additionalEscapeTargetChars 120 | * escape target characters(custom wildcard characters) 121 | * 122 | * @return A self instance 123 | */ 124 | public Builder additionalEscapeTargetChars(Character... additionalEscapeTargetChars) { 125 | Optional.ofNullable(additionalEscapeTargetChars) 126 | .ifPresent(v -> instance.additionalEscapeTargetChars = Arrays.stream(v).collect(Collectors.toSet())); 127 | return this; 128 | } 129 | 130 | /** 131 | * Set a format of escape clause.
132 | * The default value is {@code "ESCAPE '%s'"}. 133 | * 134 | * @param escapeClauseFormat 135 | * a format of escape clause 136 | * 137 | * @return A self instance 138 | */ 139 | public Builder escapeClauseFormat(String escapeClauseFormat) { 140 | Optional.ofNullable(escapeClauseFormat) 141 | .ifPresent(v -> instance.escapeClauseSupplier = escapeChar -> String.format(v, escapeChar)); 142 | return this; 143 | } 144 | 145 | /** 146 | * Return a {@link Likes} instance . 147 | * 148 | * @return A {@link Likes} instance corresponding with specified option 149 | */ 150 | public Likes build() { 151 | return instance; 152 | } 153 | 154 | } 155 | 156 | } 157 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/scripting/thymeleaf/integrationtest/TemplateFilePathProviderMapperNoCacheTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.scripting.thymeleaf.integrationtest; 17 | 18 | import java.io.Reader; 19 | import java.sql.Connection; 20 | 21 | import org.apache.ibatis.io.Resources; 22 | import org.apache.ibatis.jdbc.ScriptRunner; 23 | import org.apache.ibatis.mapping.Environment; 24 | import org.apache.ibatis.session.Configuration; 25 | import org.apache.ibatis.session.SqlSession; 26 | import org.apache.ibatis.session.SqlSessionFactory; 27 | import org.apache.ibatis.session.SqlSessionFactoryBuilder; 28 | import org.apache.ibatis.transaction.TransactionFactory; 29 | import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory; 30 | import org.hsqldb.jdbc.JDBCDataSource; 31 | import org.junit.jupiter.api.Assertions; 32 | import org.junit.jupiter.api.BeforeAll; 33 | import org.junit.jupiter.api.Test; 34 | import org.junit.jupiter.api.condition.DisabledIfSystemProperty; 35 | import org.mybatis.scripting.thymeleaf.ThymeleafLanguageDriver; 36 | import org.mybatis.scripting.thymeleaf.ThymeleafLanguageDriverConfig; 37 | import org.mybatis.scripting.thymeleaf.integrationtest.domain.Name; 38 | import org.mybatis.scripting.thymeleaf.integrationtest.mapper.TemplateFilePathProviderMapper; 39 | 40 | @DisabledIfSystemProperty(named = "mybatis.version", matches = "3\\.4\\..*|3\\.5\\.0") 41 | class TemplateFilePathProviderMapperNoCacheTest { 42 | private static SqlSessionFactory sqlSessionFactory; 43 | 44 | @BeforeAll 45 | static void setUp() throws Exception { 46 | Class.forName("org.hsqldb.jdbcDriver"); 47 | JDBCDataSource dataSource = new JDBCDataSource(); 48 | dataSource.setUrl("jdbc:hsqldb:mem:db1"); 49 | dataSource.setUser("sa"); 50 | dataSource.setPassword(""); 51 | 52 | try (Connection conn = dataSource.getConnection()) { 53 | try (Reader reader = Resources.getResourceAsReader("create-db.sql")) { 54 | ScriptRunner runner = new ScriptRunner(conn); 55 | runner.setLogWriter(null); 56 | runner.setErrorLogWriter(null); 57 | runner.runScript(reader); 58 | conn.commit(); 59 | } 60 | } 61 | 62 | TransactionFactory transactionFactory = new JdbcTransactionFactory(); 63 | Environment environment = new Environment("development", transactionFactory, dataSource); 64 | 65 | Configuration configuration = new Configuration(environment); 66 | configuration.setMapUnderscoreToCamelCase(true); 67 | configuration.getLanguageRegistry() 68 | .register(new ThymeleafLanguageDriver(ThymeleafLanguageDriverConfig.newInstance(c -> { 69 | c.getTemplateFile().getPathProvider().setPrefix("sql/"); 70 | c.getTemplateFile().getPathProvider().setIncludesPackagePath(false); 71 | c.getTemplateFile().getPathProvider().setCacheEnabled(false); 72 | }))); 73 | configuration.setDefaultScriptingLanguage(ThymeleafLanguageDriver.class); 74 | 75 | configuration.addMapper(TemplateFilePathProviderMapper.class); 76 | sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration); 77 | } 78 | 79 | @Test 80 | void testInsert() { 81 | try (SqlSession sqlSession = sqlSessionFactory.openSession()) { 82 | TemplateFilePathProviderMapper mapper = sqlSession.getMapper(TemplateFilePathProviderMapper.class); 83 | Name name = new Name(); 84 | name.setFirstName("Thymeleaf"); 85 | name.setLastName("MyBatis"); 86 | mapper.insert(name); 87 | 88 | Name loadedName = mapper.findById(name.getId()); 89 | Assertions.assertEquals(name.getFirstName(), loadedName.getFirstName()); 90 | Assertions.assertEquals(name.getLastName(), loadedName.getLastName()); 91 | } 92 | } 93 | 94 | @Test 95 | void testUpdate() { 96 | try (SqlSession sqlSession = sqlSessionFactory.openSession()) { 97 | TemplateFilePathProviderMapper mapper = sqlSession.getMapper(TemplateFilePathProviderMapper.class); 98 | Name name = new Name(); 99 | name.setFirstName("Thymeleaf"); 100 | name.setLastName("MyBatis"); 101 | mapper.insert(name); 102 | 103 | Name updatingName = new Name(); 104 | updatingName.setId(name.getId()); 105 | updatingName.setFirstName("Thymeleaf3"); 106 | mapper.update(updatingName); 107 | 108 | Name loadedName = mapper.findById(name.getId()); 109 | Assertions.assertEquals(updatingName.getFirstName(), loadedName.getFirstName()); 110 | Assertions.assertEquals(name.getLastName(), loadedName.getLastName()); 111 | } 112 | } 113 | 114 | @Test 115 | void testDelete() { 116 | try (SqlSession sqlSession = sqlSessionFactory.openSession()) { 117 | TemplateFilePathProviderMapper mapper = sqlSession.getMapper(TemplateFilePathProviderMapper.class); 118 | Name name = new Name(); 119 | name.setFirstName("Thymeleaf"); 120 | name.setLastName("MyBatis"); 121 | mapper.insert(name); 122 | 123 | mapper.delete(name); 124 | 125 | Name loadedName = mapper.findById(name.getId()); 126 | Assertions.assertNull(loadedName); 127 | } 128 | } 129 | 130 | } 131 | -------------------------------------------------------------------------------- /src/test/java/org/mybatis/scripting/thymeleaf/integrationtest/TemplateFilePathProviderMapperTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.scripting.thymeleaf.integrationtest; 17 | 18 | import java.io.Reader; 19 | import java.sql.Connection; 20 | 21 | import org.apache.ibatis.io.Resources; 22 | import org.apache.ibatis.jdbc.ScriptRunner; 23 | import org.apache.ibatis.mapping.Environment; 24 | import org.apache.ibatis.session.Configuration; 25 | import org.apache.ibatis.session.SqlSession; 26 | import org.apache.ibatis.session.SqlSessionFactory; 27 | import org.apache.ibatis.session.SqlSessionFactoryBuilder; 28 | import org.apache.ibatis.transaction.TransactionFactory; 29 | import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory; 30 | import org.hsqldb.jdbc.JDBCDataSource; 31 | import org.junit.jupiter.api.AfterAll; 32 | import org.junit.jupiter.api.Assertions; 33 | import org.junit.jupiter.api.BeforeAll; 34 | import org.junit.jupiter.api.Test; 35 | import org.junit.jupiter.api.condition.DisabledIfSystemProperty; 36 | import org.mybatis.scripting.thymeleaf.ThymeleafLanguageDriver; 37 | import org.mybatis.scripting.thymeleaf.ThymeleafLanguageDriverConfig; 38 | import org.mybatis.scripting.thymeleaf.integrationtest.domain.Name; 39 | import org.mybatis.scripting.thymeleaf.integrationtest.mapper.TemplateFilePathProviderMapper; 40 | import org.mybatis.scripting.thymeleaf.support.TemplateFilePathProvider; 41 | 42 | @DisabledIfSystemProperty(named = "mybatis.version", matches = "3\\.4\\..*|3\\.5\\.0") 43 | class TemplateFilePathProviderMapperTest { 44 | private static SqlSessionFactory sqlSessionFactory; 45 | 46 | @BeforeAll 47 | @AfterAll 48 | static void cleanup() { 49 | TemplateFilePathProvider.clearCache(); 50 | } 51 | 52 | @BeforeAll 53 | static void setUp() throws Exception { 54 | Class.forName("org.hsqldb.jdbcDriver"); 55 | JDBCDataSource dataSource = new JDBCDataSource(); 56 | dataSource.setUrl("jdbc:hsqldb:mem:db1"); 57 | dataSource.setUser("sa"); 58 | dataSource.setPassword(""); 59 | 60 | try (Connection conn = dataSource.getConnection()) { 61 | try (Reader reader = Resources.getResourceAsReader("create-db.sql")) { 62 | ScriptRunner runner = new ScriptRunner(conn); 63 | runner.setLogWriter(null); 64 | runner.setErrorLogWriter(null); 65 | runner.runScript(reader); 66 | conn.commit(); 67 | } 68 | } 69 | 70 | TransactionFactory transactionFactory = new JdbcTransactionFactory(); 71 | Environment environment = new Environment("development", transactionFactory, dataSource); 72 | 73 | Configuration configuration = new Configuration(environment); 74 | configuration.setMapUnderscoreToCamelCase(true); 75 | configuration.getLanguageRegistry() 76 | .register(new ThymeleafLanguageDriver(ThymeleafLanguageDriverConfig.newInstance(c -> { 77 | c.getTemplateFile().getPathProvider().setPrefix("sql/"); 78 | c.getTemplateFile().getPathProvider().setIncludesPackagePath(false); 79 | }))); 80 | configuration.setDefaultScriptingLanguage(ThymeleafLanguageDriver.class); 81 | 82 | configuration.addMapper(TemplateFilePathProviderMapper.class); 83 | sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration); 84 | } 85 | 86 | @Test 87 | void testInsert() { 88 | try (SqlSession sqlSession = sqlSessionFactory.openSession()) { 89 | TemplateFilePathProviderMapper mapper = sqlSession.getMapper(TemplateFilePathProviderMapper.class); 90 | Name name = new Name(); 91 | name.setFirstName("Thymeleaf"); 92 | name.setLastName("MyBatis"); 93 | mapper.insert(name); 94 | 95 | Name loadedName = mapper.findById(name.getId()); 96 | Assertions.assertEquals(name.getFirstName(), loadedName.getFirstName()); 97 | Assertions.assertEquals(name.getLastName(), loadedName.getLastName()); 98 | } 99 | } 100 | 101 | @Test 102 | void testUpdate() { 103 | try (SqlSession sqlSession = sqlSessionFactory.openSession()) { 104 | TemplateFilePathProviderMapper mapper = sqlSession.getMapper(TemplateFilePathProviderMapper.class); 105 | Name name = new Name(); 106 | name.setFirstName("Thymeleaf"); 107 | name.setLastName("MyBatis"); 108 | mapper.insert(name); 109 | 110 | Name updatingName = new Name(); 111 | updatingName.setId(name.getId()); 112 | updatingName.setFirstName("Thymeleaf3"); 113 | mapper.update(updatingName); 114 | 115 | Name loadedName = mapper.findById(name.getId()); 116 | Assertions.assertEquals(updatingName.getFirstName(), loadedName.getFirstName()); 117 | Assertions.assertEquals(name.getLastName(), loadedName.getLastName()); 118 | } 119 | } 120 | 121 | @Test 122 | void testDelete() { 123 | try (SqlSession sqlSession = sqlSessionFactory.openSession()) { 124 | TemplateFilePathProviderMapper mapper = sqlSession.getMapper(TemplateFilePathProviderMapper.class); 125 | Name name = new Name(); 126 | name.setFirstName("Thymeleaf"); 127 | name.setLastName("MyBatis"); 128 | mapper.insert(name); 129 | 130 | mapper.delete(name); 131 | 132 | Name loadedName = mapper.findById(name.getId()); 133 | Assertions.assertNull(loadedName); 134 | } 135 | } 136 | 137 | } 138 | -------------------------------------------------------------------------------- /src/main/java/org/mybatis/scripting/thymeleaf/PropertyAccessor.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018-2022 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package org.mybatis.scripting.thymeleaf; 17 | 18 | import java.beans.BeanInfo; 19 | import java.beans.IntrospectionException; 20 | import java.beans.Introspector; 21 | import java.beans.PropertyDescriptor; 22 | import java.lang.reflect.InvocationTargetException; 23 | import java.util.Map; 24 | import java.util.Optional; 25 | import java.util.Set; 26 | import java.util.concurrent.ConcurrentHashMap; 27 | import java.util.stream.Collectors; 28 | import java.util.stream.Stream; 29 | 30 | /** 31 | * The interface for accessing a property.
32 | * If you want to customize a default {@code PropertyAccessor}, you implements class of this interface and you need to 33 | * specify to a {@link SqlGenerator}.
34 | * 35 | * @author Kazuki Shimizu 36 | * 37 | * @version 1.0.2 38 | */ 39 | public interface PropertyAccessor { 40 | 41 | /** 42 | * Get property names of specified type. 43 | * 44 | * @param type 45 | * a target type 46 | * 47 | * @return property names 48 | */ 49 | Set
195 | * This method use by internal processing. 196 | *
197 | */ 198 | static void clearCache() { 199 | cache.clear(); 200 | } 201 | 202 | private static Map36 | * This processor render bind variable(default: {@code #{…}}) expression that can parsed data access library and 37 | * register an iteration object to the bind variables. 38 | * 39 | * @author Kazuki Shimizu 40 | * 41 | * @version 1.0.0 42 | */ 43 | public class MyBatisParamTagProcessor extends AbstractAttributeTagProcessor { 44 | 45 | private static final int PRECEDENCE = 1400; 46 | private static final String ATTR_NAME = "p"; 47 | 48 | private final StandardExpressionExecutionContext expressionExecutionContext; 49 | 50 | private UnaryOperator
68 | * By default, render {@literal #{...}} format. 69 | * 70 | * @param bindVariableRender 71 | * a custom bind variable render function 72 | * 73 | * @since 1.0.2 74 | */ 75 | public void setBindVariableRender(UnaryOperator