From 5c5c7765b86cd757729a9449a00a252986865847 Mon Sep 17 00:00:00 2001
From: hewei <hewei@itfsw.com>
Date: Thu, 10 Jan 2019 10:40:27 +0800
Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0CommentPlugin=E7=9A=84?=
 =?UTF-8?q?=E6=B5=8B=E8=AF=95=E7=94=A8=E4=BE=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../generator/plugins/CommentPluginTest.java  | 33 ++++++++++-
 .../{ComentPlugin => CommentPlugin}/init.sql  |  0
 .../mybatis-generator-without-comment.xml     | 57 +++++++++++++++++++
 .../mybatis-generator-without-template.xml    |  0
 .../mybatis-generator.xml                     |  2 +-
 .../test-comment.ftl                          |  0
 6 files changed, 88 insertions(+), 4 deletions(-)
 rename src/test/resources/scripts/{ComentPlugin => CommentPlugin}/init.sql (100%)
 create mode 100644 src/test/resources/scripts/CommentPlugin/mybatis-generator-without-comment.xml
 rename src/test/resources/scripts/{ComentPlugin => CommentPlugin}/mybatis-generator-without-template.xml (100%)
 rename src/test/resources/scripts/{ComentPlugin => CommentPlugin}/mybatis-generator.xml (98%)
 rename src/test/resources/scripts/{ComentPlugin => CommentPlugin}/test-comment.ftl (100%)

diff --git a/src/test/java/com/itfsw/mybatis/generator/plugins/CommentPluginTest.java b/src/test/java/com/itfsw/mybatis/generator/plugins/CommentPluginTest.java
index 2630ef4..f971192 100644
--- a/src/test/java/com/itfsw/mybatis/generator/plugins/CommentPluginTest.java
+++ b/src/test/java/com/itfsw/mybatis/generator/plugins/CommentPluginTest.java
@@ -51,7 +51,7 @@ public class CommentPluginTest {
      */
     @BeforeClass
     public static void init() throws Exception {
-        DBHelper.createDB("scripts/ComentPlugin/init.sql");
+        DBHelper.createDB("scripts/CommentPlugin/init.sql");
     }
 
     /**
@@ -59,7 +59,7 @@ public class CommentPluginTest {
      */
     @Test
     public void testGenerateWithoutTemplate() throws Exception {
-        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/ComentPlugin/mybatis-generator-without-template.xml");
+        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/CommentPlugin/mybatis-generator-without-template.xml");
         MyBatisGenerator myBatisGenerator = tool.generate();
         // 是否在使用系统默认模板
         int count = 0;
@@ -76,7 +76,7 @@ public class CommentPluginTest {
      */
     @Test
     public void testGenerateWithTemplate() throws Exception {
-        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/ComentPlugin/mybatis-generator.xml");
+        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/CommentPlugin/mybatis-generator.xml");
         MyBatisGenerator myBatisGenerator = tool.generate();
 
         // java中的注释
@@ -105,4 +105,31 @@ public class CommentPluginTest {
         String comment = ((TextElement) els.get(0)).getContent();
         Assert.assertEquals(comment, "addComment:BaseResultMap");
     }
+
+    /**
+     * 测试配置了模板参数转换
+     */
+    @Test
+    public void testGenerateWithOutComment() throws Exception {
+        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/CommentPlugin/mybatis-generator-without-comment.xml");
+        MyBatisGenerator myBatisGenerator = tool.generate();
+
+        // java中的注释
+        for (GeneratedJavaFile file : myBatisGenerator.getGeneratedJavaFiles()) {
+            if (file.getFileName().equals("Tb.java")) {
+                TopLevelClass topLevelClass = (TopLevelClass) file.getCompilationUnit();
+                // addJavaFileComment
+                Assert.assertEquals(topLevelClass.getFileCommentLines().size(), 0);
+                // addFieldComment
+                Field id = topLevelClass.getFields().get(0);
+                Assert.assertEquals(id.getJavaDocLines().size(), 0);
+                // addGeneralMethodComment
+                Method cons = topLevelClass.getMethods().get(0);
+                Assert.assertEquals(cons.getJavaDocLines().size(), 0);
+                // addSetterComment
+                Method setter = topLevelClass.getMethods().get(5);
+                Assert.assertEquals(setter.getJavaDocLines().size(), 0);
+            }
+        }
+    }
 }
diff --git a/src/test/resources/scripts/ComentPlugin/init.sql b/src/test/resources/scripts/CommentPlugin/init.sql
similarity index 100%
rename from src/test/resources/scripts/ComentPlugin/init.sql
rename to src/test/resources/scripts/CommentPlugin/init.sql
diff --git a/src/test/resources/scripts/CommentPlugin/mybatis-generator-without-comment.xml b/src/test/resources/scripts/CommentPlugin/mybatis-generator-without-comment.xml
new file mode 100644
index 0000000..e1a92b9
--- /dev/null
+++ b/src/test/resources/scripts/CommentPlugin/mybatis-generator-without-comment.xml
@@ -0,0 +1,57 @@
+<?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.CommentPlugin"/>
+
+        <commentGenerator>
+            <property name="suppressAllComments" value="true"/>
+        </commentGenerator>
+        <!--jdbc的数据库连接 -->
+        <jdbcConnection driverClass="${driver}" connectionURL="${url}" userId="${username}" password="${password}" />
+        <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
+            targetPackage     指定生成的model生成所在的包名
+            targetProject     指定在该项目下所在的路径  -->
+        <javaModelGenerator targetPackage="" targetProject="">
+            <!-- 是否对model添加 构造函数 -->
+            <property name="constructorBased" value="true"/>
+            <!-- 给Model添加一个父类 -->
+            <!--<property name="rootClass" value="com.itfsw.base"/>-->
+        </javaModelGenerator>
+        <!--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">
+            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
+        </table>
+    </context>
+</generatorConfiguration>
\ No newline at end of file
diff --git a/src/test/resources/scripts/ComentPlugin/mybatis-generator-without-template.xml b/src/test/resources/scripts/CommentPlugin/mybatis-generator-without-template.xml
similarity index 100%
rename from src/test/resources/scripts/ComentPlugin/mybatis-generator-without-template.xml
rename to src/test/resources/scripts/CommentPlugin/mybatis-generator-without-template.xml
diff --git a/src/test/resources/scripts/ComentPlugin/mybatis-generator.xml b/src/test/resources/scripts/CommentPlugin/mybatis-generator.xml
similarity index 98%
rename from src/test/resources/scripts/ComentPlugin/mybatis-generator.xml
rename to src/test/resources/scripts/CommentPlugin/mybatis-generator.xml
index ff8dc38..ebfd248 100644
--- a/src/test/resources/scripts/ComentPlugin/mybatis-generator.xml
+++ b/src/test/resources/scripts/CommentPlugin/mybatis-generator.xml
@@ -26,7 +26,7 @@
         <!-- 插件 -->
         <!-- 注释插件 -->
         <plugin type="com.itfsw.mybatis.generator.plugins.CommentPlugin">
-            <property name="template" value="src/test/resources/scripts/ComentPlugin/test-comment.ftl"/>
+            <property name="template" value="src/test/resources/scripts/CommentPlugin/test-comment.ftl"/>
         </plugin>
 
         <commentGenerator>
diff --git a/src/test/resources/scripts/ComentPlugin/test-comment.ftl b/src/test/resources/scripts/CommentPlugin/test-comment.ftl
similarity index 100%
rename from src/test/resources/scripts/ComentPlugin/test-comment.ftl
rename to src/test/resources/scripts/CommentPlugin/test-comment.ftl