Support ProviderContext on sql provider method

A ProviderContext instance holds type of mapper interface and mapper method that specified an sql provider annotation.

Fixes gh-1013

Author: kazuki43zoo

src/main/java/org/apache/ibatis/builder/annotation/MapperAnnotationBuilder.java

@@ -465,7 +465,7 @@ private SqlSource getSqlSourceFromAnnotations(Method method, Class<?> parameterT
         return buildSqlSourceFromStrings(strings, parameterType, languageDriver);
       } else if (sqlProviderAnnotationType != null) {
         Annotation sqlProviderAnnotation = method.getAnnotation(sqlProviderAnnotationType);
-        return new ProviderSqlSource(assistant.getConfiguration(), sqlProviderAnnotation);
+        return new ProviderSqlSource(assistant.getConfiguration(), sqlProviderAnnotation, type, method);
       }
       return null;
     } catch (Exception e) {

src/main/java/org/apache/ibatis/builder/annotation/ProviderContext.java

@@ -0,0 +1,60 @@
+/**
+ *    Copyright 2009-2017 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.apache.ibatis.builder.annotation;
+
+import java.lang.reflect.Method;
+
+/**
+ * The context object for sql provider method.
+ *
+ * @author Kazuki Shimizu
+ * @since 3.4.5
+ */
+public final class ProviderContext {
+
+  private final Class<?> mapperType;
+  private final Method mapperMethod;
+
+  /**
+   * Constructor.
+   *
+   * @param mapperType A mapper interface type that specified provider
+   * @param mapperMethod A mapper method that specified provider
+   */
+  ProviderContext(Class<?> mapperType, Method mapperMethod) {
+    this.mapperType = mapperType;
+    this.mapperMethod = mapperMethod;
+  }
+
+  /**
+   * Get a mapper interface type that specified provider.
+   *
+   * @return A mapper interface type that specified provider
+   */
+  public Class<?> getMapperType() {
+    return mapperType;
+  }
+
+  /**
+   * Get a mapper method that specified provider.
+   *
+   * @return A mapper method that specified provider
+   */
+  public Method getMapperMethod() {
+    return mapperMethod;
+  }
+
+}

src/main/java/org/apache/ibatis/builder/annotation/ProviderSqlSource.java

@@ -36,8 +36,22 @@ public class ProviderSqlSource implements SqlSource {
   private final Class<?> providerType;
   private Method providerMethod;
   private String[] providerMethodArgumentNames;
+  private Class<?>[] providerMethodParameterTypes;
+  private ProviderContext providerContext;
+  private Integer providerContextIndex;
 
+  /**
+   * @deprecated Please use the {@link #ProviderSqlSource(Configuration, Object, Class, Method)} instead of this.
+   */
+  @Deprecated
   public ProviderSqlSource(Configuration config, Object provider) {
+    this(config, provider, null, null);
+  }
+
+  /**
+   * @since 3.4.5
+   */
+  public ProviderSqlSource(Configuration config, Object provider, Class<?> mapperType, Method mapperMethod) {
     String providerMethodName;
     try {
       this.sqlSourceParser = new SqlSourceBuilder(config);
@@ -54,6 +68,7 @@ public ProviderSqlSource(Configuration config, Object provider) {
             }
             this.providerMethod = m;
             this.providerMethodArgumentNames = new ParamNameResolver(config, m).getNames();
+            this.providerMethodParameterTypes = m.getParameterTypes();
           }
         }
       }
@@ -66,6 +81,18 @@ public ProviderSqlSource(Configuration config, Object provider) {
       throw new BuilderException("Error creating SqlSource for SqlProvider. Method '"
           + providerMethodName + "' not found in SqlProvider '" + this.providerType.getName() + "'.");
     }
+    for (int i = 0; i< this.providerMethodParameterTypes.length; i++) {
+      Class<?> parameterType = this.providerMethodParameterTypes[i];
+      if (parameterType == ProviderContext.class) {
+        if (this.providerContext != null){
+          throw new BuilderException("Error creating SqlSource for SqlProvider. ProviderContext found multiple in SqlProvider method ("
+              + this.providerType.getName() + "." + providerMethod.getName()
+              + "). ProviderContext can not define multiple in SqlProvider method argument.");
+        }
+        this.providerContext = new ProviderContext(mapperType, mapperMethod);
+        this.providerContextIndex = i;
+      }
+    }
   }
 
   @Override
@@ -77,12 +104,15 @@ public BoundSql getBoundSql(Object parameterObject) {
   private SqlSource createSqlSource(Object parameterObject) {
     try {
       Class<?>[] parameterTypes = providerMethod.getParameterTypes();
+      int bindParameterCount = parameterTypes.length - (providerContext == null ? 0 : 1);
       String sql;
       if (parameterTypes.length == 0) {
         sql = (String) providerMethod.invoke(providerType.newInstance());
-      } else if (parameterTypes.length == 1 &&
-              (parameterObject == null || parameterTypes[0].isAssignableFrom(parameterObject.getClass()))) {
-        sql = (String) providerMethod.invoke(providerType.newInstance(), parameterObject);
+      } else if (bindParameterCount == 0) {
+        sql = (String) providerMethod.invoke(providerType.newInstance(), providerContext);
+      } else if (bindParameterCount == 1 &&
+              (parameterObject == null || parameterTypes[(providerContextIndex == null || providerContextIndex == 1) ? 0 : 1].isAssignableFrom(parameterObject.getClass()))) {
+        sql = (String) providerMethod.invoke(providerType.newInstance(), extractProviderMethodArguments(parameterObject));
       } else if (parameterObject instanceof Map) {
         @SuppressWarnings("unchecked")
         Map<String, Object> params = (Map<String, Object>) parameterObject;
@@ -91,7 +121,7 @@ private SqlSource createSqlSource(Object parameterObject) {
         throw new BuilderException("Error invoking SqlProvider method ("
                 + providerType.getName() + "." + providerMethod.getName()
                 + "). Cannot invoke a method that holds "
-                + (parameterTypes.length == 1 ? "named argument(@Param)": "multiple arguments")
+                + (bindParameterCount == 1 ? "named argument(@Param)": "multiple arguments")
                 + " using a specifying parameterObject. In this case, please specify a 'java.util.Map' object.");
       }
       Class<?> parameterType = parameterObject == null ? Object.class : parameterObject.getClass();
@@ -105,10 +135,25 @@ private SqlSource createSqlSource(Object parameterObject) {
     }
   }
 
+  private Object[] extractProviderMethodArguments(Object parameterObject) {
+    if (providerContext != null) {
+      Object[] args = new Object[2];
+      args[providerContextIndex == 0 ? 1 : 0] = parameterObject;
+      args[providerContextIndex] = providerContext;
+      return args;
+    } else {
+      return new Object[] { parameterObject };
+    }
+  }
+
   private Object[] extractProviderMethodArguments(Map<String, Object> params, String[] argumentNames) {
     Object[] args = new Object[argumentNames.length];
     for (int i = 0; i < args.length; i++) {
-      args[i] = params.get(argumentNames[i]);
+      if (providerContextIndex != null && providerContextIndex == i) {
+        args[i] = providerContext;
+      } else {
+        args[i] = params.get(argumentNames[i]);
+      }
     }
     return args;
   }

src/test/java/org/apache/ibatis/submitted/sqlprovider/BaseMapper.java

@@ -0,0 +1,69 @@
+/**
+ *    Copyright 2009-2017 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.apache.ibatis.submitted.sqlprovider;
+
+import org.apache.ibatis.annotations.Param;
+import org.apache.ibatis.annotations.SelectProvider;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.List;
+
+public interface BaseMapper<T> {
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByIdProviderContextOnly")
+  @ContainsLogicalDelete
+  T selectById(Integer id);
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByIdProviderContextOnly")
+  T selectActiveById(Integer id);
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByNameOneParamAndProviderContext")
+  @ContainsLogicalDelete
+  List<T> selectByName(String name);
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByNameOneParamAndProviderContext")
+  List<T> selectActiveByName(String name);
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByIdAndNameMultipleParamAndProviderContextWithAtParam")
+  @ContainsLogicalDelete
+  List<T> selectByIdAndNameWithAtParam(@Param("id") Integer id, @Param("name") String name);
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByIdAndNameMultipleParamAndProviderContextWithAtParam")
+  List<T> selectActiveByIdAndNameWithAtParam(@Param("id") Integer id, @Param("name") String name);
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByIdAndNameMultipleParamAndProviderContext")
+  @ContainsLogicalDelete
+  List<T> selectByIdAndName(Integer id, String name);
+
+  @SelectProvider(type= OurSqlBuilder.class, method= "buildSelectByIdAndNameMultipleParamAndProviderContext")
+  List<T> selectActiveByIdAndName(Integer id, String name);
+
+  @Retention(RetentionPolicy.RUNTIME)
+  @Target(ElementType.METHOD)
+  @interface ContainsLogicalDelete {
+    boolean value() default false;
+  }
+
+  @Retention(RetentionPolicy.RUNTIME)
+  @Target(ElementType.TYPE)
+  @interface Meta {
+    String tableName();
+  }
+
+}

src/test/java/org/apache/ibatis/submitted/sqlprovider/CreateDB.sql

@@ -1,5 +1,5 @@
 --
---    Copyright 2009-2016 the original author or authors.
+--    Copyright 2009-2017 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.
@@ -18,11 +18,12 @@ drop table users if exists;
 
 create table users (
   id int,
-  name varchar(20)
+  name varchar(20),
+  logical_delete boolean default false
 );
 
 insert into users (id, name) values(1, 'User1');
 insert into users (id, name) values(2, 'User2');
 insert into users (id, name) values(3, 'User3');
-insert into users (id, name) values(4, 'User4');
+insert into users (id, name, logical_delete) values(4, 'User4', true);
 

src/test/java/org/apache/ibatis/submitted/sqlprovider/Mapper.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2016 the original author or authors.
+ *    Copyright 2009-2017 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.
@@ -24,7 +24,8 @@
 import org.apache.ibatis.annotations.SelectProvider;
 import org.apache.ibatis.annotations.UpdateProvider;
 
-public interface Mapper {
+@BaseMapper.Meta(tableName = "users")
+public interface Mapper extends BaseMapper<User> {
   @SelectProvider(type = OurSqlBuilder.class, method = "buildGetUsersQuery")
   List<User> getUsers(List<Integer> allFilterIds);
 

src/test/java/org/apache/ibatis/submitted/sqlprovider/OurSqlBuilder.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2016 the original author or authors.
+ *    Copyright 2009-2017 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,7 @@
 package org.apache.ibatis.submitted.sqlprovider;
 
 import org.apache.ibatis.annotations.Param;
+import org.apache.ibatis.builder.annotation.ProviderContext;
 import org.apache.ibatis.jdbc.SQL;
 
 import java.util.List;
@@ -148,4 +149,68 @@ public String buildDelete() {
     return "delete from users where id = #{id}";
   }
 
+  public String buildSelectByIdProviderContextOnly(ProviderContext context) {
+    final boolean containsLogicalDelete = context.getMapperMethod().getAnnotation(BaseMapper.ContainsLogicalDelete.class) != null;
+    final String tableName = context.getMapperType().getAnnotation(BaseMapper.Meta.class).tableName();
+    return new SQL(){{
+      SELECT("*");
+      FROM(tableName);
+      WHERE("id = #{id}");
+      if (!containsLogicalDelete){
+        WHERE("logical_delete = false");
+      }
+    }}.toString();
+  }
+
+  public String buildSelectByNameOneParamAndProviderContext(ProviderContext context, final String name) {
+    final boolean containsLogicalDelete = context.getMapperMethod().getAnnotation(BaseMapper.ContainsLogicalDelete.class) != null;
+    final String tableName = context.getMapperType().getAnnotation(BaseMapper.Meta.class).tableName();
+    return new SQL(){{
+      SELECT("*");
+      FROM(tableName);
+      if (name != null) {
+        WHERE("name like #{name} || '%'");
+      }
+      if (!containsLogicalDelete){
+        WHERE("logical_delete = false");
+      }
+    }}.toString();
+  }
+
+  public String buildSelectByIdAndNameMultipleParamAndProviderContextWithAtParam(@Param("id") final Integer id, ProviderContext context, @Param("name") final String name) {
+    final boolean containsLogicalDelete = context.getMapperMethod().getAnnotation(BaseMapper.ContainsLogicalDelete.class) != null;
+    final String tableName = context.getMapperType().getAnnotation(BaseMapper.Meta.class).tableName();
+    return new SQL(){{
+      SELECT("*");
+      FROM(tableName);
+      if (id != null) {
+        WHERE("id = #{id}");
+      }
+      if (name != null) {
+        WHERE("name like #{name} || '%'");
+      }
+      if (!containsLogicalDelete){
+        WHERE("logical_delete = false");
+      }
+    }}.toString();
+  }
+
+  public String buildSelectByIdAndNameMultipleParamAndProviderContext(final Integer id, final String name, ProviderContext context) {
+    final boolean containsLogicalDelete = context.getMapperMethod().getAnnotation(BaseMapper.ContainsLogicalDelete.class) != null;
+    final String tableName = context.getMapperType().getAnnotation(BaseMapper.Meta.class).tableName();
+    return new SQL(){{
+      SELECT("*");
+      FROM(tableName);
+      if (id != null) {
+        WHERE("id = #{param1}");
+      }
+      if (name != null) {
+        WHERE("name like #{param2} || '%'");
+      }
+      if (!containsLogicalDelete){
+        WHERE("logical_delete = false");
+      }
+    }}.toString();
+  }
+
 }