├── README.md
├── pom.xml
└── src
    └── main
        └── java
            └── com
                └── xxg
                    └── mybatis
                        └── plugins
                            └── MySQLLimitPlugin.java


/README.md:
--------------------------------------------------------------------------------
 1 | # mybatis-generator-limit-plugin
 2 | A MyBatis Generator plugin for MySQL pagination use limit.
 3 | 
 4 | http://xxgblog.com/2016/05/06/mybatis-generator-mysql-pagination/
 5 | 
 6 | The project moves to https://github.com/wucao/mybatis-generator-mysql-plugin
 7 | 
 8 | ## Usage
 9 | 
10 | Add the plugin `<plugin type="com.xxg.mybatis.plugins.MySQLLimitPlugin"></plugin>` into MyBatis Generator configuration file.
11 | 
12 | ```
13 | <generatorConfiguration>
14 |     <context id="mysqlgenerator" targetRuntime="MyBatis3">
15 |         <plugin type="com.xxg.mybatis.plugins.MySQLLimitPlugin"></plugin>
16 |         ...
17 |     </context>
18 | </generatorConfiguration>
19 | ```
20 | 
21 | ### Running with Maven
22 | 
23 | pom.xml
24 | 
25 | ```
26 | <pluginRepositories>
27 |     <pluginRepository>
28 |         <id>xxg-repository</id>
29 |         <url>http://repo.maven.xxgblog.com/</url>
30 |     </pluginRepository>
31 | </pluginRepositories>
32 | ```
33 | 
34 | ```
35 | <build>
36 | 	<plugins>
37 | 		<plugin>
38 | 			<groupId>org.mybatis.generator</groupId>
39 | 			<artifactId>mybatis-generator-maven-plugin</artifactId>
40 | 			<version>1.3.2</version>
41 | 			<dependencies>
42 | 				<dependency>
43 | 					<groupId>mysql</groupId>
44 | 					<artifactId>mysql-connector-java</artifactId>
45 | 					<version>5.1.34</version>
46 | 				</dependency>
47 | 				<dependency>
48 | 					<groupId>com.xxg</groupId>
49 | 					<artifactId>mbg-limit-plugin</artifactId>
50 | 					<version>1.0.0</version>
51 | 				</dependency>
52 | 			</dependencies>
53 | 			<configuration>
54 | 				<overwrite>true</overwrite>
55 | 			</configuration>
56 | 		</plugin>
57 | 	</plugins>
58 | </build>
59 | ```
60 | 
61 | Run `mvn mybatis-generator:generator` to generate java and xml files.
62 | 
63 | ### Using the Generated Objects
64 | 
65 | ```
66 | XxxExample example = new XxxExample();
67 | ...
68 | example.setLimit(10); // page size limit
69 | example.setOffset(20); // offset
70 | List<Xxx> list = xxxMapper.selectByExample(example);
71 | ```
72 | The SQL will be:
73 | `select ... limit 20, 10`
74 | 
75 | ```
76 | XxxExample example = new XxxExample();
77 | ...
78 | example.setLimit(10); // limit
79 | List<Xxx> list = xxxMapper.selectByExample(example);
80 | ```
81 | The SQL will be:
82 | `select ... limit 10`
83 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 | 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 4 | 
 5 | 	<modelVersion>4.0.0</modelVersion>
 6 | 	<groupId>com.xxg</groupId>
 7 | 	<artifactId>mbg-limit-plugin</artifactId>
 8 | 	<version>1.0.0</version>
 9 | 
10 | 	<properties>
11 | 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
12 | 	</properties>
13 | 
14 | 	<distributionManagement>
15 | 		<repository>
16 | 			<id>ftp-repository</id>
17 | 			<url>ftp://v0.ftp.upyun.com</url>
18 | 		</repository>
19 | 	</distributionManagement>
20 | 
21 | 	<build>
22 | 		<extensions>
23 | 			<extension>
24 | 				<groupId>org.apache.maven.wagon</groupId>
25 | 				<artifactId>wagon-ftp</artifactId>
26 | 				<version>2.10</version>
27 | 			</extension>
28 | 		</extensions>
29 | 		<plugins>
30 | 			<plugin>
31 | 				<groupId>org.apache.maven.plugins</groupId>
32 | 				<artifactId>maven-compiler-plugin</artifactId>
33 | 				<version>3.3</version>
34 | 				<configuration>
35 | 					<source>1.7</source>
36 | 					<target>1.7</target>
37 | 				</configuration>
38 | 			</plugin>
39 | 		</plugins>
40 | 	</build>
41 | 
42 | 	<dependencies>
43 | 		<dependency>
44 | 			<groupId>org.mybatis.generator</groupId>
45 | 			<artifactId>mybatis-generator-core</artifactId>
46 | 			<version>1.3.2</version>
47 | 		</dependency>
48 | 	</dependencies>
49 | </project>


--------------------------------------------------------------------------------
/src/main/java/com/xxg/mybatis/plugins/MySQLLimitPlugin.java:
--------------------------------------------------------------------------------
  1 | package com.xxg.mybatis.plugins;
  2 | 
  3 | import java.util.List;
  4 | 
  5 | import org.mybatis.generator.api.IntrospectedTable;
  6 | import org.mybatis.generator.api.PluginAdapter;
  7 | import org.mybatis.generator.api.dom.java.Field;
  8 | import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
  9 | import org.mybatis.generator.api.dom.java.JavaVisibility;
 10 | import org.mybatis.generator.api.dom.java.Method;
 11 | import org.mybatis.generator.api.dom.java.Parameter;
 12 | import org.mybatis.generator.api.dom.java.PrimitiveTypeWrapper;
 13 | import org.mybatis.generator.api.dom.java.TopLevelClass;
 14 | import org.mybatis.generator.api.dom.xml.Attribute;
 15 | import org.mybatis.generator.api.dom.xml.TextElement;
 16 | import org.mybatis.generator.api.dom.xml.XmlElement;
 17 | 
 18 | public class MySQLLimitPlugin extends PluginAdapter {
 19 | 
 20 | 	@Override
 21 | 	public boolean validate(List<String> list) {
 22 | 		return true;
 23 | 	}
 24 | 
 25 | 	/**
 26 | 	 * 为每个Example类添加limit和offset属性已经set、get方法
 27 | 	 */
 28 | 	@Override
 29 | 	public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
 30 | 
 31 | 		PrimitiveTypeWrapper integerWrapper = FullyQualifiedJavaType.getIntInstance().getPrimitiveTypeWrapper();
 32 | 
 33 | 		Field limit = new Field();
 34 | 		limit.setName("limit");
 35 | 		limit.setVisibility(JavaVisibility.PRIVATE);
 36 | 		limit.setType(integerWrapper);
 37 | 		topLevelClass.addField(limit);
 38 | 
 39 | 		Method setLimit = new Method();
 40 | 		setLimit.setVisibility(JavaVisibility.PUBLIC);
 41 | 		setLimit.setName("setLimit");
 42 | 		setLimit.addParameter(new Parameter(integerWrapper, "limit"));
 43 | 		setLimit.addBodyLine("this.limit = limit;");
 44 | 		topLevelClass.addMethod(setLimit);
 45 | 
 46 | 		Method getLimit = new Method();
 47 | 		getLimit.setVisibility(JavaVisibility.PUBLIC);
 48 | 		getLimit.setReturnType(integerWrapper);
 49 | 		getLimit.setName("getLimit");
 50 | 		getLimit.addBodyLine("return limit;");
 51 | 		topLevelClass.addMethod(getLimit);
 52 | 
 53 | 		Field offset = new Field();
 54 | 		offset.setName("offset");
 55 | 		offset.setVisibility(JavaVisibility.PRIVATE);
 56 | 		offset.setType(integerWrapper);
 57 | 		topLevelClass.addField(offset);
 58 | 
 59 | 		Method setOffset = new Method();
 60 | 		setOffset.setVisibility(JavaVisibility.PUBLIC);
 61 | 		setOffset.setName("setOffset");
 62 | 		setOffset.addParameter(new Parameter(integerWrapper, "offset"));
 63 | 		setOffset.addBodyLine("this.offset = offset;");
 64 | 		topLevelClass.addMethod(setOffset);
 65 | 
 66 | 		Method getOffset = new Method();
 67 | 		getOffset.setVisibility(JavaVisibility.PUBLIC);
 68 | 		getOffset.setReturnType(integerWrapper);
 69 | 		getOffset.setName("getOffset");
 70 | 		getOffset.addBodyLine("return offset;");
 71 | 		topLevelClass.addMethod(getOffset);
 72 | 
 73 | 		return true;
 74 | 	}
 75 | 
 76 | 	/**
 77 | 	 * 为Mapper.xml的selectByExample添加limit
 78 | 	 */
 79 | 	@Override
 80 | 	public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element,
 81 | 			IntrospectedTable introspectedTable) {
 82 | 
 83 | 		XmlElement ifLimitNotNullElement = new XmlElement("if");
 84 | 		ifLimitNotNullElement.addAttribute(new Attribute("test", "limit != null"));
 85 | 
 86 | 		XmlElement ifOffsetNotNullElement = new XmlElement("if");
 87 | 		ifOffsetNotNullElement.addAttribute(new Attribute("test", "offset != null"));
 88 | 		ifOffsetNotNullElement.addElement(new TextElement("limit ${offset}, ${limit}"));
 89 | 		ifLimitNotNullElement.addElement(ifOffsetNotNullElement);
 90 | 
 91 | 		XmlElement ifOffsetNullElement = new XmlElement("if");
 92 | 		ifOffsetNullElement.addAttribute(new Attribute("test", "offset == null"));
 93 | 		ifOffsetNullElement.addElement(new TextElement("limit ${limit}"));
 94 | 		ifLimitNotNullElement.addElement(ifOffsetNullElement);
 95 | 
 96 | 		element.addElement(ifLimitNotNullElement);
 97 | 
 98 | 		return true;
 99 | 	}
100 | }
101 | 


--------------------------------------------------------------------------------