DataBase Access Layer(五):MyBatisGenerate生成自定义SQL方法

2016-08-11

为什么要生成自定义SQL

在文章动态SQL语句中，为了防止被拖库，有一句判断

1	<if test="id == null and username == null" >

用来判断所有参数为null的情况，这就会引出一个问题: 如果我有10个参数怎么办？

手动写10个 if判断 和 xx==null 和 and 岂不是要累死爹了。。。

自定义SQL插件

通过自定义SQL插件，我们可以对不同的表格产生具有相同的逻辑的SQL语句

如何自定义SQL插件

MyBatisGenerate提供了一个PluginAdapter的接口来完成自定义SQL语句操作

public class SelectPlugin extends PluginAdapter {

  private final static String METHOD_NAME = "select";

  public SelectPlugin() {
    super();  
  }

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

首先要有两个函数

一个构造函数
重写validate返回为true，如果为false，说明验证不通过，该插件就不会生成对应的SQL方法和XML映射

然后可以声明一个常量当作自定义接口函数名 METHOD_NAME

三个映射方法

根据文章MyBatis的核心思想我们知道MyBatis主要是3个映射，所以PluginAdapter就有3个函数分别控制三个映射的生成

//DO模型生成控制函数，一般模型生成不用自定义所以可以不用重写
@Override
public boolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
    return super.modelFieldGenerated(field, topLevelClass, introspectedColumn, introspectedTable, modelClassType);
}

//接口函数生成控制函数
@Override
public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
    interfaze.addMethod(generateSelectMethod(introspectedTable));<====调用自定义的生成方法
    return super.clientGenerated(interfaze, topLevelClass, introspectedTable);
}

//XML SQL语句生成控制函数
@Override
public boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable) {
    XmlElement parentElement = document.getRootElement();
    parentElement.addElement(generateSelectMapper(introspectedTable)); <====调用自定义的生成方法

    return super.sqlMapDocumentGenerated(document, introspectedTable);
}

具体的函数调用生命周期(顺序)可以参考MyBatisGenerate中文网，但是里面讲的不够具体，具体的可以去参考MyBatisGenerate源码GitHub中 mybatis-generator-core模块 的 org.mybatis.generator.plugins 包

看我的看不懂的话，强烈推荐去读源码，因为网上教材没有全的

自定义接口函数

这里Method并不是Java源生的反射类，而是处于 import org.mybatis.generator.api.dom.java.* 下的类

private Method generateSelectMethod(IntrospectedTable introspectedTable) {
    //方法名
    Method targetMethod = new Method(METHOD_NAME);
    //生成返回值 参数
    FullyQualifiedJavaType returnType = FullyQualifiedJavaType.getNewListInstance();
    FullyQualifiedJavaType listAndParameterType = new FullyQualifiedJavaType(introspectedTable.getBaseRecordType());
    returnType.addTypeArgument(listAndParameterType);
    //设置方法为public 设定返回值 设定参数
    targetMethod.setVisibility(JavaVisibility.PUBLIC);
    targetMethod.setReturnType(returnType);
    targetMethod.addParameter(new Parameter(listAndParameterType,"record"));
    //添加到Interface
    context.getCommentGenerator().addGeneralMethodComment(targetMethod,introspectedTable);
    return targetMethod;
}

自定义XML的SQL语句

同自定义接口函数里的Mthod，这里的大部分类也都是由 import org.mybatis.generator.api.dom.xml.* 提供的

private XmlElement generateSelectMapper(IntrospectedTable introspectedTable) {
    //获得表名
    String tableName = introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime();//数据库表名
    //设定方法节点属性
    String methodName = METHOD_NAME;
    String resultMap = introspectedTable.getBaseResultMapId();
    String paramterType = introspectedTable.getBaseRecordType();
    //方法节点生成
    XmlElement methodElement = new XmlElement("select");
    methodElement.addAttribute(new Attribute("id", methodName));
    methodElement.addAttribute(new Attribute("resultMap",resultMap));
    methodElement.addAttribute(new Attribute("parameterType",paramterType));
    //TRIM节点生成
    XmlElement trimElement = new XmlElement("trim");
    trimElement.addAttribute(new Attribute("prefix","WHERE"));
    trimElement.addAttribute(new Attribute("prefixOverrides","AND | OR"));
    //TRIM节点循环
    Iterator<IntrospectedColumn> iterator = introspectedTable.getAllColumns()
            .iterator();
    //Column名称字符串Builder
    StringBuilder methodTextStr = new StringBuilder();
    //最后全空检查字符串
    StringBuilder nullTestStr = new StringBuilder();
    while (iterator.hasNext()) {
        IntrospectedColumn introspectedColumn = iterator.next();
        //获取#{}参数 数据库表Cloumn名 DO模型成员变量的名
        String parameterName = MyBatis3FormattingUtilities.getParameterClause(introspectedColumn);
        String columnName = MyBatis3FormattingUtilities.getEscapedColumnName(introspectedColumn);
        String DOFieldName = introspectedColumn.getJavaProperty();
        //拼接COLUMN名
        methodTextStr.append(columnName);
        //全空检查字符串拼接
        nullTestStr.append(DOFieldName + " == null");
        if (iterator.hasNext()) {
            methodTextStr.append(", ");
            nullTestStr.append(" and ");
        }
        //TEST条件语句
        String testStr = DOFieldName + " != null";
        //IF节点拼接
        XmlElement ifElement = new XmlElement("if");
        TextElement ifTextElement = new TextElement("AND " + columnName + "=" + parameterName);
        ifElement.addAttribute(new Attribute("test",testStr));
        ifElement.addElement(ifTextElement);
        //TRIM节点拼接
        trimElement.addElement(ifElement);
    }
    //最后一个参数全空的IF
    TextElement ifTextElement = new TextElement("AND 1=0");
    XmlElement ifElement = new XmlElement("if");
    ifElement.addAttribute(new Attribute("test",nullTestStr.toString()));
    ifElement.addElement(ifTextElement);
    trimElement.addElement(ifElement);

    //方法节点拼接
    TextElement methodTextElementFirst = new TextElement("select " + methodTextStr.toString());
    TextElement methodTextElementSecond = new TextElement("from " + tableName);

    methodElement.addElement(methodTextElementFirst);
    methodElement.addElement(methodTextElementSecond);
    methodElement.addElement(trimElement);

    return methodElement;
}