Allow repeatable for @MapperScan

src/main/java/org/mybatis/spring/annotation/MapperScan.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2016 the original author or authors.
+ *    Copyright 2010-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,6 +18,7 @@
 import java.lang.annotation.Annotation;
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
@@ -70,6 +71,7 @@
 @Target(ElementType.TYPE)
 @Documented
 @Import(MapperScannerRegistrar.class)
+@Repeatable(MapperScans.class)
 public @interface MapperScan {
 
   /**

src/main/java/org/mybatis/spring/annotation/MapperScannerRegistrar.java

@@ -43,7 +43,7 @@
  * @author Michael Lanyon
  * @author Eduardo Macarron
  * @author Putthiphong Boonphong
- * 
+ *
  * @see MapperFactoryBean
  * @see ClassPathMapperScanner
  * @since 1.2.0
@@ -65,8 +65,15 @@ public void setResourceLoader(ResourceLoader resourceLoader) {
    */
   @Override
   public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
+    AnnotationAttributes mapperScanAttrs = AnnotationAttributes
+        .fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
+    if (mapperScanAttrs != null) {
+      registerBeanDefinitions(mapperScanAttrs, registry);
+    }
+  }
+
+  void registerBeanDefinitions(AnnotationAttributes annoAttrs, BeanDefinitionRegistry registry) {
 
-    AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
     ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
 
     // this check is needed in Spring 3.1
@@ -117,4 +124,24 @@ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, B
     scanner.doScan(StringUtils.toStringArray(basePackages));
   }
 
+  /**
+   * A {@link MapperScannerRegistrar} for {@link MapperScans}.
+   * @since 2.0.0
+   */
+  static class RepeatingRegistrar extends MapperScannerRegistrar {
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
+        BeanDefinitionRegistry registry) {
+      AnnotationAttributes mapperScansAttrs = AnnotationAttributes
+          .fromMap(importingClassMetadata.getAnnotationAttributes(MapperScans.class.getName()));
+      if (mapperScansAttrs != null) {
+        Arrays.stream(mapperScansAttrs.getAnnotationArray("value"))
+            .forEach(mapperScanAttrs -> registerBeanDefinitions(mapperScanAttrs, registry));
+      }
+    }
+  }
+
 }

src/main/java/org/mybatis/spring/annotation/MapperScans.java

@@ -0,0 +1,44 @@
+/**
+ *    Copyright 2010-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.mybatis.spring.annotation;
+
+import org.springframework.context.annotation.Import;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * The Container annotation that aggregates several {@link MapperScan} annotations.
+ *
+ * <p>Can be used natively, declaring several nested {@link MapperScan} annotations.
+ * Can also be used in conjunction with Java 8's support for repeatable annotations,
+ * where {@link MapperScan} can simply be declared several times on the same method,
+ * implicitly generating this container annotation.
+ *
+ * @author Kazuki Shimizu
+ * @since 2.0.0
+ * @see MapperScan
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Documented
+@Import(MapperScannerRegistrar.RepeatingRegistrar.class)
+public @interface MapperScans {
+  MapperScan[] value();
+}

src/test/java/org/mybatis/spring/annotation/MapperScanTest.java

@@ -245,6 +245,26 @@ void testScanWithExplicitSqlSessionTemplate() throws Exception {
 
   }
 
+  @Test
+  void testScanWithMapperScanIsRepeat() {
+    applicationContext.register(AppConfigWithMapperScanIsRepeat.class);
+
+    startContext();
+
+    applicationContext.getBean("ds1Mapper");
+    applicationContext.getBean("ds2Mapper");
+  }
+
+  @Test
+  void testScanWithMapperScans() {
+    applicationContext.register(AppConfigWithMapperScans.class);
+
+    startContext();
+
+    applicationContext.getBean("ds1Mapper");
+    applicationContext.getBean("ds2Mapper");
+  }
+
   @Configuration
   @MapperScan("org.mybatis.spring.mapper")
   public static class AppConfigWithPackageScan {
@@ -290,6 +310,20 @@ public static class AppConfigWithNameGenerator {
   public static class AppConfigWithCustomMapperFactoryBean {
   }
 
+  @Configuration
+  @MapperScan(basePackages = "org.mybatis.spring.annotation.mapper.ds1")
+  @MapperScan(basePackages = "org.mybatis.spring.annotation.mapper.ds2")
+  public static class AppConfigWithMapperScanIsRepeat {
+  }
+
+  @Configuration
+  @MapperScans({
+      @MapperScan(basePackages = "org.mybatis.spring.annotation.mapper.ds1")
+      ,@MapperScan(basePackages = "org.mybatis.spring.annotation.mapper.ds2")
+  })
+  public static class AppConfigWithMapperScans {
+  }
+
   public static class BeanNameGenerator implements org.springframework.beans.factory.support.BeanNameGenerator {
 
     @Override

src/test/java/org/mybatis/spring/annotation/mapper/ds1/Ds1Mapper.java

@@ -0,0 +1,19 @@
+/**
+ *    Copyright 2010-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.mybatis.spring.annotation.mapper.ds1;
+
+public interface Ds1Mapper {
+}

src/test/java/org/mybatis/spring/annotation/mapper/ds2/Ds2Mapper.java

@@ -0,0 +1,19 @@
+/**
+ *    Copyright 2010-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.mybatis.spring.annotation.mapper.ds2;
+
+public interface Ds2Mapper {
+}