pull#120 增加对老版本兼容，补充测试用例

Author: hewei

README.md

@@ -1710,8 +1710,10 @@ public class Test {
     <plugin type="com.itfsw.mybatis.generator.plugins.MapperAnnotationPlugin">
         <!-- @Mapper 默认开启 -->
         <property name="@Mapper" value="true"/>
-        <!-- @Repository 默认关闭，开启后解决IDEA工具@Autowired报错 -->
-        <property name="@Repository" value="false"/>
+        <!-- @Repository 开启后解决IDEA工具@Autowired报错 -->
+        <property name="@Repository" value="org.springframework.stereotype.Repository"/>
+        <!-- 其他自定义注解 -->
+        <property name="@DS(&quot;master&quot;)" value="com.baomidou.dynamic.datasource.annotation.DS"/>
     </plugin>
 </xml>
 ```

src/main/java/com/itfsw/mybatis/generator/plugins/MapperAnnotationPlugin.java

@@ -21,53 +21,53 @@
 import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
 import org.mybatis.generator.api.dom.java.Interface;
 import org.mybatis.generator.api.dom.java.TopLevelClass;
+import org.mybatis.generator.internal.util.StringUtility;
 
 import java.util.Map;
 import java.util.Properties;
 
 /**
  * ---------------------------------------------------------------------------
- *
+ * <p>
  * ---------------------------------------------------------------------------
  *
  * @author: hewei
  * @time:2019/7/9 14:30
  * ---------------------------------------------------------------------------
  */
 public class MapperAnnotationPlugin extends BasePlugin {
+    /**
+     * 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
+     *
+     * @param interfaze
+     * @param topLevelClass
+     * @param introspectedTable
+     * @return
+     */
+    @Override
+    public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
+        Properties properties = getProperties();
+        // 和官方插件一致支持，没有配置特殊注解时默认开启@Mapper
+        if ("true".equalsIgnoreCase(properties.getProperty("@Mapper", "true")) && introspectedTable.getTargetRuntime() == IntrospectedTable.TargetRuntime.MYBATIS3) {
+            // don't need to do this for MYBATIS3_DSQL as that runtime already adds this annotation
+            interfaze.addImportedType(new FullyQualifiedJavaType("org.apache.ibatis.annotations.Mapper"));
+            interfaze.addAnnotation("@Mapper");
+        }
 
-	/**
-	 * 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
-	 * @param introspectedTable
-	 * @return
-	 */
-	@Override
-	public void initialized(IntrospectedTable introspectedTable) {
-		super.initialized(introspectedTable);
-	}
-
-	/**
-	 * 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
-	 * @param interfaze
-	 * @param topLevelClass
-	 * @param introspectedTable
-	 * @return
-	 */
-	@Override
-	public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass,
-			IntrospectedTable introspectedTable) {
-
-		Properties properties = getProperties();
-		String annotationName;
-		String annotationImport;
-		for (Map.Entry<Object, Object> prop : properties.entrySet()) {
-			annotationName = (String) prop.getKey();
-			annotationImport = (String) prop.getValue();
-			interfaze.addImportedType(new FullyQualifiedJavaType(annotationImport));
-			interfaze.addAnnotation(annotationName);
-		}
+        for (Map.Entry<Object, Object> prop : properties.entrySet()) {
+            String annotationName = prop.getKey().toString().trim();
+            String annotationImport = prop.getValue().toString().trim();
+            // TODO 兼容老版本
+            if ("@Repository".equals(annotationName) && StringUtility.isTrue(annotationImport)) {
+                interfaze.addImportedType(new FullyQualifiedJavaType("org.springframework.stereotype.Repository"));
+                interfaze.addAnnotation("@Repository");
+            } else if (!"@Mapper".equals(annotationName)) {
+                interfaze.addImportedType(new FullyQualifiedJavaType(annotationImport));
+                interfaze.addAnnotation(annotationName);
+            }
+        }
 
-		return true;
-	}
+        return true;
+    }
 
 }

src/test/java/com/itfsw/mybatis/generator/plugins/MapperAnnotationPluginTest.java

@@ -65,13 +65,37 @@ public void testDefault() throws Exception{
         }
     }
 
+    /**
+     * 测试@Mapper false 并且自定义 @Repository
+     * @throws Exception
+     */
+    @Test
+    public void testWithMapperFalseAndCustomRepository() throws Exception{
+        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/MapperAnnotationPlugin/mybatis-generator-with-mapper-false.xml");
+        MyBatisGenerator myBatisGenerator = tool.generate();
+
+        for (GeneratedJavaFile file : myBatisGenerator.getGeneratedJavaFiles()) {
+            CompilationUnit compilationUnit = file.getCompilationUnit();
+            if (compilationUnit instanceof Interface && compilationUnit.getType().getShortName().endsWith("Mapper")) {
+                Interface interfaze = (Interface) compilationUnit;
+
+                Assert.assertEquals(interfaze.getAnnotations().size(), 2);
+                Assert.assertEquals(interfaze.getAnnotations().get(0), "@DS(\"master\")");
+                Assert.assertEquals(interfaze.getAnnotations().get(1), "@Repository");
+                Assert.assertTrue(interfaze.getImportedTypes().contains(new FullyQualifiedJavaType("org.springframework.test.Repository")));
+                Assert.assertTrue(interfaze.getImportedTypes().contains(new FullyQualifiedJavaType("com.baomidou.dynamic.datasource.annotation.DS")));
+            }
+        }
+    }
+
+
     /**
      * 测试配置Repository
      * @throws Exception
      */
     @Test
     public void testWithRepository() throws Exception{
-        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/MapperAnnotationPlugin/mybatis-generator-with-repository.xml");
+        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/MapperAnnotationPlugin/mybatis-generator-with-old-repository.xml");
         MyBatisGenerator myBatisGenerator = tool.generate();
 
         for (GeneratedJavaFile file : myBatisGenerator.getGeneratedJavaFiles()) {

src/test/resources/scripts/MapperAnnotationPlugin/mybatis-generator-with-mapper-false.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2019.
+  ~
+  ~ 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.
+  -->
+
+<!DOCTYPE generatorConfiguration
+        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
+        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
+<generatorConfiguration>
+    <properties resource="db.properties"/>
+    <!--导入属性配置 -->
+    <context id="default" targetRuntime="MyBatis3">
+        <!-- 插件 -->
+        <plugin type="com.itfsw.mybatis.generator.plugins.MapperAnnotationPlugin">
+            <property name="@Mapper" value="false"/>
+            <property name="@Repository" value="org.springframework.test.Repository"/>
+            <property name="@DS(&quot;master&quot;)" value="com.baomidou.dynamic.datasource.annotation.DS"/>
+        </plugin>
+
+        <!--jdbc的数据库连接 -->
+        <jdbcConnection driverClass="${driver}" connectionURL="${url}" userId="${username}" password="${password}"/>
+        <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
+            targetPackage     指定生成的model生成所在的包名
+            targetProject     指定在该项目下所在的路径  -->
+        <javaModelGenerator targetPackage="" targetProject=""/>
+        <!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
+        <sqlMapGenerator targetPackage="" targetProject=""/>
+        <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
+            type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
+            type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
+            type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
+        <javaClientGenerator targetPackage="" targetProject="" type="XMLMAPPER"/>
+
+        <!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 要自动生成的表 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
+        <table tableName="tb"/>
+    </context>
+</generatorConfiguration>