1. 程式人生 > >mybatis generator dao擴充套件

mybatis generator dao擴充套件

當我使用外掛來mybatis-paginator解決mybatis的分頁問題時,我需要在mybatis generator外掛生成的dao程式碼中加上下面的程式碼,這就涉及到mybatis generator原始碼的改造
PageList<AbmEmployee> selectByExample(AbmEmployeeExample example,PageBounds pageBounds);
分頁外掛的pom

<dependency>
    <groupId>com.github.miemiedev</groupId>
    <artifactId
>
mybatis-paginator</artifactId> </dependency>

第一步
org.mybatis.generator.api.dom.java.FullyQualifiedJavaType中新增

/**
     * 增加分頁的list
     * @author dzm at 2016-10-20
     * @return
     */
    public static final FullyQualifiedJavaType getNewPageListInstance(){
        return new FullyQualifiedJavaType("com.github.miemiedev.mybatis.paginator.domain.PageList"
); }

第二步
org.mybatis.generator.api.DAOMethodNameCalculator中新增

String getSelectByExampleWithoutBLOBsPagingMethodName(IntrospectedTable introspectedTable);

org.mybatis.generator.internal.DefaultDAOMethodNameCalculator中新增

/**
     * 分頁查詢
     * @author dzm
     */
    @Override
    public String getSelectByExampleWithoutBLOBsPagingMethodName
( IntrospectedTable introspectedTable) { return "selectByExample"; }

org.mybatis.generator.internal.ExtendedDAOMethodNameCalculator中新增

/**
     * @author dzm
     */
    @Override
    public String getSelectByExampleWithoutBLOBsPagingMethodName(
            IntrospectedTable introspectedTable) {
        return getSelectByExampleWithoutBLOBsMethodName(introspectedTable);
    }

第三步
org.mybatis.generator.internal.rules.Rules中新增生成規則

/**
     * 產生帶分頁的selectByExample
     * @return
     */
    boolean generateSelectByExampleWithoutBLOBsPaging();

org.mybatis.generator.internal.rules.BaseRules中新增實現

@Override
    public boolean generateSelectByExampleWithoutBLOBsPaging() {
        return true;
    }

org.mybatis.generator.internal.rules.RulesDelegate中新增

@Override
    public boolean generateSelectByExampleWithoutBLOBsPaging() {
        return rules.generateSelectByExampleWithoutBLOBsPaging();
    }

第四步
org.mybatis.generator.codegen.mybatis3.javamapper.elements中新增類

import static org.mybatis.generator.internal.util.messages.Messages.getString;

import java.util.Set;
import java.util.TreeSet;

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.java.Method;
import org.mybatis.generator.api.dom.java.Parameter;


/**
 * 分頁的selectByExample
 * 示例如下:
 *   PageList<IcstFaq> selectByExample(IcstFaqExample example,PageBounds pageBounds);
 * @author dzm
 *
 */
public class SelectByExampleWithoutBLOBsMethodPagingGenerator extends AbstractJavaMapperMethodGenerator{

    public SelectByExampleWithoutBLOBsMethodPagingGenerator(){
        super();
    }


    @Override
    public void addInterfaceElements(Interface interfaze) {
        Set<FullyQualifiedJavaType> importedTypes = new TreeSet<FullyQualifiedJavaType>();
        FullyQualifiedJavaType type = new FullyQualifiedJavaType(
                introspectedTable.getExampleType());
        importedTypes.add(type);
        importedTypes.add(FullyQualifiedJavaType.getNewPageListInstance());

        Method method = new Method();
        method.setVisibility(JavaVisibility.PUBLIC);

        FullyQualifiedJavaType returnType = FullyQualifiedJavaType
                .getNewPageListInstance();
        FullyQualifiedJavaType listType;
        if (introspectedTable.getRules().generateBaseRecordClass()) {
            listType = new FullyQualifiedJavaType(introspectedTable.getBaseRecordType());
        } else if (introspectedTable.getRules().generatePrimaryKeyClass()) {
            listType = new FullyQualifiedJavaType(introspectedTable.getPrimaryKeyType());
        } else {
            throw new RuntimeException(getString("RuntimeError.12")); //$NON-NLS-1$
        }

        importedTypes.add(listType);
        returnType.addTypeArgument(listType);
        method.setReturnType(returnType);

        method.setName(introspectedTable.getSelectByExampleStatementId());
        method.addParameter(new Parameter(type, "example")); //$NON-NLS-1$

        // 新增分頁引數
        FullyQualifiedJavaType pagingType = new FullyQualifiedJavaType("com.github.miemiedev.mybatis.paginator.domain.PageBounds");
        importedTypes.add(pagingType);// import com.github.miemiedev.mybatis.paginator.domain.PageBounds
        method.addParameter(new Parameter(pagingType, "pageBounds")); 

        context.getCommentGenerator().addGeneralMethodComment(method,
                introspectedTable);

        addMapperAnnotations(interfaze, method);

        if (context.getPlugins()
                .clientSelectByExampleWithoutBLOBsMethodGenerated(method,
                        interfaze, introspectedTable)) {
            interfaze.addImportedTypes(importedTypes);
            interfaze.addMethod(method);
        }
    }

    public void addMapperAnnotations(Interface interfaze, Method method) {
        return;
    }
}

更改org.mybatis.generator.codegen.mybatis3.javamapper.JavaMapperGenerator中的實現
getCompilationUnits方法中新增

addSelectByExampleWithoutBLOBsPagingMethod(interfaze);

另外新增方法

/**
     * 新增帶分頁的selectByExample
     * @author dzm
     * @param interfaze
     */
    protected void addSelectByExampleWithoutBLOBsPagingMethod(Interface interfaze){
        if (introspectedTable.getRules().generateSelectByExampleWithoutBLOBsPaging()){
            AbstractJavaMapperMethodGenerator methodGenerator = new SelectByExampleWithoutBLOBsMethodPagingGenerator();
            initializeAndExecuteGenerator(methodGenerator, interfaze);
        }
    }