enhanced.mybaits.generator.codegen.AbstractMapperTestsMethodGenerator Maven / Gradle / Ivy

Go to download

package enhanced.mybaits.generator.codegen;

import enhanced.mybaits.generator.MixedContext;
import org.apache.commons.lang3.StringUtils;
import org.mybatis.generator.api.CommentGenerator;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.JavaVisibility;
import org.mybatis.generator.api.dom.java.Method;

import java.util.List;

/**
 * 增Java Mapper 测试类方法生成器基类
 * @author 徐明龙 XuMingLong 
 */
public abstract class AbstractMapperTestsMethodGenerator extends AbstractMethodGenerator {
    
    /**
     * 测试类中注入的被测试的Mapper对象
     * @author 徐明龙 XuMingLong 
     */
    protected Field testedMapperField;
    
    /**
     * 被测试的方法
     * @author 徐明龙 XuMingLong 
     */
    protected Method testedMethod;
    
    
    public AbstractMapperTestsMethodGenerator(MixedContext mixedContext) {
        super(mixedContext);
        // 设置测试类中注入的被测试的Mapper对象
        setTestedMapperField();
    }

    /**
     * 设置被测试的方法
     * @author 徐明龙 XuMingLong 
     */
    protected abstract void setTestedMethod();

    
    /**
     * 增加方法注解
     * @author 徐明龙 XuMingLong
     * @param method 待处理的方法
     */
    protected void addMethodAnnotations(Method method) {
        method.addAnnotation("@Test");
    }
    
    /**
     * 增加测试的引入
     * @author 徐明龙 XuMingLong 
     */
    protected void addTestsClassImport() {
        mixedContext.getTestsClass().addImportedType("org.junit.jupiter.api.Test");
    }
    
    /**
     * 设置引入的被测试Mapper的
     * @author 徐明龙 XuMingLong 2018-11-26 
     */
    protected void setTestedMapperField() {
        List list = mixedContext.getTestsClass().getFields();
        for(Field r: list) {
            if(r.getType().equals(mixedContext.getMapper().getType())) {
               this.testedMapperField =  r;
            }
        }
    }
    
    /**
     * 增加测试类对应的测试方法
     * @author 徐明龙 XuMingLong 
     */
    @Override
    public void addMethod() {
        //设置被测试的方法
        setTestedMethod();
        if(testedMethod==null) {
            return;
        }
        Method method = new Method(String.join("", "test",StringUtils.capitalize(testedMethod.getName())));
        method.setVisibility(JavaVisibility.PUBLIC);
        //增加方法的注解及引入
        addMethodAnnotations(method);
        addTestsClassImport();
        //增加测试方法内容
        addMethodBody(method);
        //生成注释
        IEnhanceCommentGenerator enhanceCommentGenerator = null ;
        CommentGenerator commentGenerator = context.getCommentGenerator();
        if(commentGenerator instanceof IEnhanceCommentGenerator) {
            enhanceCommentGenerator = (IEnhanceCommentGenerator) commentGenerator;
            enhanceCommentGenerator.addMapperTestsMethodComment(method);
        }
        mixedContext.getTestsClass().addMethod(method);
        
    }
    
    /**
     * 增加测试方法内容
     * @author 徐明龙 XuMingLong 
     * @param method 待处理的方法
     */
    protected abstract void addMethodBody(Method method) ;
}