MyBatis Generator系列(八)----MyBatis Generator自定义插件实现自定义Mapper

Love The Way You Lie 2022-06-04 02:57 240阅读 0赞

**一、创建基类**

有时候会通过创建实体的基类，用来复用一些代码，然后让其他的实体类集成这个类:

package com.fendo.bean;
    /**   
     * @Title: BaseModel.java 
     * @Package com.fendo.bean 
     * @Description: 实体基类
     * @author fendo
     * @date 2017年12月2日 下午5:32:40 
     * @version V1.0   
    */
    public class BaseModel {
    	
    
    	private String createDate;
    	private String createName;
    	private String updateDate;
    	private String updateName;
    	
    	public String getCreateDate() {
    		return createDate;
    	}
    	public void setCreateDate(String createDate) {
    		this.createDate = createDate;
    	}
    	public String getCreateName() {
    		return createName;
    	}
    	public void setCreateName(String createName) {
    		this.createName = createName;
    	}
    	public String getUpdateDate() {
    		return updateDate;
    	}
    	public void setUpdateDate(String updateDate) {
    		this.updateDate = updateDate;
    	}
    	public String getUpdateName() {
    		return updateName;
    	}
    	public void setUpdateName(String updateName) {
    		this.updateName = updateName;
    	}
    	
    }

然后创建一个Mapper基类

/**   
     * @Title: BaseMapper.java 
     * @Package com.fendo.mapper 
     * @Description: Mapper基类
     * @author fendo
     * @date 2017年12月2日 下午5:33:05 
     * @version V1.0   
    */
    public interface  BaseMapper<T extends BaseModel> {
    
        List<T> selectAll();
    
        int deleteByPrimaryKey(String id);
    
        int insert(T record);
    
        int insertSelective(T record);
    
        T selectByPrimaryKey(String id);
    
        int updateByPrimaryKey(T record);
        
        int updateByPrimaryKeySelective(T record);
    
    }

**二、配置generatorConfig.xml**

引入插件:

<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
    
    <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/>
    <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
    
    
    <plugin type="org.mybatis.generator.plugins.MapperPlugin">
    	<property name="targetProject" value="../mybatis-generator-oracle/src/main/java"/>
    	<property name="targetPackage" value="com.fendo.mapper"/>
    </plugin>  
    <commentGenerator>
    	
    	<property name="javaFileEncoding" value="UTF-8"/>
    	
    	<property name="suppressAllComments" value="false"/>
    </commentGenerator>

然后给mapper和bean添加基类

<javaModelGenerator targetPackage="com.fendo.bean" targetProject="src/main/java">  
    	<property name="enableSubPackages" value="true"/>  
    	<property name="trimStrings" value="true"/>
    	<property name="rootClass" value="com.fendo.bean.BaseModel"/>
    </javaModelGenerator>  
    
      
    <javaClientGenerator type="XMLMAPPER" targetPackage="com.fendo.mapper" targetProject="src/main/java">  
    	<property name="enableSubPackages" value="true"/>
    	<property name="rootInterface" value="com.fendo.mapper.BaseMapper"/>
    </javaClientGenerator>

**三、创建MapperPlugin**

创建自己的类然后实现PluginAdapter

package org.mybatis.generator.plugins;
    
    import java.io.File;
    import java.util.ArrayList;
    import java.util.List;
    
    
    import static org.mybatis.generator.internal.util.StringUtility.stringHasValue;
    import static org.mybatis.generator.internal.util.messages.Messages.getString;
    
    import org.mybatis.generator.api.GeneratedJavaFile;
    import org.mybatis.generator.api.IntrospectedTable;
    import org.mybatis.generator.api.JavaFormatter;
    import org.mybatis.generator.api.PluginAdapter;
    import org.mybatis.generator.api.ShellCallback;
    import org.mybatis.generator.api.dom.java.CompilationUnit;
    import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
    import org.mybatis.generator.api.dom.java.Interface;
    import org.mybatis.generator.api.dom.java.JavaVisibility;
    import org.mybatis.generator.api.dom.xml.Attribute;
    import org.mybatis.generator.api.dom.xml.Document;
    import org.mybatis.generator.api.dom.xml.TextElement;
    import org.mybatis.generator.api.dom.xml.XmlElement;
    import org.mybatis.generator.exception.ShellException;
    import org.mybatis.generator.internal.DefaultShellCallback;
    
    /**   
     * @Title: MapperPlugin.java 
     * @Package org.mybatis.generator.plugins 
     * @Description: TODO
     * @author fendo
     * @date 2017年12月2日 下午5:35:14 
     * @version V1.0   
    */
    public class MapperPlugin extends PluginAdapter{
    
        private static final String DEFAULT_DAO_SUPER_CLASS = "com.fendo.mapper.BaseMapper";
        private static final String DEFAULT_EXPAND_DAO_SUPER_CLASS = "com.fendo.mapper.BaseExpandMapper";
        private String daoTargetDir;
        private String daoTargetPackage;
    
        private String daoSuperClass;
    
        // 扩展
        private String expandDaoTargetPackage;
        private String expandDaoSuperClass;
    
        private ShellCallback shellCallback = null;
    
        public MapperPlugin() {
            shellCallback = new DefaultShellCallback(false);
        }
    
        /**
         * 验证参数是否有效
         * @param warnings
         * @return
         */
        public boolean validate(List<String> warnings) {
            daoTargetDir = properties.getProperty("targetProject");
            boolean valid = stringHasValue(daoTargetDir);
    
            daoTargetPackage = properties.getProperty("targetPackage");
            boolean valid2 = stringHasValue(daoTargetPackage);
    
            daoSuperClass = properties.getProperty("daoSuperClass");
            if (!stringHasValue(daoSuperClass)) {
                daoSuperClass = DEFAULT_DAO_SUPER_CLASS;
            }
    
            expandDaoTargetPackage = properties.getProperty("expandTargetPackage");
            expandDaoSuperClass = properties.getProperty("expandDaoSuperClass");
            if (!stringHasValue(expandDaoSuperClass)) {
                expandDaoSuperClass = DEFAULT_EXPAND_DAO_SUPER_CLASS;
            }
            return valid && valid2;
        }
    
        
        /** 
         * 生成mapping 添加自定义sql 
         */ 
        @Override
        public boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable) {
        	
        	//创建Select查询
            XmlElement select = new XmlElement("select");
            select.addAttribute(new Attribute("id", "selectAll"));
            select.addAttribute(new Attribute("resultMap", "BaseResultMap"));
            select.addAttribute(new Attribute("parameterType", introspectedTable.getBaseRecordType()));
            select.addElement(new TextElement("select * from "+ introspectedTable.getFullyQualifiedTableNameAtRuntime()));
    
            XmlElement queryPage = new XmlElement("select");
            queryPage.addAttribute(new Attribute("id", "queryPage"));
            queryPage.addAttribute(new Attribute("resultMap", "BaseResultMap"));
            queryPage.addAttribute(new Attribute("parameterType", "com.fendo.bean.Page"));
            queryPage.addElement(new TextElement("select * from "+ introspectedTable.getFullyQualifiedTableNameAtRuntime()));
            
            XmlElement parentElement = document.getRootElement();
            parentElement.addElement(select);
            parentElement.addElement(queryPage);
            return super.sqlMapDocumentGenerated(document, introspectedTable);
        }
    
        public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable) {
            JavaFormatter javaFormatter = context.getJavaFormatter();
            List<GeneratedJavaFile> mapperJavaFiles = new ArrayList<GeneratedJavaFile>();
            for (GeneratedJavaFile javaFile : introspectedTable.getGeneratedJavaFiles()) {
                CompilationUnit unit = javaFile.getCompilationUnit();
                FullyQualifiedJavaType baseModelJavaType = unit.getType();
    
                String shortName = baseModelJavaType.getShortName();
    
                GeneratedJavaFile mapperJavafile = null;
    
                if (shortName.endsWith("Mapper")) { // 扩展Mapper
                    if (stringHasValue(expandDaoTargetPackage)) {
                        Interface mapperInterface = new Interface(
                                expandDaoTargetPackage + "." + shortName.replace("Mapper", "ExpandMapper"));
                        mapperInterface.setVisibility(JavaVisibility.PUBLIC);
                        mapperInterface.addJavaDocLine("/**");
                        mapperInterface.addJavaDocLine(" * " + shortName + "扩展");
                        mapperInterface.addJavaDocLine(" */");
    
                        FullyQualifiedJavaType daoSuperType = new FullyQualifiedJavaType(expandDaoSuperClass);
                        mapperInterface.addImportedType(daoSuperType);
                        mapperInterface.addSuperInterface(daoSuperType);
    
                        mapperJavafile = new GeneratedJavaFile(mapperInterface, daoTargetDir, javaFormatter);
                        try {
                            File mapperDir = shellCallback.getDirectory(daoTargetDir, daoTargetPackage);
                            File mapperFile = new File(mapperDir, mapperJavafile.getFileName());
                            // 文件不存在
                            if (!mapperFile.exists()) {
                                mapperJavaFiles.add(mapperJavafile);
                            }
                        } catch (ShellException e) {
                            e.printStackTrace();
                        }
                    }
                } else if (!shortName.endsWith("Example")) { // CRUD Mapper
                    Interface mapperInterface = new Interface(daoTargetPackage + "." + shortName + "Mapper");
    
                    mapperInterface.setVisibility(JavaVisibility.PUBLIC);
                    mapperInterface.addJavaDocLine("/**");
                    mapperInterface.addJavaDocLine(" * MyBatis Generator工具自动生成");
                    mapperInterface.addJavaDocLine(" */");
    
                    FullyQualifiedJavaType daoSuperType = new FullyQualifiedJavaType(daoSuperClass);
                    // 添加泛型支持
                    daoSuperType.addTypeArgument(baseModelJavaType);
                    mapperInterface.addImportedType(baseModelJavaType);
                    mapperInterface.addImportedType(daoSuperType);
                    mapperInterface.addSuperInterface(daoSuperType);
    
                    mapperJavafile = new GeneratedJavaFile(mapperInterface, daoTargetDir, javaFormatter);
                    mapperJavaFiles.add(mapperJavafile);
    
                }
            }
            return mapperJavaFiles;
        }
    	
    }

**四、生成代码**

创建测试类:

import java.io.IOException;
    import java.io.InputStream;
    import java.net.URISyntaxException;
    import java.sql.SQLException;
    import java.util.ArrayList;
    import java.util.List;
    
    import org.mybatis.generator.api.MyBatisGenerator;
    import org.mybatis.generator.config.Configuration;
    import org.mybatis.generator.config.xml.ConfigurationParser;
    import org.mybatis.generator.exception.InvalidConfigurationException;
    import org.mybatis.generator.exception.XMLParserException;
    import org.mybatis.generator.internal.DefaultShellCallback;
    
    /**   
     * @Title: StartUp.java 
     * @Package com.fendo.mybatis_generator_plus 
     * @Description: mybatis-generator测试类
     * @author fendo
     * @date 2017年10月5日 下午3:53:17 
     * @version V1.0   
    */
    public class StartUp {
    
    	public static void main(String[] args) throws URISyntaxException {
            try {
                System.out.println("--------------------start generator-------------------");
                List<String> warnings = new ArrayList<String>();
                boolean overwrite = true;
                ClassLoader classloader = Thread.currentThread().getContextClassLoader();
                InputStream is = classloader.getResourceAsStream("generatorConfig.xml");
                ConfigurationParser cp = new ConfigurationParser(warnings);
                Configuration config = cp.parseConfiguration(is);
                DefaultShellCallback callback = new DefaultShellCallback(overwrite);
                MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
                myBatisGenerator.generate(null);
            	System.out.println("--------------------end generator-------------------");
            } catch (SQLException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            } catch (InterruptedException e) {
                e.printStackTrace();
            } catch (InvalidConfigurationException e) {
                e.printStackTrace();
            } catch (XMLParserException e) {
                e.printStackTrace();
            }
        }
    }

然后执行MBG，生成的代码结构如下:

![20171202194842386][]

生成的Healthyorder实体类默认继承了BaseModel

![20171202195048009][]

然后就是HealthyorderMapper映射文件,它默认是继承BaseMapper<Healthyorder>类，然后就可以使用BaseMapper里面的方法，生成的xml文件如下:

![20171202195451113][]

注意:

由于我这里直接是在源码里面改的，然后测试的，并没有打包成jar，运行的。

完整的源码:

[http://download.csdn.net/download/u011781521/10142189][http_download.csdn.net_download_u011781521_10142189]

[20171202194842386]: /images/20220604/16f994c0638a4489bc528d6c4c5aa0f7.png
[20171202195048009]: /images/20220604/8e54578ae4c441ba87eda8f31b24ea4a.png
[20171202195451113]: /images/20220604/80f0a89766de4adc88bc837fdb57399b.png
[http_download.csdn.net_download_u011781521_10142189]: http://download.csdn.net/download/u011781521/10142189