自定义MyBatis Generator Plugin

【原创文章,转载请注明原文章地址,谢谢!】

Paste_Image.png

现在可以自定来定义一个MyBatis Generator Plugin了,我们从什么功能下手呢?在我们平时基于MySQL的数据库对应的mapper.xml映射文件中,在insert元素上,我们往往会定义

keyColumn="id" keyProperty="id" useGeneratedKeys="true"

这三个参数,在MBG中,这是可以配置的,就是在每一个table元素中使用


来生成。但是如果每一个表单都要重新定义一次这个元素还是挺讨厌的,所以我们可以做一个Plugin,为所有的table的mapper.xml中的insert语句都添加这个配置。当然,这样做会过于死板了,所以我们也支持,如果在table元素中配置了


属性的话,我们就忽略;
在写插件之前,我们先考虑好插件的用法。首先这个插件是不需要参数的,即可以直接这样配置:


然后,生成的mapper.xml文件会是这样:


如果在table中这样配置:



那么我们的插件就忽略keyColumn;keyProperty和useGeneratedKeys三个属性的生成;

OK,插件目标定义好之后,就可以完成插件:

public class UseGeneratedKeysPlugin extends PluginAdapter {

首先我们的插件还是继承PluginAdapter,因为要针对每一个mapper.xml的insert语句的生成,所以,我们选择实现

public boolean sqlMapInsertSelectiveElementGenerated(XmlElement element,
        IntrospectedTable introspectedTable) {

方法。这个方法先空着,待会实现。

private static final String USEGENERATEDKEYS = "useGeneratedKeys";
private static final String KEYCOLUMN = "keyColumn";
private static final String KEYPROPERTY = "keyProperty";
private static final String IS_GEN_USEGENERATEDKEYS = "my.isgen.usekeys";

首先定义好需要用到的静态字符串常量;

public boolean validate(List warnings) {
    return true;
}

因为我们的插件没有参数,所以验证方法直接返回true;

/**
 * 该方法在每一个mapper.xml文件的insert节点生成是调用,我们要做的就是判断是否要插入三个属性,
 * 如果需要插入,就往XmlElement添加三个元素即可;
 */
public boolean sqlMapInsertSelectiveElementGenerated(XmlElement element,
        IntrospectedTable introspectedTable) {
    //定义是否需要生成三个属性
    boolean isGen = true;
    //调用getTableConfigurationProperty方法,得到在当前这个table中定义的property元素
    //直接去尝试获取my.isgen.usekeys property;
    String isGenStr = introspectedTable
            .getTableConfigurationProperty(IS_GEN_USEGENERATEDKEYS);
    //如果得到了值,就尝试转化成boolean
    if (StringUtility.stringHasValue(isGenStr)) {
        isGen = Boolean.valueOf(isGenStr);
    }
    //如果需要生成参数
    if (isGen) {
        // 要使用usegeneratedkeys只能有一个主键,并且主键的类型必须是数字类型;
        //通过introspectedTable的getPrimaryKeyColumns方法得到解析出来数据库中的主键列;
        //因为主键列可能是多个,所以返回的是List
        List keyColumns = introspectedTable
                .getPrimaryKeyColumns();
        IntrospectedColumn keyColumn = null;
        //对于usegeneratedkeys来说,只能有一个主键列;
        if (keyColumns.size() == 1) {
            //得到这个唯一的主键列
            keyColumn = keyColumns.get(0);
            //得到这个列映射成Java模型之后的属性对应的Java类型;
            FullyQualifiedJavaType javaType = keyColumn
                    .getFullyQualifiedJavaType();
            //usegeneratedkeys要求主键只能是递增的,所以我们把这个主键属性的类型分别和Integer,Long,Short做对比;
            if (javaType.equals(PrimitiveTypeWrapper.getIntegerInstance())
                    || javaType.equals(PrimitiveTypeWrapper
                            .getLongInstance())
                    || javaType.equals(PrimitiveTypeWrapper
                            .getShortInstance())) {
                //如果是Integer,Long,Short三个类型中的而一个;则添加属性;
                //因为我们要添加的属性就是insert元素上的,而insert元素就是根节点,所以element就是insert元素;
                element.addAttribute(new Attribute(USEGENERATEDKEYS, "true"));
                //通过IntrospectedColumn的getActualColumnName得到列中的名称,用于生成keyColumn属性;
                element.addAttribute(new Attribute(KEYCOLUMN, keyColumn
                        .getActualColumnName()));
                //通过IntrospectedColumn的getJavaProperty方法得到key在Java对象中的属性名,用于生成keyProperty属性
                element.addAttribute(new Attribute(KEYPROPERTY, keyColumn
                        .getJavaProperty()));
            }
        }
    }
    //打完收工
    return true;
}

整个插件就完成了,接下来就是使用这个插件,这里简单提一句,比如我使用的是Mybatis Generator maven plugin来生成的,所以我需要把我自定义的插件所在的项目使用mvn install先打包,然后在要生成的具体项目的pom文件中添加:


            org.mybatis.generator
            mybatis-generator-maven-plugin
            1.3.0
            
                true
            
            
                
                    org.mybatis
                    mybatis
                    3.3.0
                
                
                    org.mybatis.generator
                    mybatis-generator-core
                    1.3.2
                
                
                    mysql
                    mysql-connector-java
                    5.1.21
                
                
                
                    com._520it
                    mybatis-plugins
                    1.0.0
                
            
        

这样再使用mvn mybatis-generator:generate就可以了;

至此,MBG简单的通过Plugin的扩展机制就完成了,接下来就是通过extends的方式扩展MGB,和MBG的代码结构分析了。

你可能感兴趣的:(自定义MyBatis Generator Plugin)