fixes #481 Looks for a matching statement defined in super interfaces recursively. Related to #35 .

Author: harawata

src/main/java/org/apache/ibatis/binding/MapperMethod.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.
@@ -212,22 +212,17 @@ public static class SqlCommand {
     private final SqlCommandType type;
 
     public SqlCommand(Configuration configuration, Class<?> mapperInterface, Method method) {
-      String statementName = mapperInterface.getName() + "." + method.getName();
-      MappedStatement ms = null;
-      if (configuration.hasStatement(statementName)) {
-        ms = configuration.getMappedStatement(statementName);
-      } else if (!mapperInterface.equals(method.getDeclaringClass())) { // issue #35
-        String parentStatementName = method.getDeclaringClass().getName() + "." + method.getName();
-        if (configuration.hasStatement(parentStatementName)) {
-          ms = configuration.getMappedStatement(parentStatementName);
-        }
-      }
+      final String methodName = method.getName();
+      final Class<?> declaringClass = method.getDeclaringClass();
+      MappedStatement ms = resolveMappedStatement(mapperInterface, methodName, declaringClass,
+          configuration);
       if (ms == null) {
-        if(method.getAnnotation(Flush.class) != null){
+        if (method.getAnnotation(Flush.class) != null) {
           name = null;
           type = SqlCommandType.FLUSH;
         } else {
-          throw new BindingException("Invalid bound statement (not found): " + statementName);
+          throw new BindingException("Invalid bound statement (not found): "
+              + mapperInterface.getName() + "." + methodName);
         }
       } else {
         name = ms.getId();
@@ -245,6 +240,26 @@ public String getName() {
     public SqlCommandType getType() {
       return type;
     }
+
+    private MappedStatement resolveMappedStatement(Class<?> mapperInterface, String methodName,
+        Class<?> declaringClass, Configuration configuration) {
+      String statementId = mapperInterface.getName() + "." + methodName;
+      if (configuration.hasStatement(statementId)) {
+        return configuration.getMappedStatement(statementId);
+      } else if (mapperInterface.equals(declaringClass)) {
+        return null;
+      }
+      for (Class<?> superInterface : mapperInterface.getInterfaces()) {
+        if (declaringClass.isAssignableFrom(superInterface)) {
+          MappedStatement ms = resolveMappedStatement(superInterface, methodName,
+              declaringClass, configuration);
+          if (ms != null) {
+            return ms;
+          }
+        }
+      }
+      return null;
+    }
   }
 
   public static class MethodSignature {

src/test/java/org/apache/ibatis/submitted/mapper_extend/ChildMapper.java

@@ -0,0 +1,20 @@
+/**
+ *    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.mapper_extend;
+
+public interface ChildMapper extends ParentMapper {
+
+}

src/test/java/org/apache/ibatis/submitted/mapper_extend/GrandpaMapper.java

@@ -0,0 +1,25 @@
+/**
+ *    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.mapper_extend;
+
+public interface GrandpaMapper {
+
+  User getUserByName(String name);
+
+  User noMappedStatement();
+
+}

src/test/java/org/apache/ibatis/submitted/mapper_extend/MapperExtendTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 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.
@@ -15,20 +15,28 @@
  */
 package org.apache.ibatis.submitted.mapper_extend;
 
+import static org.hamcrest.CoreMatchers.*;
+
 import java.io.Reader;
 import java.sql.Connection;
 
+import org.apache.ibatis.binding.BindingException;
 import org.apache.ibatis.io.Resources;
 import org.apache.ibatis.jdbc.ScriptRunner;
 import org.apache.ibatis.session.SqlSession;
 import org.apache.ibatis.session.SqlSessionFactory;
 import org.apache.ibatis.session.SqlSessionFactoryBuilder;
 import org.junit.Assert;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.rules.ExpectedException;
 
 public class MapperExtendTest {
 
+  @Rule
+  public ExpectedException expectedException = ExpectedException.none();
+
   private static SqlSessionFactory sqlSessionFactory;
 
   @BeforeClass
@@ -97,5 +105,32 @@ public void shouldGetAUserWithAnOverloadedAnnotatedMethod() {
       sqlSession.close();
     }
   }
-  
+
+  @Test
+  public void shouldFindStatementInSubInterfaceOfDeclaringClass() {
+    SqlSession sqlSession = sqlSessionFactory.openSession();
+    try {
+      ChildMapper mapper = sqlSession.getMapper(ChildMapper.class);
+      User user = mapper.getUserByName("User1");
+      Assert.assertNotNull(user);
+    } finally {
+      sqlSession.close();
+    }
+  }
+
+  @Test
+  public void shouldThrowExceptionIfNoMatchingStatementFound() {
+    expectedException.expect(BindingException.class);
+    expectedException.expectMessage(is("Invalid bound statement (not found): "
+        + Mapper.class.getName() + ".noMappedStatement"));
+
+    SqlSession sqlSession = sqlSessionFactory.openSession();
+    try {
+      Mapper mapper = sqlSession.getMapper(Mapper.class);
+      User user = mapper.noMappedStatement();
+      Assert.assertNotNull(user);
+    } finally {
+      sqlSession.close();
+    }
+  }
 }

src/test/java/org/apache/ibatis/submitted/mapper_extend/ParentMapper.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 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.
@@ -17,7 +17,7 @@
 
 import org.apache.ibatis.annotations.Select;
 
-public interface ParentMapper {
+public interface ParentMapper extends GrandpaMapper {
 
   User getUserXML();
 

src/test/java/org/apache/ibatis/submitted/mapper_extend/ParentMapper.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-       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.
@@ -22,6 +22,10 @@
 
 <mapper namespace="org.apache.ibatis.submitted.mapper_extend.ParentMapper">
 
+  <select id="getUserByName" resultType="org.apache.ibatis.submitted.mapper_extend.User">
+    select * from users where name = #{name}
+  </select>
+
 	<select id="getUserXML" resultType="org.apache.ibatis.submitted.mapper_extend.User">
 		select * from users where id = 1
 	</select>

src/test/java/org/apache/ibatis/submitted/mapper_extend/mybatis-config.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!--
 
-       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.
@@ -39,6 +39,7 @@
 		<mapper class="org.apache.ibatis.submitted.mapper_extend.ParentMapper" />
 		<mapper class="org.apache.ibatis.submitted.mapper_extend.Mapper" />
 		<mapper class="org.apache.ibatis.submitted.mapper_extend.MapperOverload" />
+		<mapper class="org.apache.ibatis.submitted.mapper_extend.ChildMapper" />
 	</mappers>
 
 </configuration>