mybatis代码生成器避免生成Example类的配置参数

huiselele

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<classPathEntry location="d://java//sqljdbc4.jar" />
<context id="DB2Tables" targetRuntime="MyBatis3">
<property name="suppressTypeWarnings" value="true" />
<plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" />
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
<plugin type="org.mybatis.generator.plugins.CaseInsensitiveLikePlugin" />
<plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
<property name="searchString" value="Example$" />
<property name="replaceString" value="Criteria" />
</plugin>
<plugin type="com.shinowit.mybatis.plugin.SelectByPagePlugin" />
<plugin type="com.shinowit.mybatis.plugin.Struts2ActionPlugin" />
<commentGenerator>
<property name="suppressAllComments" value="true" />
</commentGenerator>
<jdbcConnection driverClass="com.microsoft.sqlserver.jdbc.SQLServerDriver"
connectionURL="jdbc:sqlserver://localhost:1433;databaseName=OSS;"
userId="sa" password="sasa">
</jdbcConnection>
<javaTypeResolver>
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<javaModelGenerator targetPackage="com.shinowit.model"
targetProject="src">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<sqlMapGenerator targetPackage="com.shinowit.dao.mapper"
targetProject="src">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.shinowit.dao.mapper" targetProject="src">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>

<table tableName="TBa_MemberInfo">
<generatedKey column="ID" sqlStatement="SqlServer"
identity="true" />
</table>
<table tableName="TBa_SupplyRecordInfo">
<generatedKey column="ID" sqlStatement="SqlServer"
identity="true" />
</table>
</context>
</generatorConfiguration>


　　其实想要mybaits代码生成器生成Example类换个名字，是通过插件实现的，即下面的这个插件配置参数很关键。

<plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
<property name="searchString" value="Example$" />
<property name="replaceString" value="Criteria" />
</plugin>

　　如果不喜欢生成的代码中带有代理的mybatis代码生成器的注解信息，可以配置下面的配置参数关闭注解信息的生成：

<commentGenerator>
<property name="suppressAllComments" value="true" />
</commentGenerator>

　　上面示例中的分页代码自动生成插件是我自己写的，用于自动生成数据库物理分页的代码。
　　该插件的源码如下：

package com.shinowit.mybatis.plugin;
import static org.mybatis.generator.internal.util.messages.Messages.getString;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Field;
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.mybatis.generator.api.dom.java.TopLevelClass;
import org.mybatis.generator.api.dom.xml.Attribute;
import org.mybatis.generator.api.dom.xml.Document;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.codegen.mybatis3.MyBatis3FormattingUtilities;
public class SelectByPagePlugin extends PluginAdapter {
@Override
public boolean validate(List<String> warnings) {
return true;
}
private void addField(String fieldName, FullyQualifiedJavaType fieldType,
TopLevelClass topLevelClass) {
Field tmpField = new Field(fieldName, fieldType);
tmpField.setVisibility(JavaVisibility.PRIVATE);
topLevelClass.addField(tmpField);
Method setMethod = new Method();
setMethod.setName("set" + fieldName.toUpperCase().substring(0, 1)
+ fieldName.substring(1));
Parameter param = new Parameter(fieldType, fieldName);
setMethod.addParameter(param);
setMethod.setVisibility(JavaVisibility.PUBLIC);
setMethod.addBodyLine("this." + fieldName + "=" + fieldName + ";");
topLevelClass.addMethod(setMethod);
Method getMethod = new Method();
getMethod.setName("get" + fieldName.toUpperCase().substring(0, 1)
+ fieldName.substring(1));
getMethod.setReturnType(fieldType);
getMethod.setVisibility(JavaVisibility.PUBLIC);
getMethod.addBodyLine("return this." + fieldName + ";");
topLevelClass.addMethod(getMethod);
}
@Override
public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable) {
FullyQualifiedJavaType intType = FullyQualifiedJavaType
.getIntInstance();
addField("pageIndex", intType, topLevelClass);
addField("pageSize", intType, topLevelClass);
Method getSkipCountMethod = new Method();
getSkipCountMethod.setName("getSkipRecordCount");
getSkipCountMethod.setReturnType(intType);
getSkipCountMethod.setVisibility(JavaVisibility.PUBLIC);
getSkipCountMethod
.addBodyLine("return (this.pageIndex-1)*this.pageSize;");
topLevelClass.addMethod(getSkipCountMethod);
Method getEndRecordIndexMethod = new Method();
getEndRecordIndexMethod.setName("getEndRecordCount");
getEndRecordIndexMethod.setReturnType(intType);
getEndRecordIndexMethod.setVisibility(JavaVisibility.PUBLIC);
getEndRecordIndexMethod
.addBodyLine("return this.pageIndex*this.pageSize;");
topLevelClass.addMethod(getEndRecordIndexMethod);

Method newConstructorMethod = new Method();
newConstructorMethod.setConstructor(true);
newConstructorMethod.addParameter(new Parameter(intType, "pageSize"));
newConstructorMethod.addParameter(new Parameter(intType, "pageIndex"));
newConstructorMethod.addBodyLine("this();");
newConstructorMethod.addBodyLine("this.pageSize=pageSize;");
newConstructorMethod.addBodyLine("this.pageIndex=pageIndex;");
newConstructorMethod.setVisibility(JavaVisibility.PUBLIC);
newConstructorMethod.setName(topLevelClass.getType().getShortName());
topLevelClass.addMethod(newConstructorMethod);
return true;
}
@Override
public boolean clientGenerated(Interface interfaze,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
Set<FullyQualifiedJavaType> importedTypes = new TreeSet<FullyQualifiedJavaType>();
FullyQualifiedJavaType type = new FullyQualifiedJavaType(
introspectedTable.getExampleType());
importedTypes.add(type);
importedTypes.add(FullyQualifiedJavaType.getNewListInstance());
Method method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
FullyQualifiedJavaType returnType = FullyQualifiedJavaType
.getNewListInstance();
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("selectPage");
method.addParameter(new Parameter(type, "example")); //$NON-NLS-1$
interfaze.addImportedTypes(importedTypes);
interfaze.addMethod(method);
return true;
}
@Override
public boolean sqlMapDocumentGenerated(Document document,
IntrospectedTable introspectedTable) {
XmlElement parentElement = document.getRootElement();
XmlElement newResultMapElement = new XmlElement("resultMap");
newResultMapElement
.addAttribute(new Attribute("id", "selectPageResult"));
newResultMapElement.addAttribute(new Attribute("extends",
"BaseResultMap"));
String returnType;
if (introspectedTable.getRules().generateBaseRecordClass()) {
returnType = introspectedTable.getBaseRecordType();
} else {
returnType = introspectedTable.getPrimaryKeyType();
}
newResultMapElement.addAttribute(new Attribute("type",
returnType));
newResultMapElement
.addElement(new TextElement(
"<!--\r\n<association property=\"\" column=\"\" javaType=\"\">\r\n"
+ "   <id column=\"\" property=\"\" jdbcType=\"\" />\r\n"
+ "   <result column=\"\" property=\"\" jdbcType=\"\" />\r\n"
+ " </association>\r\n-->"));
parentElement.addElement(newResultMapElement);

//以下代码用于生成支持分页的sql片段
/**
*注意千万不要随意删除代码中的空格 ！
*do not remove spaces
*/
XmlElement outter_where_sql=new XmlElement("sql");
outter_where_sql.addAttribute(new Attribute("id", "select_by_page_outter_where_sql"));
StringBuilder sb = new StringBuilder();
sb.append("  <if test=\"oredCriteria.size>0\">");
sb.append("     <if test=\"_parameter != null\" > <include refid=\"Example_Where_Clause\"/> </if>");
sb.append("    and ");
sb.append("  </if>");
sb.append("  <if test=\"oredCriteria.size==0\"> ");
sb.append("    where ");
sb.append("  </if> ");
outter_where_sql.addElement(new TextElement(sb.toString()));
parentElement.addElement(outter_where_sql);
XmlElement inner_where_sql=new XmlElement("sql");
inner_where_sql.addAttribute(new Attribute("id", "select_by_page_inner_where_and_orderby_sql"));
sb.setLength(0);
sb.append("  <if test=\"oredCriteria.size>0\">");
sb.append("     <if test=\"_parameter != null\" > <include refid=\"Example_Where_Clause\"/> </if>");
sb.append("  </if>");
sb.append("   <if test=\"orderByClause != null\">");
sb.append("    order by ${orderByClause} ");
sb.append("  </if> ");
inner_where_sql.addElement(new TextElement(sb.toString()));
parentElement.addElement(inner_where_sql);

XmlElement outter_orderby_sql=new XmlElement("sql");
outter_orderby_sql.addAttribute(new Attribute("id", "select_by_page_outter_orderby_sql"));
sb.setLength(0);
sb.append("   <if test=\"orderByClause != null\">");
sb.append("    order by ${orderByClause} ");
sb.append("  </if> ");
outter_orderby_sql.addElement(new TextElement(sb.toString()));
parentElement.addElement(outter_orderby_sql);
//以上代码用于生成支持分页的sql片段
String fqjt = introspectedTable.getExampleType();
XmlElement answer = new XmlElement("select"); //$NON-NLS-1$
answer.addAttribute(new Attribute("id", //$NON-NLS-1$
"selectPage"));
answer.addAttribute(new Attribute(
"resultMap","selectPageResult")); //$NON-NLS-1$
answer.addAttribute(new Attribute("parameterType", fqjt)); //$NON-NLS-1$

sb.setLength(0);
sb.append("select a.* from ");
sb.append(introspectedTable
.getAliasedFullyQualifiedTableNameAtRuntime());
sb.append(" a where a.");
List<IntrospectedColumn> pks=introspectedTable.getPrimaryKeyColumns();
if (pks.size()==1){
sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
}else{
sb.append(" #your_primary_key_name ");
}
sb.append(" in \r\n (select top ${pageSize} ");
if (pks.size()==1){
sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
}else{
sb.append(" #your_primary_key_name ");
}
sb.append(" from "+introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime()+" ");
sb.append("\r\n<include refid=\"select_by_page_outter_where_sql\"/> \r\n");
if (pks.size()==1){
sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
}else{
sb.append(" #your_primary_key_name ");
}
sb.append(" not in (select top ${skipRecordCount} " );
if (pks.size()==1){
sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(pks.get(0)));
}else{
sb.append(" #your_primary_key_name ");
}
sb.append(" from "+introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime()+" ");
sb.append(" \r\n<include refid=\"select_by_page_inner_where_and_orderby_sql\"/> \r\n");
sb.append(" )");
sb.append(" \r\n<include refid=\"select_by_page_outter_orderby_sql\"/> \r\n");
sb.append(" )");

answer.addElement(new TextElement(sb.toString()));
parentElement.addElement(answer);
return true;
}
}