Support global configuration for applying sql provider type when omit on annotation

Author: kazuki43zoo

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

@@ -100,7 +100,7 @@ public ProviderSqlSource(Configuration configuration, Annotation provider, Class
       this.mapperMethod = mapperMethod;
       Lang lang = mapperMethod == null ? null : mapperMethod.getAnnotation(Lang.class);
       this.languageDriver = configuration.getLanguageDriver(lang == null ? null : lang.value());
-      this.providerType = getProviderType(provider, mapperMethod);
+      this.providerType = getProviderType(configuration, provider, mapperMethod);
       candidateProviderMethodName = (String) provider.annotationType().getMethod("method").invoke(provider);
 
       if (candidateProviderMethodName.length() == 0 && ProviderMethodResolver.class.isAssignableFrom(this.providerType)) {
@@ -235,11 +235,14 @@ private String invokeProviderMethod(Object... args) throws Exception {
     return sql != null ? sql.toString() : null;
   }
 
-  private Class<?> getProviderType(Annotation providerAnnotation, Method mapperMethod)
+  private Class<?> getProviderType(Configuration configuration, Annotation providerAnnotation, Method mapperMethod)
       throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
     Class<?> type = (Class<?>) providerAnnotation.annotationType().getMethod("type").invoke(providerAnnotation);
     Class<?> value = (Class<?>) providerAnnotation.annotationType().getMethod("value").invoke(providerAnnotation);
     if (value == void.class && type == void.class) {
+      if (configuration.getDefaultSqlProviderType() != null) {
+        return configuration.getDefaultSqlProviderType();
+      }
       throw new BuilderException("Please specify either 'value' or 'type' attribute of @"
           + providerAnnotation.annotationType().getSimpleName()
           + " at the '" + mapperMethod.toString() + "'.");

src/main/java/org/apache/ibatis/builder/xml/XMLConfigBuilder.java

@@ -269,6 +269,7 @@ private void settingsElement(Properties props) {
     configuration.setLogPrefix(props.getProperty("logPrefix"));
     configuration.setConfigurationFactory(resolveClass(props.getProperty("configurationFactory")));
     configuration.setShrinkWhitespacesInSql(booleanValueOf(props.getProperty("shrinkWhitespacesInSql"), false));
+    configuration.setDefaultSqlProviderType(resolveClass(props.getProperty("defaultSqlProviderType")));
   }
 
   private void environmentsElement(XNode context) throws Exception {

src/main/java/org/apache/ibatis/session/Configuration.java

@@ -118,6 +118,7 @@ public class Configuration {
   protected String logPrefix;
   protected Class<? extends Log> logImpl;
   protected Class<? extends VFS> vfsImpl;
+  protected Class<?> defaultSqlProviderType;
   protected LocalCacheScope localCacheScope = LocalCacheScope.SESSION;
   protected JdbcType jdbcTypeForNull = JdbcType.OTHER;
   protected Set<String> lazyLoadTriggerMethods = new HashSet<>(Arrays.asList("equals", "clone", "hashCode", "toString"));
@@ -243,6 +244,27 @@ public void setVfsImpl(Class<? extends VFS> vfsImpl) {
     }
   }
 
+  /**
+   * GEt an applying type when omit a type on sql provider annotation(e.g. {@link org.apache.ibatis.annotations.SelectProvider}).
+   *
+   * @return the default type for sql provider annotation
+   * @since 3.5.6
+   */
+  public Class<?> getDefaultSqlProviderType() {
+    return defaultSqlProviderType;
+  }
+
+  /**
+   * Sets an applying type when omit a type on sql provider annotation(e.g. {@link org.apache.ibatis.annotations.SelectProvider}).
+   *
+   * @param defaultSqlProviderType
+   *          the default type for sql provider annotation
+   * @since 3.5.6
+   */
+  public void setDefaultSqlProviderType(Class<?> defaultSqlProviderType) {
+    this.defaultSqlProviderType = defaultSqlProviderType;
+  }
+
   public boolean isCallSettersOnNulls() {
     return callSettersOnNulls;
   }

src/test/java/org/apache/ibatis/builder/CustomizedSettingsMapperConfig.xml

@@ -55,6 +55,7 @@
     <setting name="configurationFactory" value="java.lang.String"/>
     <setting name="defaultEnumTypeHandler" value="org.apache.ibatis.type.EnumOrdinalTypeHandler"/>
     <setting name="shrinkWhitespacesInSql" value="true"/>
+    <setting name="defaultSqlProviderType" value="org.apache.ibatis.builder.XmlConfigBuilderTest$MySqlProvider"/>
   </settings>
 
   <typeAliases>

src/test/java/org/apache/ibatis/builder/XmlConfigBuilderTest.java

@@ -101,6 +101,7 @@ void shouldSuccessfullyLoadMinimalXMLConfigFile() throws Exception {
       assertNull(config.getConfigurationFactory());
       assertThat(config.getTypeHandlerRegistry().getTypeHandler(RoundingMode.class)).isInstanceOf(EnumTypeHandler.class);
       assertThat(config.isShrinkWhitespacesInSql()).isFalse();
+      assertThat(config.getDefaultSqlProviderType()).isNull();
     }
   }
 
@@ -196,6 +197,7 @@ void shouldSuccessfullyLoadXMLConfigFile() throws Exception {
       assertThat(config.getVfsImpl().getName()).isEqualTo(JBoss6VFS.class.getName());
       assertThat(config.getConfigurationFactory().getName()).isEqualTo(String.class.getName());
       assertThat(config.isShrinkWhitespacesInSql()).isTrue();
+      assertThat(config.getDefaultSqlProviderType().getName()).isEqualTo(MySqlProvider.class.getName());
 
       assertThat(config.getTypeAliasRegistry().getTypeAliases().get("blogauthor")).isEqualTo(Author.class);
       assertThat(config.getTypeAliasRegistry().getTypeAliases().get("blog")).isEqualTo(Blog.class);
@@ -304,4 +306,11 @@ void propertiesSpecifyResourceAndUrlAtSameTime() {
       .hasMessageContaining("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
   }
 
+  static class MySqlProvider {
+    @SuppressWarnings("unused")
+    public static String provideSql() {
+      return "SELECT 1";
+    }
+  }
+
 }

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

@@ -30,9 +30,11 @@
 import java.util.Map;
 
 import org.apache.ibatis.BaseDataTest;
+import org.apache.ibatis.annotations.InsertProvider;
 import org.apache.ibatis.annotations.DeleteProvider;
 import org.apache.ibatis.annotations.Param;
 import org.apache.ibatis.annotations.SelectProvider;
+import org.apache.ibatis.annotations.UpdateProvider;
 import org.apache.ibatis.binding.MapperMethod;
 import org.apache.ibatis.builder.BuilderException;
 import org.apache.ibatis.builder.annotation.ProviderContext;
@@ -661,6 +663,70 @@ void keepBackwardCompatibilityOnDeprecatedConstructorWithAnnotation() throws NoS
     assertEquals("SELECT 1 FROM INFORMATION_SCHEMA.SYSTEM_USERS", sqlSource.getBoundSql(null).getSql());
   }
 
+  @Test
+  void omitTypeWhenSpecifyDefaultType() throws NoSuchMethodException {
+    Class<?> mapperType = DefaultSqlProviderMapper.class;
+    Configuration configuration = new Configuration();
+    configuration.setDefaultSqlProviderType(DefaultSqlProviderMapper.SqlProvider.class);
+    {
+      Method mapperMethod = mapperType.getMethod("select", int.class);
+      String sql = new ProviderSqlSource(configuration, mapperMethod.getAnnotation(SelectProvider.class), mapperType,
+        mapperMethod).getBoundSql(1).getSql();
+      assertEquals("select name from foo where id = ?", sql);
+    }
+    {
+      Method mapperMethod = mapperType.getMethod("insert", String.class);
+      String sql = new ProviderSqlSource(configuration, mapperMethod.getAnnotation(InsertProvider.class), mapperType,
+        mapperMethod).getBoundSql("Taro").getSql();
+      assertEquals("insert into foo (name) values(?)", sql);
+    }
+    {
+      Method mapperMethod = mapperType.getMethod("update", int.class, String.class);
+      String sql = new ProviderSqlSource(configuration, mapperMethod.getAnnotation(UpdateProvider.class), mapperType,
+        mapperMethod).getBoundSql(Collections.emptyMap() ).getSql();
+      assertEquals("update foo set name = ? where id = ?", sql);
+    }
+    {
+      Method mapperMethod = mapperType.getMethod("delete", int.class);
+      String sql = new ProviderSqlSource(configuration, mapperMethod.getAnnotation(DeleteProvider.class), mapperType,
+        mapperMethod).getBoundSql(Collections.emptyMap() ).getSql();
+      assertEquals("delete from foo where id = ?", sql);
+    }
+  }
+
+  public interface DefaultSqlProviderMapper {
+
+    @SelectProvider
+    String select(int id);
+
+    @InsertProvider
+    void insert(String name);
+
+    @UpdateProvider
+    void update(int id, String name);
+
+    @DeleteProvider
+    void delete(int id);
+
+    class SqlProvider {
+
+      public static String provideSql(ProviderContext c) {
+        switch (c.getMapperMethod().getName()) {
+          case "select" :
+            return "select name from foo where id = #{id}";
+          case "insert" :
+            return "insert into foo (name) values(#{name})";
+          case "update" :
+            return "update foo set name = #{name} where id = #{id}";
+          default:
+            return "delete from foo where id = #{id}";
+        }
+      }
+
+    }
+
+  }
+
   public interface ErrorMapper {
     @SelectProvider(type = ErrorSqlBuilder.class, method = "methodNotFound")
     void methodNotFound();