Mybatis Generator Plugin 定制我需要的D

在上一篇文章我的Spring多数据源中提到对Mybatis Generator Plugin的开发改造，今天就上次示例中的一些细节点做一些描述介绍。

首先，先要理解Mybatis Generator Plugin，建议先阅读 小码哥Java学院 的 理解MyBatis Generator Plugin。
同样，在 http://generator.sturgeon.mopaas.com/reference/pluggingIn.html 也有详细的介绍，相信看了这些资料，对于Mybatis Generator Plugin 插件的理解和开发已经不是什么困难的事情了。

那么接下来就上文中的分页参数的使用以及多数据源注解的自动生成做一些介绍。
PS：本文使用的是注解方式，如果使用XMLMAPPER方式的本文仅供参考，其实大同小异并没太大区别。

创建自己的插件 —— MysqlGeneratorPlug

1、继承PluginAdapter

  public class MysqlGeneratorPlug extends PluginAdapter 

2、为Example添加分页参数offset、limit、resultColumn属性。resultColumn属性使用在当查询数据我们并不需要全表返回而是个别几个字段的时候使用，如 SELECT id,name,age FROM user_base 这种情况下。

@Overridepublic boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {    
  addLimit(topLevelClass, introspectedTable, "offset");    
  addLimit(topLevelClass, introspectedTable, "limit");    
  addResultColumn(topLevelClass, introspectedTable, "resultColumn");    
  return super.modelExampleClassGenerated(topLevelClass, introspectedTable);
}

private void addLimit(TopLevelClass topLevelClass, IntrospectedTable introspectedTable, String name) {
    CommentGenerator commentGenerator = getContext().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);
}

private void addResultColumn(TopLevelClass topLevelClass, IntrospectedTable introspectedTable, String name) {
    CommentGenerator commentGenerator = getContext().getCommentGenerator();
    Field field = new Field();
    field.setVisibility(JavaVisibility.PROTECTED);
    field.setType(FullyQualifiedJavaType.getStringInstance());
    field.setName(name);
    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.getStringInstance(), name));
    method.addBodyLine("this." + name + "=" + name + ";");
    commentGenerator.addGeneralMethodComment(method, introspectedTable);
    topLevelClass.addMethod(method);    method = new Method();
    method.setVisibility(JavaVisibility.PUBLIC);
    method.setReturnType(FullyQualifiedJavaType.getStringInstance());
    method.setName("get" + camel);
    method.addBodyLine("return " + name + ";");
    commentGenerator.addGeneralMethodComment(method, introspectedTable);
    topLevelClass.addMethod(method);
}

Paste_Image.png

如上，offset、limit以及resultColumn 属性以及get、set 方法均以创建完成。
那么接下来需要在对应的SqlProvider中使其起作用，则需要修改对应的实现方法。

参照下原版生成出来的 countByExample

Paste_Image.png

原版生成的selectByExample

Paste_Image.png

很显然这样使用并不方便，select 返回了所有的字段，而且也没有分页 可用性并不强，而需要改造的，也只是将我们需要查询的字段传递进来，以及增加分页功能而已。理解了原版生成的规则，我们就可以开始定制我们所需要的功能。

修改countByExample，是其增加指定列以及分页功能（其实count为什么要加上分页我也不明白，只是顺手而已 ^_）

@Overridepublic boolean providerCountByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
    List<String> bodyLines = method.getBodyLines();
    //将原有第二句更改为 如果列名不为空，则使用列名   否则为 *    String sql = bodyLines.get(1);
    sql = sql.replace("*", "\" + (example.getResultColumn() == null || example.getResultColumn().isEmpty() ? \"*\" : example.getResultColumn()) + \"");
    bodyLines.set(1, sql);
    addLimit(bodyLines);
    return super.providerCountByExampleMethodGenerated(method, topLevelClass, introspectedTable);
}

修改selectByExample

@Overridepublic boolean providerSelectByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
    List<String> bodyLines = method.getBodyLines();
    repleaseSelectColumn(bodyLines);
    addLimit(bodyLines);
    return super.providerSelectByExampleWithoutBLOBsMethodGenerated(method, topLevelClass, introspectedTable);
}

private void addLimit(List<String> bodyLines) {
    int lastIndex = bodyLines.size() - 1;
    //先移除最后一行
    bodyLines.remove(lastIndex);
    //添加Limit 语句
    bodyLines.add("StringBuilder sqlBuilder = new StringBuilder(sql.toString());");
    bodyLines.add("if (example != null && example.getOffset() >= 0) {");
    bodyLines.add("sqlBuilder.append(\" LIMIT \").append(example.getOffset());");
    bodyLines.add("if (example.getLimit() > 0) {");
    bodyLines.add("sqlBuilder.append(\",\").append(example.getLimit());");
    bodyLines.add("}");
    bodyLines.add("}");
    bodyLines.add("return sqlBuilder.toString();");
}

private void repleaseSelectColumn(List<String> bodyLines) {
    bodyLines.add(1, "if (example != null && example.getResultColumn() != null && !example.getResultColumn().isEmpty()){");
    bodyLines.add(2, "sql.SELECT(example.getResultColumn());");
    bodyLines.add(3, "} else {");
    int lastIndex = 0;
    for (int i = 0; i < bodyLines.size(); i++) {
        if (bodyLines.get(i).indexOf("SELECT") > 0) lastIndex = i;
    }
    bodyLines.add(lastIndex + 1, "}");
}

经此改动后，生成的 countByExample 以及 selectByExample

Paste_Image.png Paste_Image.png

这样，我们对于分页以及增加只返回需要的字段功能便已完成，其中selectByExampleWithBLOBs与selectByExample相似度几乎一致，就不贴代码了 ^_

接下来介绍下 我的Spring多数据源 中提到的主从注解以及多数据源注解在插件中使其自动生成出来
在generator.xml中增加自定义配置，表示此次生成的对应哪个数据源，默认数据源可不需要此配置

<property name="dataSource" value="shop"/>

@Overridepublic boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
    //获取是否其他数据源，如果是，则增加其他数据源的配置
    String ortherSource = context.getProperties().getProperty("dataSource");
    interfaze.addImportedType(new FullyQualifiedJavaType("com.design.datasource.invocation.Read"));
    interfaze.addImportedType(new FullyQualifiedJavaType("com.design.datasource.invocation.Write"));
    if (ortherSource != null && !ortherSource.isEmpty()) {
        interfaze.addImportedType(new FullyQualifiedJavaType("com.design.datasource.invocation.OtherSource"));
    }
    for (Method method : interfaze.getMethods()) {
        String methodName = method.getName();
        if (methodName.startsWith("count") || methodName.startsWith("select")) {
            method.addAnnotation("@Read");
        } else {
            method.addAnnotation("@Write");
        }
        if (ortherSource != null && !ortherSource.isEmpty()) {
            method.addAnnotation("@OtherSource(\"" + ortherSource + "\")");
        }
    }
    return super.clientGenerated(interfaze, topLevelClass, introspectedTable);
}

生成后的 Mapper

Paste_Image.png Paste_Image.png

就这么简单，增加其他数据源的配置读取，过滤所有方法 只要是count 和 select 的 就认为是从库 其他均为主库。如果实在需要从主库查询的，可以在Mapper中手动调整即可，是不是很方便了 哈哈 ^_

最后提一下，要使插件生效很简单，只是在generator.xml 的 <context> 节点 中添加插件引用即可

<plugin type="com.design.mybatis.generator.MysqlGeneratorPlug"/>

至此，Spring Mybatis 多数据源 主从 自动切换，以及查询分页，根据需要返回查询字段数据均以完成，一切都是直接生成出来的 ^_
我先自己暗爽会儿，写的不好敬请拍砖，不喜勿喷 哈哈~~~！