mybatis (Ibatis ibator) generator - 1 mysql 分页插件(page/paging/pagination plugin)

前言

在线文档，参考 http://ibatis.apache.org/docs/tools/ibator/

由于ibatis转移为mybatis，所以参考mybatis 最新文档：http://code.google.com/p/mybatis/wiki/Downloads?tm=2

下载的MyBatis Generator Tool中有文档说明

 

http://ibatis.apache.org/docs/tools/ibator/reference/pluggingIn.html

将plugin的生命周期和怎么扩展，都已经交代明了，接下来就是动手实践了

How to

1 Plugin Class 

生成plugin class,  extends PluginAdapter. 如同文档所说，直接implements Plugin 接口会很繁琐，超多的方法要实现。

 

package org.leef.db.mybatis.plugin; import java.util.List; import org.mybatis.generator.api.CommentGenerator; import org.mybatis.generator.api.IntrospectedTable; import org.mybatis.generator.api.PluginAdapter; import org.mybatis.generator.api.ShellRunner; import org.mybatis.generator.api.dom.java.Field; import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType; 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.TextElement; import org.mybatis.generator.api.dom.xml.XmlElement; /** * <pre> * add pagination using mysql limit. * This class is only used in ibator code generator. * </pre> */ public class PaginationPlugin extends PluginAdapter { @Override public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { // add field, getter, setter for limit clause addLimit(topLevelClass, introspectedTable, "limitStart"); addLimit(topLevelClass, introspectedTable, "limitEnd"); return super.modelExampleClassGenerated(topLevelClass, introspectedTable); } @Override public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated( XmlElement element, IntrospectedTable introspectedTable) { XmlElement isParameterPresenteElemen = (XmlElement) element .getElements().get(element.getElements().size() - 1); XmlElement isNotNullElement = new XmlElement("isGreaterEqual"); //$NON-NLS-1$ isNotNullElement.addAttribute(new Attribute("property", "limitStart")); //$NON-NLS-1$ //$NON-NLS-2$ isNotNullElement.addAttribute(new Attribute("compareValue", "0")); //$NON-NLS-1$ //$NON-NLS-2$ isNotNullElement.addElement(new TextElement( "limit $limitStart$ , $limitEnd$")); isParameterPresenteElemen.addElement(isNotNullElement); return super.sqlMapUpdateByExampleWithoutBLOBsElementGenerated(element, introspectedTable); } private void addLimit(TopLevelClass topLevelClass, IntrospectedTable introspectedTable, String name) { CommentGenerator commentGenerator = context.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); } /** * This plugin is always valid - no properties are required */ public boolean validate(List<String> warnings) { return true; } public static void generate() { String config = PaginationPlugin.class.getClassLoader().getResource( "mybatisConfig.xml").getFile(); String[] arg = { "-configfile", config, "-overwrite" }; ShellRunner.main(arg); } public static void main(String[] args) { generate(); } }  

 

在写Mybatis plugin时，只需要弄两清两个问题：

• 在哪里添加 - 决定实现plugin中的哪个方法

mybatis会生成一下artificial. 

1) Model class && Model example class

2) DAO && DAO Impl (配置文件中 javaClientGenerator type="SPRING")

3) sql map file

• 添加什么内容

由于我们需要支持分页查询，mysql 中使用limit来进行分页查询, e.g

       select * from event where XX

 ->

       select * from event where XX  limit 0, 10  返回最前面的10个查询结果

 

因此我们需要在 select 类的sql 语句后面添加 limit $limitStart$ , $limitNum$, limitStart和limitNum作为参数传入。

我们发现limit在sql中的位置和order by 在sql中的位置很接近，因此我们借鉴了order by 语句的生成。

 

1) 在 Model Example class 中添加两个字段 limitStart, limitNum以及相应的Getter, setter方法 -> modelExampleClassGenerated

2) 在sql map 文件中的select 语句尾部添加limit $limitStart$ , $limitNum$ -> sqlMapSelectByExampleWithoutBLOBsElementGenerated

    注意我们将limitStart初始值设为-1, 同时添加 isGreaterEqual 条件判断，这样使用Model Example时，如果没有设置limitStart，则sql语句中不会加上limit。

 

我们是如何知道Method, xml element添加的写法呢？

Mybatis 本身自带了几个plguin，查看PluginAdaptor(Plugin)的子类即可了解其具体实现 --  不得不感谢IVY/MAVEN，使用自动化的依赖管理后，这些开源项目的源码自动获取，阅读相当轻松。

 

最后我们添加了Main方法，方便直接在Eclipse中运行generator，生成Code

2 config file

<?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> <properties resource="mybatis.properties" /> <context id="DB2Tables" targetRuntime="Ibatis2Java5"> <plugin type="org.leef.db.mybatis.plugin.PaginationPlugin" /> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="${jdbc.mysql.url}" userId="${jdbc.mysql.username}" password="${jdbc.mysql.password}"> </jdbcConnection> <javaTypeResolver> <property name="forceBigDecimals" value="false" /> </javaTypeResolver> <javaModelGenerator targetPackage="org.leef.db.model" targetProject="${generate.src.dir}"> <property name="enableSubPackages" value="true" /> <property name="trimStrings" value="true" /> </javaModelGenerator> <sqlMapGenerator targetPackage="sql" targetProject="${generate.config.dir}"> <property name="enableSubPackages" value="true" /> </sqlMapGenerator> <javaClientGenerator type="SPRING" targetPackage="org.leef.db.dao" targetProject="${generate.src.dir}"> <property name="enableSubPackages" value="true" /> </javaClientGenerator> <table schema="lbs" tableName="event" domainObjectName="Event"> <generatedKey identity="true" column="ID" sqlStatement="SELECT LAST_INSERT_ID()" /> </table> </context> </generatorConfiguration>  

 

mybatisConfig.xml

1) 我们使用properties file来配置可能会变更的设置mybatis.properties

 

 

jdbc.mysql.url=jdbc:mysql://127.0.0.1:3306/lbs

jdbc.mysql.username=root

jdbc.mysql.password=root

 

generate.src.dir=src/main/java

generate.config.dir=src/main/resources

 

我们使用的样例数据名城是lbs，里面只有一张表event，包含两个字段id, title

 

2)  <context id="DB2Tables" targetRuntime="Ibatis2Java5">

 

 

targetRuntime我们选择Ibatis2Java5而不是MyBatis3，因为在后面的 javaClientGenerator中我们希望使用Spring DAO

If the <context> targetRuntime is MyBatis3:
XMLMAPPER	The generated objects will be Java interfaces for the MyBatis 3.x mapper infrastructure. The interfaces will be dependent on generated XML mapper files.
If the <context> targetRuntime is Ibatis2Java2 or Ibatis2Java5:
IBATIS	The generated objects will conform to the (deprecated) iBATIS DAO framework.
GENERIC-CI	The generated objects will rely only on the SqlMapClient. The SqlMapClient will be supplied by constructor dependency injection. The generated objects will be in the form of DAO interfaces amd implementation classes.
GENERIC-SI	The generated objects will rely only on the SqlMapClient. The SqlMapClient will be supplied by setter dependency injection. The generated objects will be in the form of DAO interfaces amd implementation classes.
SPRING	The generated objects will conform to the Spring DAO framework.

 

 

3) <plugin type="org.leef.db.mybatis.plugin.PaginationPlugin" />

     添加我们使用的插件     

 

生成的sql map selectByExample 如下

<select id="selectByExample" parameterClass="org.leef.db.model.EventExample" resultMap="BaseResultMap"> <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. This element was generated on Sat Dec 11 12:35:22 CST 2010. --> select <isParameterPresent> <isEqual compareValue="true" property="distinct"> distinct </isEqual> </isParameterPresent> <include refid="event.Base_Column_List" /> from event <isParameterPresent> <include refid="event.Example_Where_Clause" /> <isNotNull property="orderByClause"> order by $orderByClause$ </isNotNull> <isGreaterEqual compareValue="0" property="limitStart"> limit $limitStart$ , $limitNum$ </isGreaterEqual> </isParameterPresent> </select> 

3 Use: Example class limit field

EventExample example = new EventExample(); example.createCriteria().andIdGreaterThan(1L); example.setLimitStart(0); example.setLimitNum(10); dao.selectByExample(example); 

 

OK, 大功告成，so easy, rt？

关于mybatis generator 的故事并没有完结，后文中我们将会介绍

1) Spring DAO和 Mapper class 的区别

2) 如何handle 常量表(cache 常用表)

3) 如何handle column default value