Allow any variable name on ognl expression when specify single value object as parameter object

Author: kazuki43zoo

src/main/asciidoc/user-guide.adoc

@@ -27,8 +27,8 @@
 
 === What is MyBatis Thymeleaf ?
 
-The mybatis-thymeleaf is a plugin that helps applying a 2-way SQL feature to the MyBatis 3
-using the natural template mechanism provided by Thymeleaf 3.
+The mybatis-thymeleaf is a plugin that helps applying the dynamic sql and 2-way SQL feature to the MyBatis 3
+using the template(or natural template) mechanism provided by Thymeleaf 3.
 If you are not familiar with MyBatis and Thymeleaf, you can see following official documentations.
 
 * {mybatis-doc-url}[MyBatis 3 REFERENCE DOCUMENTATION^]
@@ -54,12 +54,19 @@ SELECT * FROM names
 ----
 
 [source,sql]
-.Translated SQL for processing in MyBatis
+.Translated to SQL that can parse in MyBatis by Thymeleaf processing
 ----
 SELECT * FROM names
   WHERE id = #{id}
 ----
 
+[source,sql]
+.Translated to SQL that can parse by JDBC driver in MyBatis processing
+----
+SELECT * FROM names
+  WHERE id = ?
+----
+
 ==== Dynamically bindable 2-way SQL
 
 The mybatis-thymeleaf translate a dynamically bindable 2-way SQL that specified by natural template to as follow:
@@ -81,15 +88,15 @@ SELECT * FROM names
 ----
 
 [source,sql]
-.Translated SQL for processing in MyBatis (when `ids` is empty)
+.Translated to SQL in Thymeleaf processing (when `ids` is empty)
 ----
 SELECT * FROM names
   WHERE 1 = 1
   ORDER BY id
 ----
 
 [source,sql]
-.Translated SQL for processing in MyBatis (when `ids` has 3 elements)
+.Translated to SQL in Thymeleaf processing (when `ids` has 3 elements)
 ----
 SELECT * FROM names
   WHERE 1 = 1
@@ -109,9 +116,9 @@ The mybatis-thymeleaf provide following features using class that implements
 the link:{mybatis-doc-url}/dynamic-sql.html#Pluggable_Scripting_Languages_For_Dynamic_SQL[`LanguageDriver` interface^]
 for integrating with template engine provide by Thymeleaf.
 
-* Can write a 2-way SQL
-* Can use a 2-way SQL via an annotation and mapper xml
-* Can read a 2-way SQL from a template file on classpath
+* Can write a dynamic sql and 2-way SQL
+* Can use a dynamic sql and 2-way SQL via an annotation and mapper xml
+* Can read an SQL template from a template file on classpath
 * Can use a custom dialect(attribute tag and expression utility method) at a template
 * Can fully customize a template engine configuration
 
@@ -138,7 +145,7 @@ About tested versions see the latest link:{travis-ci-url}[Travi CI^] build resul
 As basically policy, we do test using following versions.
 
 * latest release version on 3.4.x line
-* latest release version on 3.5.x line (not released yet)
+* latest release version on 3.5.x line
 * latest snapshot version on 3.5.x line
 ====
 
@@ -260,7 +267,7 @@ public class NameMapper {
 [TIP]
 ====
 
-Since JDK 12, you can specify a 2-way SQL using "Raw String Literals" feature as follow:
+You can specify a 2-way SQL in annotation using "link:https://openjdk.java.net/jeps/326[Raw String Literals^]" feature that support by future JDK version as follow:
 
 [source,java]
 ----
@@ -474,7 +481,7 @@ that can be parsed by MyBatis core module as follow:
 .2-way SQL template for generating string that can be parsed by MyBatis core module
 ----
 SELECT * FROM names
-  WHERE id = /*[('#{id}')]*/ -- <1>
+  WHERE id = /*[('#{id}')]*/ 1 -- <1>
 ----
 
 <1> A bind value specify by `/\*[('#{variable name}')]*/` format
@@ -722,6 +729,17 @@ Therefore, we *don't recommend* using this variable within the your application.
 ====
 
 |`Map<String, Object>`
+
+|`_fallbackParameterObject`
+a|Whether can access by any variable name for value object that specified as parameter object.
+
+[CAUTION]
+====
+This variable used by internal processing on the mybatis-thymeleaf.
+Therefore, we *don't recommend* using this variable within the your application.
+====
+
+|`boolean`
 |===
 
 === Using configuration properties
@@ -1179,6 +1197,7 @@ ConfigurationCustomizer mybatisConfigurationCustomizer() {
   return configuration -> {
     TemplateEngine templateEngine = new TemplateEngine(); // <1>
     templateEngine.addDialect(new MyBatisDialect());
+    templateEngine.setEngineContextFactory(new MyBatisDelegatingEngineContextFactory(targetTemplateEngine.getEngineContextFactory()));
     // ...
     configuration.getLanguageRegistry().register(new ThymeleafLanguageDriver(templateEngine)); // <2>
     configuration.setDefaultScriptingLanguage(ThymeleafLanguageDriver.class); // <3>

src/main/java/org/mybatis/scripting/thymeleaf/ContextVariableNames.java

@@ -34,4 +34,9 @@ private ContextVariableNames() {
    */
   public static final String CUSTOM_BIND_VARS = "_customBindVariables";
 
+  /**
+   * Variable name for holding whether use fallback parameter object when parameter is value object.
+   */
+  public static final String FALLBACK_PARAMETER_OBJECT = "_fallbackParameterObject";
+
 }

src/main/java/org/mybatis/scripting/thymeleaf/MyBatisDelegatingEngineContextFactory.java

@@ -0,0 +1,65 @@
+/**
+ *    Copyright 2018-2019 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.scripting.thymeleaf;
+
+import org.apache.ibatis.scripting.xmltags.DynamicContext;
+import org.thymeleaf.IEngineConfiguration;
+import org.thymeleaf.context.IContext;
+import org.thymeleaf.context.IEngineContext;
+import org.thymeleaf.context.IEngineContextFactory;
+import org.thymeleaf.engine.TemplateData;
+
+import java.lang.reflect.Proxy;
+import java.util.Map;
+
+/**
+ *
+ * @author Kazuki Shimizu
+ * @version 1.0.0
+ */
+public class MyBatisDelegatingEngineContextFactory implements IEngineContextFactory {
+  private final IEngineContextFactory delegate;
+  private ClassLoader classLoader = MyBatisDelegatingEngineContextFactory.class.getClassLoader();
+
+  public MyBatisDelegatingEngineContextFactory(IEngineContextFactory delegate) {
+    this.delegate = delegate;
+  }
+
+  public void setClassLoader(ClassLoader classLoader) {
+    this.classLoader = classLoader;
+  }
+
+  @Override
+  public IEngineContext createEngineContext(IEngineConfiguration configuration, TemplateData templateData, Map<String, Object> templateResolutionAttributes, IContext context) {
+    IEngineContext engineContext = delegate.createEngineContext(configuration, templateData, templateResolutionAttributes, context);
+    return (IEngineContext) Proxy.newProxyInstance(classLoader, new Class[]{IEngineContext.class}, (proxy, method, args) -> {
+      if (method.getName().equals("getVariable")) {
+        String name = (String) args[0];
+        Object value;
+        if (engineContext.containsVariable(ContextVariableNames.FALLBACK_PARAMETER_OBJECT) &&
+            (boolean) engineContext.getVariable(ContextVariableNames.FALLBACK_PARAMETER_OBJECT)) {
+          value = engineContext.containsVariable(name) ?
+              engineContext.getVariable(name) : engineContext.getVariable(DynamicContext.PARAMETER_OBJECT_KEY);
+        } else {
+          value = engineContext.getVariable(name);
+        }
+        return value;
+      }
+      return method.invoke(engineContext, args);
+    });
+  }
+
+}

src/main/java/org/mybatis/scripting/thymeleaf/ThymeleafLanguageDriver.java

@@ -185,6 +185,7 @@ private ITemplateEngine createDefaultTemplateEngine() {
     targetTemplateEngine.addTemplateResolver(classLoaderTemplateResolver);
     targetTemplateEngine.addTemplateResolver(stringTemplateResolver);
     targetTemplateEngine.addDialect(dialect);
+    targetTemplateEngine.setEngineContextFactory(new MyBatisDelegatingEngineContextFactory(targetTemplateEngine.getEngineContextFactory()));
 
     customizer.accept(targetTemplateEngine);
     return targetTemplateEngine;

src/main/java/org/mybatis/scripting/thymeleaf/ThymeleafSqlSource.java

@@ -72,6 +72,8 @@ class ThymeleafSqlSource implements SqlSource {
   public BoundSql getBoundSql(Object parameterObject) {
     Class<?> parameterType = parameterObject == null ? Object.class : parameterObject.getClass();
     DynamicContext dynamicContext = new DynamicContext(configuration, parameterObject);
+    dynamicContext.bind(ContextVariableNames.FALLBACK_PARAMETER_OBJECT,
+        parameterObject != null && configuration.getTypeHandlerRegistry().hasTypeHandler(parameterObject.getClass()));
 
     CustomBindVariablesContext context;
     if (parameterObject instanceof Map) {
@@ -113,7 +115,7 @@ private AbstractCustomBindVariablesContext(DynamicContext dynamicContext, Proper
       this.variableNames = new HashSet<>();
       addVariableNames(dynamicContext.getBindings().keySet());
       Optional.ofNullable(configurationProperties).ifPresent(v -> addVariableNames(v.stringPropertyNames()));
-      addVariableNames(Collections.singleton(ContextVariableNames.CUSTOM_BIND_VARS));
+      addVariableNames(Collections.singletonList(ContextVariableNames.CUSTOM_BIND_VARS));
     }
 
     void addVariableNames(Collection<String> names) {

src/test/resources/org/mybatis/scripting/thymeleaf/integrationtest/mapper/XmlNameSqlSessionMapper.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-       Copyright 2018 the original author or authors.
+       Copyright 2018-2019 the original author or authors.
 
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@
     </insert>
 
     <update id="update">
+      <![CDATA[
         UPDATE names
           SET id = id
           /*[# th:if="${firstName} != null"]*/
@@ -36,6 +37,7 @@
             ,lastName = /*[('#{lastName}')]*/ 'Yamada'
           /*[/]*/
           WHERE id = /*[('#{id}')]*/ 1
+       ]]>
     </update>
 
     <update id="updateWithEmptyComment">

src/test/resources/sql/NameMapper/findByIdWithoutParamAnnotation.sql

@@ -1,5 +1,5 @@
 --
---    Copyright 2018 the original author or authors.
+--    Copyright 2018-2019 the original author or authors.
 --
 --    Licensed under the Apache License, Version 2.0 (the "License");
 --    you may not use this file except in compliance with the License.
@@ -16,6 +16,6 @@
 
 SELECT * FROM names
   WHERE 1 = 1
-    /*[# th:if="${value} != null"]*/
-    AND id = /*[('#{value}')]*/ 1
+    /*[# th:if="${id} != null"]*/
+    AND id = /*[('#{id}')]*/ 1
     /*[/]*/