修正插件注释的默认实现行为

Author: hewei

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

@@ -29,7 +29,10 @@
  * ---------------------------------------------------------------------------
  */
 public class CommentPlugin extends BasePlugin {
-    public static final String PRO_TEMPLATE = "template";  // 模板 property
+    /**
+     * 模板 property
+     */
+    public static final String PRO_TEMPLATE = "template";
 
     /**
      * 插件具体实现查看BasePlugin

src/main/java/com/itfsw/mybatis/generator/plugins/utils/BasePlugin.java

@@ -25,7 +25,6 @@
 import org.mybatis.generator.api.PluginAdapter;
 import org.mybatis.generator.config.Context;
 import org.mybatis.generator.config.PluginConfiguration;
-import org.mybatis.generator.internal.DefaultCommentGenerator;
 import org.mybatis.generator.internal.util.StringUtility;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -66,15 +65,9 @@ public void setContext(Context context) {
         PluginConfiguration cfg = PluginTools.getPluginConfiguration(context, CommentPlugin.class);
 
         if (cfg == null || cfg.getProperty(CommentPlugin.PRO_TEMPLATE) == null) {
-            if (context.getCommentGenerator() instanceof DefaultCommentGenerator) {
-                // 使用默认模板引擎
-                commentGenerator = new TemplateCommentGenerator(context, "default-comment.ftl", true);
-            } else {
-                // 用户自定义
-                commentGenerator = context.getCommentGenerator();
-            }
+            commentGenerator = context.getCommentGenerator();
         } else {
-            TemplateCommentGenerator templateCommentGenerator = new TemplateCommentGenerator(context, cfg.getProperty(CommentPlugin.PRO_TEMPLATE), false);
+            TemplateCommentGenerator templateCommentGenerator = new TemplateCommentGenerator(context, cfg.getProperty(CommentPlugin.PRO_TEMPLATE));
 
             // ITFSW 插件使用的注释生成器
             commentGenerator = templateCommentGenerator;

src/main/java/com/itfsw/mybatis/generator/plugins/utils/enhanced/TemplateCommentGenerator.java

@@ -38,7 +38,6 @@
 
 import javax.xml.bind.DatatypeConverter;
 import java.io.File;
-import java.io.InputStream;
 import java.io.StringWriter;
 import java.util.*;
 
@@ -65,22 +64,15 @@ public class TemplateCommentGenerator implements CommentGenerator {
      * 构造函数
      * @param context
      * @param templatePath  模板路径
-     * @param useForDefault 未使用Comment插件，用作默认注释生成器
      */
-    public TemplateCommentGenerator(Context context, String templatePath, boolean useForDefault) {
+    public TemplateCommentGenerator(Context context, String templatePath) {
         try {
             Document doc = null;
-            if (useForDefault) {
-                InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(templatePath);
-                doc = new SAXReader().read(inputStream);
-                inputStream.close();
+            File file = new File(templatePath);
+            if (file.exists()) {
+                doc = new SAXReader().read(file);
             } else {
-                File file = new File(templatePath);
-                if (file.exists()) {
-                    doc = new SAXReader().read(file);
-                } else {
-                    logger.error("没有找到对应注释模板:" + templatePath);
-                }
+                logger.error("没有找到对应注释模板:" + templatePath);
             }
 
             // 遍历comment 节点

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

@@ -54,23 +54,6 @@ public static void init() throws Exception {
         DBHelper.createDB("scripts/CommentPlugin/init.sql");
     }
 
-    /**
-     * 测试没有配置模板的情况
-     */
-    @Test
-    public void testGenerateWithoutTemplate() throws Exception {
-        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/CommentPlugin/mybatis-generator-without-template.xml");
-        MyBatisGenerator myBatisGenerator = tool.generate();
-        // 是否在使用系统默认模板
-        int count = 0;
-        for (GeneratedJavaFile file : myBatisGenerator.getGeneratedJavaFiles()) {
-            if (file.getFormattedContent().indexOf("@project https://github.com/itfsw/mybatis-generator-plugin") != -1) {
-                count++;
-            }
-        }
-        Assert.assertTrue(count > 0);
-    }
-
     /**
      * 测试配置了模板参数转换
      */

src/test/resources/scripts/CommentPlugin/mybatis-generator-without-comment.xml

@@ -25,7 +25,9 @@
     <context id="default" targetRuntime="MyBatis3">
         <!-- 插件 -->
         <!-- 注释插件 -->
-        <plugin type="com.itfsw.mybatis.generator.plugins.CommentPlugin"/>
+        <plugin type="com.itfsw.mybatis.generator.plugins.CommentPlugin">
+            <property name="template" value="src/test/resources/scripts/CommentPlugin/test-comment.ftl"/>
+        </plugin>
 
         <commentGenerator>
             <property name="suppressAllComments" value="true"/>