GenericMapperPlugin.java

package com.revengemission.plugins.mybatis;


import org.mybatis.generator.api.GeneratedJavaFile;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.JavaFormatter;
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;
import org.slf4j.LoggerFactory;

import java.io.BufferedReader;
import java.io.File;
import java.io.InputStreamReader;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * 自定义查询、更新，生成单独的 mapper 文件
 * 在启用Mybatis cache的情况下，会有缓存不同步问题，此时建议使用【MybatisCustomSqlPlugin】
 */
public class GenericMapperPlugin extends AbstractXmbgPlugin {

    private static final org.slf4j.Logger log = LoggerFactory.getLogger(GenericMapperPlugin.class);

    private String mapperName = "GenericMapper";
    private String queryForMapMethodName = "queryForMap";
    private String queryForListMethodName = "queryForList";
    private String queryForObjectMethodName = "queryForObject";
    private String updateMethodName = "update";
    private boolean withMapperAnnotation = true;
    private String encoding = "UTF-8";
    private String pluginPackageRelativePath = "com/revengemission/plugins/mybatis/";


    @Override
    public void initialized(IntrospectedTable introspectedTable) {
        String javaFileEncoding = introspectedTable.getContext().getProperties().getProperty("javaFileEncoding");
        if (javaFileEncoding != null && !javaFileEncoding.trim().isEmpty()) {
            encoding = javaFileEncoding;
        }
        for (Map.Entry<Object, Object> entry : properties.entrySet()) {
            if ("withMapperAnnotation".equalsIgnoreCase(entry.getKey().toString().trim())) {
                withMapperAnnotation = Boolean.parseBoolean(entry.getValue().toString().trim());
                break;
            }
        }

        createJavaFile("DynamicSqlSourceX");
        createJavaFile("XMLScriptBuilderX");
        createJavaFile("MatchAnyLanguageDriver");
    }

    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }

    @Override
    public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles() {
        FullyQualifiedJavaType mapTypeString = new FullyQualifiedJavaType("Map<String, Object>");
        FullyQualifiedJavaType linkedHashMapTypeString = new FullyQualifiedJavaType("LinkedHashMap<String, Object>");
        FullyQualifiedJavaType listMapTypeString = new FullyQualifiedJavaType("List<LinkedHashMap<String, Object>>");
        JavaFormatter javaFormatter = context.getJavaFormatter();
        FullyQualifiedJavaType interfaceType = new FullyQualifiedJavaType(context.getJavaClientGeneratorConfiguration().getTargetPackage() + "." + mapperName);
        Interface anInterface = new Interface(interfaceType);
        anInterface.setVisibility(JavaVisibility.PUBLIC);

        FullyQualifiedJavaType langJavaType = new FullyQualifiedJavaType("org.apache.ibatis.annotations.Lang");
        anInterface.addImportedType(langJavaType);
        if (withMapperAnnotation) {
            FullyQualifiedJavaType mapperJavaType = new FullyQualifiedJavaType("org.apache.ibatis.annotations.Mapper");
            anInterface.addImportedType(mapperJavaType);
            anInterface.addAnnotation("@Mapper");
        }
        FullyQualifiedJavaType selectJavaType = new FullyQualifiedJavaType("org.apache.ibatis.annotations.Select");
        anInterface.addImportedType(selectJavaType);

//        FullyQualifiedJavaType updateJavaType = new FullyQualifiedJavaType("org.apache.ibatis.annotations.Update");
//        anInterface.addImportedType(updateJavaType);

        anInterface.addImportedType(new FullyQualifiedJavaType("java.util.LinkedHashMap"));
        anInterface.addImportedType(new FullyQualifiedJavaType("java.util.Map"));
        anInterface.addImportedType(FullyQualifiedJavaType.getNewListInstance());

        Method queryForMapMethod = new Method(queryForMapMethodName);
        queryForMapMethod.setAbstract(true);
        queryForMapMethod.addParameter(new Parameter(mapTypeString, "paramsMapWithSql"));
        queryForMapMethod.setReturnType(linkedHashMapTypeString);
        queryForMapMethod.addAnnotation("@Select(\"<script><select>不需要修改这一行！paramsMapWithSql 中放入sql 语句以及需要的占位符参数</select></script>\")");
        queryForMapMethod.addAnnotation("@Lang(MatchAnyLanguageDriver.class)");
        anInterface.addMethod(queryForMapMethod);

        Method queryForListMethod = new Method(queryForListMethodName);
        queryForListMethod.setAbstract(true);
        queryForListMethod.addParameter(new Parameter(mapTypeString, "paramsMapWithSql"));
        queryForListMethod.setReturnType(listMapTypeString);
        queryForListMethod.addAnnotation("@Select(\"<script><select>不需要修改这一行！paramsMapWithSql 中放入sql 语句以及需要的占位符参数</select></script>\")");
        queryForListMethod.addAnnotation("@Lang(MatchAnyLanguageDriver.class)");
        anInterface.addMethod(queryForListMethod);

        Method queryForObjectMethod = new Method(queryForObjectMethodName);
        queryForObjectMethod.setAbstract(true);
        queryForObjectMethod.addParameter(new Parameter(mapTypeString, "paramsMapWithSql"));
        queryForObjectMethod.setReturnType(FullyQualifiedJavaType.getObjectInstance());
        queryForObjectMethod.addAnnotation("@Select(\"<script><select>不需要修改这一行！paramsMapWithSql 中放入sql 语句以及需要的占位符参数</select></script>\")");
        queryForObjectMethod.addAnnotation("@Lang(MatchAnyLanguageDriver.class)");
        anInterface.addMethod(queryForObjectMethod);

//        Method updateMethod = new Method(updateMethodName);
//        updateMethod.setAbstract(true);
//        updateMethod.addParameter(new Parameter(mapTypeString, "paramsMapWithSql"));
//        updateMethod.setReturnType(FullyQualifiedJavaType.getIntInstance());
//        updateMethod.addAnnotation("@Update(\"<script><update>不需要修改这一行！paramsMapWithSql 中放入sql 语句以及需要的占位符参数</update></script>\")");
//        updateMethod.addAnnotation("@Lang(MatchAnyLanguageDriver.class)");
//        anInterface.addMethod(updateMethod);

        GeneratedJavaFile generatedJavaFile = new GeneratedJavaFile(anInterface, context.getJavaClientGeneratorConfiguration().getTargetProject(), encoding, javaFormatter);
        List<GeneratedJavaFile> answer = new ArrayList<>(16);
        answer.add(generatedJavaFile);
        return answer;
    }

    /**
     * 根据txt文件生成java文件
     *
     * @param txtFileName txt文件名和java文件名
     */
    void createJavaFile(String txtFileName) {
        String currentPath = System.getProperty("user.dir");
        String targetProject = context.getJavaClientGeneratorConfiguration().getTargetProject();
        String targetPackage = context.getJavaClientGeneratorConfiguration().getTargetPackage();
        Path targetClassFilePath = Paths.get(currentPath, targetProject, targetPackage.replace(".", File.separator));
        log.info("targetClassFilePath:{}", targetClassFilePath.toString());
        try {
            if (!Files.exists(targetClassFilePath)) {
                Files.createDirectories(targetClassFilePath);
            }
            StringBuffer buffer = new StringBuffer();
            String line = "";
            BufferedReader in = new BufferedReader(new InputStreamReader(this.getClass().getClassLoader().getResourceAsStream(pluginPackageRelativePath + txtFileName + ".txt"), encoding));
            while ((line = in.readLine()) != null) {
                buffer.append(line);
                buffer.append("\r\n");
            }
            String input = buffer.toString();

            Files.write(Paths.get(targetClassFilePath.toString(), txtFileName + ".java"), ("package " + context.getJavaClientGeneratorConfiguration().getTargetPackage() + ";\r\n").getBytes(encoding), StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);

            Files.write(Paths.get(targetClassFilePath.toString(), txtFileName + ".java"), input.getBytes(encoding), StandardOpenOption.CREATE, StandardOpenOption.APPEND);

        } catch (Exception e) {
            log.error("读取、写入文件错误：", e);
        }

    }


}