自己写的一个MyBatis Generator Plugin，支持MySQL分页

MyBatis Generator，由于其不支持分页，所以就想写一个针对MySQL可以生成支持分页代码的Plugin，在网上找到了一个http://blog.csdn.net/firecoder/article/details/6069434，运行了一下发现有Example类是把属性都加上去了，但是Provider相关的代码并没有生成，仔细看了下这个实现，发现原因是这个实现只针对XML方式的SQLMAP处理函数做了重写（加入分页相关的内容），而在我的应用里面用的是注解的方式使用的MyBatis。 所以我在这个基础上做了些修改：

1）增加对Provider代码生成情况下分页的支持；

2）增加了Example对offset，Rows两个属性自定义（考虑到有些懒人希望和某个框架的属性能够直接对应上）

3)  增加了includes/excludes的支持：并不是所有的表都需要支持分页（只是展现相关的表需要）

 

详细的不解释了，没什么难度，参见代码注释，配置方式可以参考http://blog.csdn.net/firecoder/article/details/6069434，解释的比较详细，代码的实现也没什么难度，共享出来，有兴趣的同学可以拿去用。

（花了一上午的时间，刚刚弄好，做了简单测试，可能有Bug，有问题可以联系我，或自行修改）

 

/**
 * MyBatis-Generator的Plugin，支持XML和SQL Provider（注解的方式），支持如下功能
 * <ol>
 *    <li>生成基于MySQL数据库的分页查询：Example里面添加了offset & rows两个属性</li>
 *    <li>offset&rows 两个属性是可以自定义的在Plugin property里面定义customOffsetName&icustomRowsName这两个属性即可；</li>
 *    <li>针对生成的表进行includes,exludes定义，对于排除在外的表，不会生成分页的支持代码</li>
 * <ol>
 * 
 * 其中一部分代码来源于网上，<a href="http://blog.csdn.net/firecoder/article/details/6069434"> CSDN的作者</a>
 * <p>SQLProvider部分以及功能支持等是作者自行开发的。
 * 
 * <p><b>[运行方式]</b>
 * <pre>
 *    . 安装Eclipse Mybatis generator Plugin：具体请参见 https://code.google.com/p/mybatis/wiki/Generator
 *      (实际上也可以独立运行，然后在Eclipse里面配置一个External Tool即可，也比较方便）
 *    . 在MyBatis-Gernator目录下，配置本Plugin，具体例子请参见包内容的mybatis-gerator.xml
 *    . POM 文件添加对mybatis-generator plugin的引用，Scope为test
 *        (或者在Classpath Entry将本Plugin加入到Classpath里面
 *    . 运行Generator.
 * </pre>
 * 
 * @author 明旭
 * 
 */
public class PaginationSupportedPlugin extends PluginAdapter {
    private String customOffsetName = "offset";

    private String customRowsName = "rows";
    
    /**
     * 包含的在内的表(会生成Limit）
     * 
     */
    private String[] includes = new String[0];
    
    /**
     * 排除在外的表（不会生成LImit）
     * 
     */
    private String[] excludes = new String[0];


    /**
     * 自定义setProperties的过程，取出自定义属性
     */
    public void setProperties(Properties properties) {
        super.setProperties(properties);
        if (properties.containsKey("customOffsetName")) {
            this.customOffsetName = properties.getProperty("customOffsetName");
        }
        if (properties.containsKey("customRowsName")) {
            this.customRowsName = properties.getProperty("customRowsName");
        }
        
        if(properties.containsKey("includes")) {
            this.includes = properties.getProperty("includes").split(",");
        }
        
        if(properties.containsKey("excludes")) {
            this.excludes = properties.getProperty("excludes").split(",");
        }
    }

    @Override
    public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        if(!this.shouldAppendLimit(introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime())) return true;
        
        // add field, getter, setter for limit clause
        addLimit(topLevelClass, introspectedTable, this.customOffsetName);
        addLimit(topLevelClass, introspectedTable, this.customRowsName);
        return true;
    }
    
    /**
     * 修改SQLMAP XML的生成属性（将offset/rows加入到属性之中）
     */
    @Override
    public boolean sqlMapSelectByExampleWithBLOBsElementGenerated(
            XmlElement element, IntrospectedTable introspectedTable) {
        
        return this.sqlMapSelectByExampleWithoutBLOBsElementGenerated(element, introspectedTable);
    }

    /**
     * 修改SQLMAP XML的生成属性（将offset/rows加入到属性之中）
     */
    @Override
    public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element,
            IntrospectedTable introspectedTable) {
        if(!this.shouldAppendLimit(introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime())) return true;
        
        StringBuilder limitBuilder = new StringBuilder();
        limitBuilder.append("limit $").append(this.customOffsetName).append("$, $").append(this.customRowsName)
                .append('$');

        XmlElement isParameterPresenteElemen = (XmlElement) element.getElements().get(element.getElements().size() - 1);
        XmlElement isNotNullElement = new XmlElement("isGreaterEqual");
        isNotNullElement.addAttribute(new Attribute("property", this.customOffsetName));
        isNotNullElement.addAttribute(new Attribute("compareValue", "0"));
        isNotNullElement.addElement(new TextElement(limitBuilder.toString()));
        isParameterPresenteElemen.addElement(isNotNullElement);
        return super.sqlMapUpdateByExampleWithoutBLOBsElementGenerated(element, introspectedTable);
    }
    
    /**
     *  修改SQLProvider的生成属性，用在使用注解的方式生成DAO时（SQLProvider）
     * 
     */
    @Override
    public boolean providerSelectByExampleWithoutBLOBsMethodGenerated(
            Method method, TopLevelClass topLevelClass,
            IntrospectedTable introspectedTable) {
        if(!this.shouldAppendLimit(introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime())) return true;
        
        return this.appendLimitForProvider(method);
    }

    /**
     * 修改SQLProvider的生成属性，用在使用注解的方式生成DAO时（SQLProvider）
     */
    @Override
    public boolean providerSelectByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass,
            IntrospectedTable introspectedTable) {
        if(!this.shouldAppendLimit(introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime())) return true;
        
        return this.appendLimitForProvider(method);
    }
    
    private boolean appendLimitForProvider(Method method) {

        List<String> lines = method.getBodyLines();
        lines.remove(lines.size() - 1); // 去掉最后一行return SQL(); 替换成如下方式的：
        
        //if(example.getOffset() > -1 && example.getRows > -1) {
        StringBuilder line1 = new StringBuilder();
        line1.append("if(example.get")
            .append(Character.toUpperCase(this.customOffsetName.charAt(0)))
            .append(this.customOffsetName.substring(1))
            .append("() > -1 && example.get")
            .append(Character.toUpperCase(this.customRowsName.charAt(0)))
            .append(this.customRowsName.substring(1)).append("() > 0) {");
            
        //return SQL() + "limit" + example.getOffset() + ',' example.getRows
        StringBuilder line2 = new StringBuilder();
        line2.append("return SQL() + \" limit \" + example.get")
            .append(Character.toUpperCase(this.customOffsetName.charAt(0)))
            .append(this.customOffsetName.substring(1))
            .append("()+ \",\" + example.get")
            .append(Character.toUpperCase(this.customRowsName.charAt(0)))
            .append(this.customRowsName.substring(1)).append("();");
        
        lines.add(line1.toString());
        lines.add(line2.toString());
        lines.add("}");
        lines.add("return SQL();");

        return true;
    }

    private void addLimit(TopLevelClass topLevelClass, IntrospectedTable introspectedTable, String name) {
        CommentGenerator commentGenerator = context.getCommentGenerator();
        Field field = new Field();
        field.setVisibility(JavaVisibility.PROTECTED);
        field.setType(FullyQualifiedJavaType.getIntInstance());
        field.setName(name);
        field.setInitializationString("-1");
        commentGenerator.addFieldComment(field, introspectedTable);
        topLevelClass.addField(field);
        char c = name.charAt(0);
        String camel = Character.toUpperCase(c) + name.substring(1);
        Method method = new Method();
        method.setVisibility(JavaVisibility.PUBLIC);
        method.setName("set" + camel);
        method.addParameter(new Parameter(FullyQualifiedJavaType.getIntInstance(), name));
        method.addBodyLine("this." + name + "=" + name + ";");
        commentGenerator.addGeneralMethodComment(method, introspectedTable);
        topLevelClass.addMethod(method);
        method = new Method();
        method.setVisibility(JavaVisibility.PUBLIC);
        method.setReturnType(FullyQualifiedJavaType.getIntInstance());
        method.setName("get" + camel);
        method.addBodyLine("return " + name + ";");
        commentGenerator.addGeneralMethodComment(method, introspectedTable);
        topLevelClass.addMethod(method);
    }
    
    /**
     * 检查是否应该加入分页相关的信息。
     * <pre>
     * . 在Exclude列表里面，不会生成；
     * . includes没有配置，都会生成；
     * . 配置了includes，按照includes规则生成
     * </pre>
     * 
     */
    private boolean shouldAppendLimit(String tableName) {
        if(this.checkExists(tableName, excludes)) {
            return false;
        }
        
        if(this.includes.length < 1) {
            return true;
        }
        
        return this.checkExists(tableName, includes);
    }
    
    
    private boolean checkExists(String tableName, String[] collection) {
        for(String i : collection) {
            if(i.equalsIgnoreCase(tableName)) {
                return true;
            }
        }
        
        return false;
    }

    /**
     * This plugin is always valid - no properties are required
     */
    public boolean validate(List<String> warnings) {
        return true;
    }

    public static void generate() {
        String config = PaginationSupportedPlugin.class.getClassLoader().getResource("mybatis-generator.xml").getFile();
        String[] arg = {
            "-configfile", config, "-overwrite"};
        ShellRunner.main(arg);
    }

    public static void main(String[] args) {
        generate();
    }
}