新增ModelCloneablePlugin插件和测试用例

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

+/*
+ * Copyright (c) 2018.
+ *
+ * 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 com.itfsw.mybatis.generator.plugins;
+
+import com.itfsw.mybatis.generator.plugins.utils.BasePlugin;
+import com.itfsw.mybatis.generator.plugins.utils.JavaElementGeneratorTools;
+import org.mybatis.generator.api.IntrospectedTable;
+import org.mybatis.generator.api.dom.java.*;
+
+/**
+ * ---------------------------------------------------------------------------
+ * Cloneable
+ * ---------------------------------------------------------------------------
+ * @author: hewei
+ * @time:2018/11/7 15:26
+ * ---------------------------------------------------------------------------
+ */
+public class ModelCloneablePlugin extends BasePlugin {
+    /**
+     * 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
+     * @param topLevelClass
+     * @param introspectedTable
+     * @return
+     */
+    @Override
+    public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
+        this.supportCloneable(topLevelClass, introspectedTable);
+        return super.modelBaseRecordClassGenerated(topLevelClass, introspectedTable);
+    }
+
+    /**
+     * 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
+     * @param topLevelClass
+     * @param introspectedTable
+     * @return
+     */
+    @Override
+    public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
+        this.supportCloneable(topLevelClass, introspectedTable);
+        return super.modelPrimaryKeyClassGenerated(topLevelClass, introspectedTable);
+    }
+
+    /**
+     * 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
+     * @param topLevelClass
+     * @param introspectedTable
+     * @return
+     */
+    @Override
+    public boolean modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
+        this.supportCloneable(topLevelClass, introspectedTable);
+        return super.modelRecordWithBLOBsClassGenerated(topLevelClass, introspectedTable);
+    }
+
+    /**
+     * 支持Cloneable
+     * @param topLevelClass
+     * @param introspectedTable
+     */
+    private void supportCloneable(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
+        // implement
+        topLevelClass.addSuperInterface(new FullyQualifiedJavaType("java.lang.Cloneable"));
+        // clone
+        Method cloneMethod = JavaElementGeneratorTools.generateMethod(
+                "clone",
+                JavaVisibility.PUBLIC,
+                topLevelClass.getType()
+        );
+        commentGenerator.addGeneralMethodComment(cloneMethod, introspectedTable);
+        cloneMethod.addAnnotation("@Override");
+        cloneMethod.addException(new FullyQualifiedJavaType("java.lang.CloneNotSupportedException"));
+        cloneMethod.addBodyLine("return (" + topLevelClass.getType().getShortName() + ") super.clone();");
+        topLevelClass.addMethod(cloneMethod);
+    }
+}

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

+/*
+ * Copyright (c) 2018.
+ *
+ * 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 com.itfsw.mybatis.generator.plugins;
+
+import com.itfsw.mybatis.generator.plugins.tools.AbstractShellCallback;
+import com.itfsw.mybatis.generator.plugins.tools.DBHelper;
+import com.itfsw.mybatis.generator.plugins.tools.MyBatisGeneratorTool;
+import com.itfsw.mybatis.generator.plugins.tools.ObjectUtil;
+import org.apache.ibatis.session.SqlSession;
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+/**
+ * ---------------------------------------------------------------------------
+ *
+ * ---------------------------------------------------------------------------
+ * @author: hewei
+ * @time:2018/11/7 15:43
+ * ---------------------------------------------------------------------------
+ */
+public class ModelCloneablePluginTest {
+    /**
+     * 初始化
+     */
+    @BeforeClass
+    public static void init() throws Exception {
+        DBHelper.createDB("scripts/ModelCloneablePlugin/init.sql");
+    }
+
+    /**
+     * 测试生成的model
+     */
+    @Test
+    public void testModel() throws Exception {
+        MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/ModelCloneablePlugin/mybatis-generator.xml");
+        tool.generate(new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tb = new ObjectUtil(loader, packagz + ".Tb");
+                tb.set("id", 100L);
+                tb.set("field1", "ts1");
+
+                ObjectUtil tbClone = new ObjectUtil(tb.invoke("clone"));
+                Assert.assertEquals(tbClone.get("id"), 100L);
+                Assert.assertEquals(tbClone.get("field1"), "ts1");
+
+                tbClone.set("field1", "ts2");
+                Assert.assertEquals(tb.get("field1"), "ts1");
+                Assert.assertEquals(tbClone.get("field1"), "ts2");
+            }
+        });
+    }
+
+}
\ No newline at end of file

src/test/resources/scripts/ModelCloneablePlugin/init.sql

+/*
+Navicat MySQL Data Transfer
+
+Source Server         : localhost
+Source Server Version : 50617
+Source Host           : localhost:3306
+Source Database       : mybatis-generator-plugin
+
+Target Server Type    : MYSQL
+Target Server Version : 50617
+File Encoding         : 65001
+
+Date: 2017-07-03 17:34:11
+*/
+
+SET FOREIGN_KEY_CHECKS=0;
+
+-- ----------------------------
+-- Table structure for tb
+-- ----------------------------
+DROP TABLE IF EXISTS `tb`;
+CREATE TABLE `tb` (
+  `id` bigint(20) NOT NULL COMMENT '注释1',
+  `key1` varchar(255) NOT NULL,
+  `field1` varchar(255) DEFAULT NULL COMMENT '注释2',
+  `field2` int(11) DEFAULT NULL,
+  PRIMARY KEY (`id`, `key1`)
+) ENGINE=MyISAM AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
\ No newline at end of file

src/test/resources/scripts/ModelCloneablePlugin/mybatis-generator.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2018.
+  ~
+  ~ 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.ModelCloneablePlugin"/>
+
+        <!--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>
\ No newline at end of file