package org.mybatis.generator.plugins;
import org.apache.log4j.Logger;
import java.util.ArrayList;
import java.util.List;
import org.mybatis.generator.api.GeneratedJavaFile;
import org.mybatis.generator.api.GeneratedXmlFile;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.OutputUtilities;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.InnerClass;
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.Element;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.codegen.XmlConstants;
import org.mybatis.generator.codegen.ibatis2.Ibatis2FormattingUtilities;
import org.mybatis.generator.internal.rules.Rules;
/**
* 增加公用条件查询类 Criteria
*
* @author QQ:34847009
* @date 2010-10-21 下午09:33:48
*/
public class IbatisCriteriaPlugin extends PluginAdapter {
/**
* Logger for this class
*/
private static final Logger logger = Logger.getLogger(IbatisCriteriaPlugin.class);
private FullyQualifiedJavaType criteria;
/** 数据库类型 */
private String databaseType;
@Override
public boolean validate(List<String> warnings) {
databaseType = context.getJdbcConnectionConfiguration().getDriverClass();
String criterias = context.getJavaModelGeneratorConfiguration().getTargetPackage() + ".Criteria";
criteria = new FullyQualifiedJavaType(criterias);
return true;
}
@Override
public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable) {
List<GeneratedJavaFile> files = new ArrayList<GeneratedJavaFile>();
TopLevelClass topLevelClass = new TopLevelClass(criteria);
topLevelClass.setVisibility(JavaVisibility.PUBLIC);
addClassComment(topLevelClass, "公用条件查询类");
topLevelClass.addImportedType(FullyQualifiedJavaType.getNewMapInstance());
topLevelClass.addImportedType(FullyQualifiedJavaType.getNewHashMapInstance());
FullyQualifiedJavaType types = new FullyQualifiedJavaType("java.util.Map<java.lang.String, java.lang.Object>");
Rules rules = introspectedTable.getRules();
if (rules.generateUpdateByExampleSelective() || rules.generateUpdateByExampleWithBLOBs()
|| rules.generateUpdateByExampleWithoutBLOBs()) {
Method method = new Method();
method.setVisibility(JavaVisibility.PROTECTED);
method.setConstructor(true);
method.setName(criteria.getShortName());
method.addParameter(new Parameter(criteria, "example")); //$NON-NLS-1$
method.addBodyLine("this.orderByClause = example.orderByClause;"); //$NON-NLS-1$
method.addBodyLine("this.condition = example.condition;"); //$NON-NLS-1$
method.addBodyLine("this.distinct = example.distinct;"); //$NON-NLS-1$
method.addBodyLine("this.limit = example.limit;"); //$NON-NLS-1$
method.addBodyLine("this.start = example.start;"); //$NON-NLS-1$
topLevelClass.addMethod(method);
}
Field field = new Field();
field.setVisibility(JavaVisibility.PRIVATE);
field.setType(types);
field.setName("condition"); //$NON-NLS-1$
addFieldComment(field, "存放条件查询值");
topLevelClass.addField(field);
// add field, getter, setter for distinct
field = new Field();
field.setVisibility(JavaVisibility.PROTECTED);
field.setType(FullyQualifiedJavaType.getBooleanPrimitiveInstance());
field.setName("distinct"); //$NON-NLS-1$
addFieldComment(field, "是否相异");
topLevelClass.addField(field);
// add field, getter, setter for orderby clause
field = new Field();
field.setVisibility(JavaVisibility.PROTECTED);
field.setType(FullyQualifiedJavaType.getStringInstance());
field.setName("orderByClause"); //$NON-NLS-1$
addFieldComment(field, "排序字段");
topLevelClass.addField(field);
Method method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
method.setConstructor(true);
method.setName("Criteria"); //$NON-NLS-1$
method.addBodyLine("condition = new HashMap<String, Object>();"); //$NON-NLS-1$
topLevelClass.addMethod(method);
method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
method.setName("clear"); //$NON-NLS-1$
method.addBodyLine("condition.clear();"); //$NON-NLS-1$
method.addBodyLine("orderByClause = null;"); //$NON-NLS-1$
method.addBodyLine("distinct = false;"); //$NON-NLS-1$
method.addBodyLine("this.limit=null;"); //$NON-NLS-1$
method.addBodyLine("this.start=null;"); //$NON-NLS-1$
topLevelClass.addMethod(method);
method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
method.setReturnType(criteria);
method.setName("put"); //$NON-NLS-1$
method.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "condition")); //$NON-NLS-1$
method.addParameter(new Parameter(FullyQualifiedJavaType.getObjectInstance(), "value")); //$NON-NLS-1$
method.addBodyLine("this.condition.put(condition, value);"); //$NON-NLS-1$
method.addBodyLine("return (Criteria) this;"); //$NON-NLS-1$
addSetterComment(method, OutputUtilities.lineSeparator+"\t * 查询的条件名称"+OutputUtilities.lineSeparator+"\t * @param value"+OutputUtilities.lineSeparator+"\t * 查询的值", "condition");
topLevelClass.addMethod(method);
method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
method.setName("setOrderByClause"); //$NON-NLS-1$
method.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "orderByClause")); //$NON-NLS-1$
method.addBodyLine("this.orderByClause = orderByClause;"); //$NON-NLS-1$
addSetterComment(method, OutputUtilities.lineSeparator+"\t * 排序字段", "orderByClause");
topLevelClass.addMethod(method);
method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
method.setName("setDistinct"); //$NON-NLS-1$
method.addParameter(new Parameter(FullyQualifiedJavaType.getBooleanPrimitiveInstance(), "distinct")); //$NON-NLS-1$
method.addBodyLine("this.distinct = distinct;"); //$NON-NLS-1$
addSetterComment(method, OutputUtilities.lineSeparator+"\t * 是否相异", "distinct");
topLevelClass.addMethod(method);
field = new Field();
field.setVisibility(JavaVisibility.PRIVATE);
field.setType(FullyQualifiedJavaType.getInteger());
field.setName("limit"); //$NON-NLS-1$
topLevelClass.addField(field);
method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
method.setName("setLimit"); //$NON-NLS-1$
method.addParameter(new Parameter(FullyQualifiedJavaType.getInteger(), "limit")); //$NON-NLS-1$
method.addBodyLine("this.limit = limit;"); //$NON-NLS-1$
addSetterComment(method, "每页大小，即mysql中的length", "limit");
topLevelClass.addMethod(method);
field = new Field();
field.setVisibility(JavaVisibility.PRIVATE);
field.setType(FullyQualifiedJavaType.getInteger());
field.setName("start"); //$NON-NLS-1$
topLevelClass.addField(field);
method = new Method();
method.setVisibility(JavaVisibility.PUBLIC);
method.setName("setStart"); //$NON-NLS-1$
method.addParameter(new Parameter(FullyQualifiedJavaType.getInteger(), "start")); //$NON-NLS-1$
method.addBodyLine("this.start = start;"); //$NON-NLS-1$
addSetterComment(method, "开始行数，即mysql中的offset", "start");
topLevelClass.addMethod(method);
GeneratedJavaFile file = new GeneratedJavaFile(topLevelClass, context.getJavaModelGeneratorConfiguration()
.getTargetProject());
files.add(file);
return files;
}
@Override
public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
// 接口方法
List<Method> methods = interfaze.getMethods();
Parameter parameter = new Parameter(criteria, "example");
boolean first = true;
for (int i = 0; i < methods.size(); i++) {
Method method = methods.get(i);
if (method.getFormattedContent(0, true).contains("Example")) {
int size = method.getParameters().size();
if (first) {
interfaze.removeImportedType(new FullyQualifiedJavaType(introspectedTable.getExampleType()));
interfaze.addImportedType(criteria);
}
if (size == 1) {
method.removeParameter(0);
method.addParameter(parameter);
} else if (size == 2) {
method.removeParameter(1);
method.addParameter(1, parameter);
}
first = false;
}
}
// 实现类
methods = topLevelClass.getMethods();
first = true;
for (int i = 0; i < methods.size(); i++) {
Method method = methods.get(i);
if (method.getFormattedContent(0, true).contains("Example")) {
int size = method.getParameters().size();
if (first) {
topLevelClass.removeImportedType(new FullyQualifiedJavaType(introspectedTable.getExampleType()));
topLevelClass.addImportedType(criteria);
}
if (size == 1) {
method.removeParameter(0);
method.addParameter(parameter);
} else if (size == 2) {
method.removeParameter(1);
method.addParameter(1, parameter);
}
first = false;
}
}
// 内部类
InnerClass in = topLevelClass.getInnerClasses().get(0);
in.setSuperClass(criteria);
Method method = in.getMethods().get(0);
method.removeParameter(1);
method.addParameter(1, parameter);
return true;
}
@Override
public boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable) {
// 替换所有条件parameterClass中的pojoExample
List<Element> list = document.getRootElement().getElements();
logger.info(list.size() + "");
for (int i = 0; i < list.size(); i++) {
XmlElement xml = (XmlElement) list.get(i);
String content = xml.getFormattedContent(0);
if (content.contains(introspectedTable.getExampleType())) {
List<Attribute> attrs = xml.getAttributes();
for (int j = 0; j < attrs.size(); j++) {
if (attrs.get(j).getName().equals("parameterClass")) {
attrs.get(j).setValue(criteria.getFullyQualifiedName());
}
}
}
}
// Example_Where_Clause
XmlElement Where_Clause = (XmlElement) document.getRootElement().getElements().get(1);
// 移除第一个
Where_Clause.removeElement(0);
StringBuilder sb = new StringBuilder();
XmlElement dynamicElement = new XmlElement("dynamic"); //$NON-NLS-1$
dynamicElement.addAttribute(new Attribute("prepend", "where")); //$NON-NLS-1$ //$NON-NLS-2$
Where_Clause.addElement(dynamicElement);
for (IntrospectedColumn introspectedColumn : introspectedTable.getNonPrimaryKeyColumns()) {
XmlElement isNotNullElement = new XmlElement("isNotNull"); //$NON-NLS-1$
isNotNullElement.addAttribute(new Attribute("prepend", "and")); //$NON-NLS-1$ //$NON-NLS-2$
isNotNullElement.addAttribute(new Attribute("property", introspectedColumn.getJavaProperty("condition."))); //$NON-NLS-1$
dynamicElement.addElement(isNotNullElement);
sb.setLength(0);
sb.append(Ibatis2FormattingUtilities.getEscapedColumnName(introspectedColumn));
sb.append(" = "); //$NON-NLS-1$
sb.append(Ibatis2FormattingUtilities.getParameterClause(introspectedColumn, "condition."));
isNotNullElement.addElement(new TextElement(sb.toString()));
}
return true;
}
@Override
public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable) {
if (databaseType.contains("oracle")) {
XmlElement oracleHeadIncludeElement = new XmlElement("include");
oracleHeadIncludeElement.addAttribute(new Attribute("refid", "common.Oracle_Pagination_Head"));
// 在第一个地方增加
element.addElement(0, oracleHeadIncludeElement);
XmlElement oracleTailIncludeElement = new XmlElement("include");
oracleTailIncludeElement.addAttribute(new Attribute("refid", "common.Oracle_Pagination_Tail"));
// 在最后增加
element.addElement(element.getElements().size(), oracleTailIncludeElement);
} else if (databaseType.contains("mysql")) {
XmlElement mysqlLimitIncludeElement = new XmlElement("include");
mysqlLimitIncludeElement.addAttribute(new Attribute("refid", "common.Mysql_Pagination_Limit"));
// 在最后增加
element.addElement(element.getElements().size(), mysqlLimitIncludeElement);
}
return true;
}
@Override
public boolean sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable) {
if (databaseType.contains("oracle")) {
XmlElement oracleHeadIncludeElement = new XmlElement("include");
oracleHeadIncludeElement.addAttribute(new Attribute("refid", "common.Oracle_Pagination_Head"));
// 在第一个地方增加
element.addElement(0, oracleHeadIncludeElement);
XmlElement oracleTailIncludeElement = new XmlElement("include");
oracleTailIncludeElement.addAttribute(new Attribute("refid", "common.Oracle_Pagination_Tail"));
// 在最后增加
element.addElement(element.getElements().size(), oracleTailIncludeElement);
} else if (databaseType.contains("mysql")) {
XmlElement mysqlLimitIncludeElement = new XmlElement("include");
mysqlLimitIncludeElement.addAttribute(new Attribute("refid", "common.Mysql_Pagination_Limit"));
// 在最后增加
element.addElement(element.getElements().size(), mysqlLimitIncludeElement);
}
return true;
}
@Override
public List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable) {
Document document = new Document(XmlConstants.IBATIS2_SQL_MAP_PUBLIC_ID, XmlConstants.IBATIS2_SQL_MAP_SYSTEM_ID);
XmlElement answer = new XmlElement("sqlMap"); //$NON-NLS-1$
document.setRootElement(answer);
answer.addAttribute(new Attribute("namespace", //$NON-NLS-1$
"common"));
if (databaseType.contains("oracle")) {
answer.addElement(getOracleHead());
answer.addElement(getOracleTail());
} else if (databaseType.contains("mysql")) {
answer.addElement(getMysqlLimit());
}
GeneratedXmlFile gxf = new GeneratedXmlFile(document, properties.getProperty("fileName", "common_SqlMap.xml"), //$NON-NLS-1$ //$NON-NLS-2$
context.getSqlMapGeneratorConfiguration().getTargetPackage(), //$NON-NLS-1$
context.getSqlMapGeneratorConfiguration().getTargetProject(), //$NON-NLS-1$
false);
List<GeneratedXmlFile> files = new ArrayList<GeneratedXmlFile>(1);
files.add(gxf);
return files;
}
private XmlElement getOracleHead() {
XmlElement answer = new XmlElement("sql"); //$NON-NLS-1$
answer.addAttribute(new Attribute("id", "Oracle_Pagination_Head")); //$NON-NLS-1$
XmlElement dynamicElement = new XmlElement("dynamic");
XmlElement outerisNotEmptyElement = new XmlElement("isNotNull");
outerisNotEmptyElement.addAttribute(new Attribute("property", "limit"));
XmlElement innerisNotEmptyElement = new XmlElement("isNotNull");
innerisNotEmptyElement.addAttribute(new Attribute("property", "start"));
innerisNotEmptyElement.addElement(new TextElement("<![CDATA[ select * from ( select row_.*, rownum rownum_ from ( ]]>"));
outerisNotEmptyElement.addElement(innerisNotEmptyElement);
dynamicElement.addElement(outerisNotEmptyElement);
answer.addElement(dynamicElement);
return answer;
}
private XmlElement getOracleTail() {
XmlElement answer = new XmlElement("sql"); //$NON-NLS-1$
answer.addAttribute(new Attribute("id", "Oracle_Pagination_Tail")); //$NON-NLS-1$
XmlElement dynamicElement = new XmlElement("dynamic");
XmlElement outerisNotEmptyElement = new XmlElement("isNotNull");
outerisNotEmptyElement.addAttribute(new Attribute("property", "limit"));
XmlElement innerisNotEmptyElement = new XmlElement("isNotNull");
innerisNotEmptyElement.addAttribute(new Attribute("property", "start"));
innerisNotEmptyElement.addElement(new TextElement(
"<![CDATA[ ) row_ where rownum <= (#limit# + #start#) ) where rownum_ > #start# ]]>"));
outerisNotEmptyElement.addElement(innerisNotEmptyElement);
dynamicElement.addElement(outerisNotEmptyElement);
answer.addElement(dynamicElement);
return answer;
}
private XmlElement getMysqlLimit() {
XmlElement answer = new XmlElement("sql"); //$NON-NLS-1$
answer.addAttribute(new Attribute("id", "Mysql_Pagination_Limit")); //$NON-NLS-1$
XmlElement dynamicElement = new XmlElement("dynamic");
XmlElement outerisNotEmptyElement = new XmlElement("isNotNull");
outerisNotEmptyElement.addAttribute(new Attribute("property", "limit"));
XmlElement innerisNotEmptyElement = new XmlElement("isNotNull");
innerisNotEmptyElement.addAttribute(new Attribute("property", "start"));
innerisNotEmptyElement.addElement(new TextElement("<![CDATA[ limit #start# , #limit# ]]>"));
outerisNotEmptyElement.addElement(innerisNotEmptyElement);
dynamicElement.addElement(outerisNotEmptyElement);
answer.addElement(dynamicElement);
return answer;
}
}