Support enable/disable lazy Initialization on mapper scanning feature

mybatis-spring-boot-autoconfigure/src/main/java/org/mybatis/spring/boot/autoconfigure/MybatisAutoConfiguration.java

@@ -16,6 +16,7 @@
 package org.mybatis.spring.boot.autoconfigure;
 
 import java.util.List;
+import java.util.stream.Stream;
 
 import javax.sql.DataSource;
 
@@ -28,15 +29,18 @@
 import org.apache.ibatis.type.TypeHandler;
 import org.mybatis.spring.SqlSessionFactoryBean;
 import org.mybatis.spring.SqlSessionTemplate;
-import org.mybatis.spring.mapper.ClassPathMapperScanner;
 import org.mybatis.spring.mapper.MapperFactoryBean;
+import org.mybatis.spring.mapper.MapperScannerConfigurer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import org.springframework.beans.BeanWrapper;
+import org.springframework.beans.BeanWrapperImpl;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.BeanFactoryAware;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
@@ -46,7 +50,6 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.context.ResourceLoaderAware;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
@@ -190,12 +193,10 @@ public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory
    * repositories.
    */
   public static class AutoConfiguredMapperScannerRegistrar
-      implements BeanFactoryAware, ImportBeanDefinitionRegistrar, ResourceLoaderAware {
+      implements BeanFactoryAware, ImportBeanDefinitionRegistrar {
 
     private BeanFactory beanFactory;
 
-    private ResourceLoader resourceLoader;
-
     @Override
     public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
 
@@ -211,25 +212,23 @@ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, B
         packages.forEach(pkg -> logger.debug("Using auto-configuration base package '{}'", pkg));
       }
 
-      ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
-      if (this.resourceLoader != null) {
-        scanner.setResourceLoader(this.resourceLoader);
-      }
-      scanner.setAnnotationClass(Mapper.class);
-      scanner.registerFilters();
-      scanner.doScan(StringUtils.toStringArray(packages));
-
+      BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
+      builder.addPropertyValue("processPropertyPlaceHolders", true);
+      builder.addPropertyValue("annotationClass", Mapper.class);
+      builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));
+      BeanWrapper beanWrapper =  new BeanWrapperImpl(MapperScannerConfigurer.class);
+      Stream.of(beanWrapper.getPropertyDescriptors())
+          // Need to mybatis-spring 2.0.2+
+          .filter(x -> x.getName().equals("lazyInitialization")).findAny()
+          .ifPresent(x -> builder.addPropertyValue("lazyInitialization", "${mybatis.lazy-initialization:false}"));
+      registry.registerBeanDefinition(MapperScannerConfigurer.class.getName(), builder.getBeanDefinition());
     }
 
     @Override
     public void setBeanFactory(BeanFactory beanFactory) {
       this.beanFactory = beanFactory;
     }
 
-    @Override
-    public void setResourceLoader(ResourceLoader resourceLoader) {
-      this.resourceLoader = resourceLoader;
-    }
   }
 
   /**

mybatis-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -13,6 +13,12 @@
       "name": "mybatis.configuration.default-enum-type-handler",
       "description": "A default TypeHandler class for Enum.",
       "type": "java.lang.Class<? extends org.apache.ibatis.type.TypeHandler>"
+    },
+    {
+      "defaultValue": false,
+      "name": "mybatis.lazy-initialization",
+      "description": "Set whether enable lazy initialization for mapper bean.",
+      "type": "java.lang.Boolean"
     }
   ]
 }

mybatis-spring-boot-autoconfigure/src/site/xdoc/index.xml.vm

@@ -297,6 +297,15 @@ public class CityDao {
           For detail see the <a href="http://www.mybatis.org/mybatis-3/configuration.html#properties">MyBatis reference page</a>
         </td>
       </tr>
+      <tr>
+        <td>
+          <code>lazy-initialization</code>
+        </td>
+        <td>
+          Whether enable lazy initialization of mapper bean. Set <code>true</code> to enable lazy initialization.
+          This feature requires to use together with mybatis-spring 2.0.2+. (Available since 2.1.0)
+        </td>
+      </tr>
       <tr>
         <td>
           <code>configuration</code>

mybatis-spring-boot-autoconfigure/src/test/java/org/mybatis/spring/boot/autoconfigure/AdditionalConfigurationMetadataTest.java

@@ -42,13 +42,13 @@ void testProperties() throws IOException {
 				.parse(new FileSystemResource("src/main/resources/META-INF/additional-spring-configuration-metadata.json")
 						.getInputStream());
 
-		List<Map<String, String>> properties = documentContext.read("$.properties");
+		List<Map<String, Object>> properties = documentContext.read("$.properties");
 
-		assertThat(properties.size()).isEqualTo(2);
+		assertThat(properties.size()).isEqualTo(3);
 
 		// assert for default-scripting-language
 		{
-			Map<String, String> element = properties.get(0);
+			Map<String, Object> element = properties.get(0);
 			assertThat(element.get("sourceType")).isEqualTo("org.apache.ibatis.session.Configuration");
 			assertThat(element.get("defaultValue")).isEqualTo("org.apache.ibatis.scripting.xmltags.XMLLanguageDriver");
 			assertThat(element.get("name")).isEqualTo("mybatis.configuration.default-scripting-language");
@@ -57,13 +57,21 @@ void testProperties() throws IOException {
 
 		// assert for default-enum-type-handler
 		{
-		  Map<String, String> element = properties.get(1);
+		  Map<String, Object> element = properties.get(1);
 		  assertThat(element.get("sourceType")).isEqualTo("org.apache.ibatis.session.Configuration");
 		  assertThat(element.get("defaultValue")).isEqualTo("org.apache.ibatis.type.EnumTypeHandler");
 		  assertThat(element.get("name")).isEqualTo("mybatis.configuration.default-enum-type-handler");
 		  assertThat(element.get("type")).isEqualTo("java.lang.Class<? extends org.apache.ibatis.type.TypeHandler>");
 		}
 
+		// assert for lazy-initialization
+		{
+			Map<String, Object> element = properties.get(2);
+			assertThat(element.get("defaultValue")).isEqualTo(false);
+			assertThat(element.get("name")).isEqualTo("mybatis.lazy-initialization");
+			assertThat(element.get("type")).isEqualTo("java.lang.Boolean");
+		}
+
 	}
 
 }

mybatis-spring-boot-autoconfigure/src/test/java/org/mybatis/spring/boot/autoconfigure/MybatisAutoConfigurationTest.java

@@ -126,13 +126,51 @@ void testDefaultConfiguration() {
 				MybatisScanMapperConfiguration.class, MybatisAutoConfiguration.class,
 				PropertyPlaceholderAutoConfiguration.class);
 		this.context.refresh();
+		SqlSessionFactory sqlSessionFactory = this.context.getBean(SqlSessionFactory.class);
+		assertThat(sqlSessionFactory.getConfiguration().getMapperRegistry().getMappers()).hasSize(1);
 		assertThat(this.context.getBeanNamesForType(SqlSessionFactory.class)).hasSize(1);
 		assertThat(this.context.getBeanNamesForType(SqlSessionTemplate.class)).hasSize(1);
 		assertThat(this.context.getBeanNamesForType(CityMapper.class)).hasSize(1);
 		assertThat(this.context.getBean(SqlSessionTemplate.class).getExecutorType()).isEqualTo(ExecutorType.SIMPLE);
 		assertThat(this.context.getBean(SqlSessionFactory.class).getConfiguration().isMapUnderscoreToCamelCase()).isFalse();
 	}
 
+	@Test
+	void testScanWithLazy() {
+		TestPropertyValues.of("mybatis.lazy-initialization:true").applyTo(this.context);
+		this.context.register(EmbeddedDataSourceConfiguration.class,
+				MybatisScanMapperConfiguration.class,
+				MybatisAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class);
+		this.context.refresh();
+		SqlSessionFactory sqlSessionFactory = this.context.getBean(SqlSessionFactory.class);
+		assertThat(sqlSessionFactory.getConfiguration().getMapperRegistry().getMappers()).hasSize(0);
+		assertThat(this.context.getBeanNamesForType(SqlSessionFactory.class)).hasSize(1);
+		assertThat(this.context.getBeanNamesForType(SqlSessionTemplate.class)).hasSize(1);
+		assertThat(this.context.getBeanNamesForType(CityMapper.class)).hasSize(1);
+		assertThat(this.context.getBean(SqlSessionTemplate.class).getExecutorType()).isEqualTo(ExecutorType.SIMPLE);
+		assertThat(this.context.getBean(SqlSessionFactory.class).getConfiguration().isMapUnderscoreToCamelCase()).isFalse();
+		this.context.getBean(CityMapper.class);
+		assertThat(sqlSessionFactory.getConfiguration().getMapperRegistry().getMappers()).hasSize(1);
+	}
+
+	@Test
+	void testAutoScanWithLazy() {
+		TestPropertyValues.of("mybatis.lazy-initialization:true").applyTo(this.context);
+		this.context.register(EmbeddedDataSourceConfiguration.class,
+				MybatisBootMapperScanAutoConfiguration.class,
+				MybatisAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class);
+		this.context.refresh();
+		SqlSessionFactory sqlSessionFactory = this.context.getBean(SqlSessionFactory.class);
+		assertThat(sqlSessionFactory.getConfiguration().getMapperRegistry().getMappers()).hasSize(0);
+		assertThat(this.context.getBeanNamesForType(SqlSessionFactory.class)).hasSize(1);
+		assertThat(this.context.getBeanNamesForType(SqlSessionTemplate.class)).hasSize(1);
+		assertThat(this.context.getBeanNamesForType(CityMapper.class)).hasSize(1);
+		assertThat(this.context.getBean(SqlSessionTemplate.class).getExecutorType()).isEqualTo(ExecutorType.SIMPLE);
+		assertThat(this.context.getBean(SqlSessionFactory.class).getConfiguration().isMapUnderscoreToCamelCase()).isFalse();
+		this.context.getBean(CityMapper.class);
+		assertThat(sqlSessionFactory.getConfiguration().getMapperRegistry().getMappers()).hasSize(1);
+	}
+
 	@Test
 	void testWithConfigLocation() {
 		TestPropertyValues.of("mybatis.config-location:mybatis-config.xml").applyTo(this.context);
@@ -227,6 +265,8 @@ void testDefaultBootConfiguration() {
 				MybatisAutoConfiguration.class,
 				PropertyPlaceholderAutoConfiguration.class);
 		this.context.refresh();
+		SqlSessionFactory sqlSessionFactory = this.context.getBean(SqlSessionFactory.class);
+		assertThat(sqlSessionFactory.getConfiguration().getMapperRegistry().getMappers()).hasSize(1);
 		assertThat(this.context.getBeanNamesForType(SqlSessionFactory.class)).hasSize(1);
 		assertThat(this.context.getBeanNamesForType(SqlSessionTemplate.class)).hasSize(1);
 		assertThat(this.context.getBeanNamesForType(CityMapper.class)).hasSize(1);
@@ -590,7 +630,7 @@ DataSource dataSourceSlave() {
 
 	@Configuration
 	@EnableAutoConfiguration
-	@MapperScan("org.mybatis.spring.boot.autoconfigure.mapper")
+	@MapperScan(basePackages = "org.mybatis.spring.boot.autoconfigure.mapper", lazyInitialization = "${mybatis.lazy-initialization:false}")
 	static class MybatisScanMapperConfiguration {
 	}
 

pom.xml

@@ -68,7 +68,7 @@
 
   <properties>
     <mybatis.version>3.5.1</mybatis.version>
-    <mybatis-spring.version>2.0.1</mybatis-spring.version>
+    <mybatis-spring.version>2.0.2-SNAPSHOT</mybatis-spring.version>
     <spring-boot.version>2.1.4.RELEASE</spring-boot.version>
   </properties>
 
@@ -123,6 +123,11 @@
   </dependencies>
 
   <repositories>
+    <repository>
+      <id>sonatype-oss-snapshots</id>
+      <name>Sonatype OSS Snapshots Repository</name>
+      <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+    </repository>
     <repository>
       <id>spring-milestone</id>
       <name>Spring Milestone</name>