cn.easyproject.easymybatis.pagination.EasyMybatisPaginationPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of easymybatis-pagination Show documentation
EasyMyBatis Pagination is a generic paging plugin for the MyBaits framework. Provides the PageBean automatic paging data encapsulation, the EasyCriteria paging condition object, and the automated paging SQL that supports common databases.
The newest version!
package cn.easyproject.easymybatis.pagination;

import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;
import java.util.Properties;

import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.executor.statement.RoutingStatementHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * EasyMyBatis Pagination plugin
 * 
 *  * 
 * 	<plugins>
 *		 <plugin interceptor="cn.easyproject.easymybatis.pagination.EasyMybatisPaginationPlugin">
 *		 		<!-- required; ORACLE, ORACLE_12C, SQLSERVER, SQLSERVER_2012, MYSQL -->
 *		 		<property name="dialect" value="MYSQL"/>
 *		 </plugin>
 *	</plugins>
 * 
 * 
 * 
 * @author Ray
 * @author [email protected]
 * @author easyproject.cn
 * @see https://github.com/ushelp/EasyMyBatisPagination
 * @since 1.0.0
 */
@Intercepts({ @Signature(type = StatementHandler.class, method = "prepare", args = { Connection.class, Integer.class }),
		@Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class,
				RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class }),
		@Signature(type = Executor.class, method = "query", args = { MappedStatement.class, Object.class,
				RowBounds.class, ResultHandler.class }) })
public class EasyMybatisPaginationPlugin implements Interceptor {

	public static Logger logger = LoggerFactory.getLogger(EasyMybatisPaginationPlugin.class);

	private int dialect = -1;

	@SuppressWarnings({ "rawtypes", "unchecked" })
	public Object intercept(Invocation invocation) throws Throwable {
		if (invocation.getTarget() instanceof StatementHandler) {
			RoutingStatementHandler statementHandler = (RoutingStatementHandler) invocation.getTarget();
			Object args = statementHandler.getBoundSql().getParameterObject();
			if (args != null && args.getClass().equals(PageBean.class)) {
				PageBean pb = (PageBean) args;
				Connection connection = (Connection) invocation.getArgs()[0];
				PreparedStatement pstmt = null;
				ResultSet rs = null;
				try {
					pstmt = connection
							.prepareStatement(pb.getAutoCountSQL().replaceAll("\\#\\{[\\ ]*(\\S*)[\\ ]*\\}", "?"));
					statementHandler.parameterize(pstmt);
					rs = pstmt.executeQuery();
					if (rs.next()) {
						int totalRecord = rs.getInt(1);
						pb.setRowsCount(totalRecord);
					}
				} catch (SQLException e) {
					e.printStackTrace();
				} finally {
					try {
						if (rs != null)
							rs.close();
						if (pstmt != null)
							pstmt.close();
					} catch (SQLException e) {
						e.printStackTrace();
					}
				}
				// Statement statement = statementHandler.prepare(connection,
				// transactionTimeout);
				// statementHandler.parameterize(statement);
				// List list = statementHandler.query(statement, null);
				// pb.setData(list);
			}
			Object result = invocation.proceed();
			return result;
		} else if (invocation.getTarget() instanceof Executor) {
			if (invocation.getArgs() != null && invocation.getArgs().length > 2 && invocation.getArgs()[1] != null
					&& invocation.getArgs()[1].getClass().equals(PageBean.class)) {
				// Pagination
				PageBean pb = (PageBean) invocation.getArgs()[1];
				Executor ex = (Executor) invocation.getTarget();
				Connection connection = (Connection) ex.getTransaction().getConnection();

				// if not set dialect
				if (pb.getDialect() == -1) {
					// check default dialect parameter
					if (dialect == -1) {
						
						// Auto Identification dialect
						DatabaseMetaData dbmd = connection.getMetaData();
						String productName = dbmd.getDatabaseProductName().replace(" ", "").toLowerCase();
						String version = dbmd.getDriverVersion().replace(" ", "").toLowerCase();

						if (productName.contains("oracle") && version.startsWith("12.")) {
							dialect = PageBean.ORACLE_12C_DIALECT;
						} else if (productName.contains("oracle")) {
							dialect = PageBean.ORACLE_DIALECT;
						} else if (productName.contains("mysql")) {
							dialect = PageBean.MYSQL_DIALECT;
						} else if (productName.contains("sqlserver") && version.startsWith("sqlserver2012")) {
							dialect = PageBean.SQLSERVER_2012_DIALECT;
						} else if (productName.contains("sqlserver")) {
							dialect = PageBean.SQLSERVER_DIALECT;
						} else {
							
							if(pb.getAutoSQL().trim().equals("")){
								throw new EasyMyBatisPaginationException("Sorry, the database '"
										+ dbmd.getDatabaseProductName()
										+ "' now not support!"
										+ "Only support: "
										+ "oracle12c, oracle, sqlserver2012, sqlserver, mysql. "
										+ "Please "
										+ "use 'setSql','setCountSQL' to set your sql "
										+ "or "
										+ "edit source code write yourself support "
										+ "or contact '[email protected]'!");
							}
							
						
						}

					}

					pb.setDialect(dialect);
				}
			}

			Object result = invocation.proceed();

			if (invocation.getArgs() != null && invocation.getArgs().length > 2 && invocation.getArgs()[1] != null
					&& invocation.getArgs()[1].getClass().equals(PageBean.class)) {
				// Pagination
				PageBean pb = (PageBean) invocation.getArgs()[1];
				pb.setData((List) result);
			}
			return result;
		} else {
			return invocation.proceed();
		}
	}

	public Object plugin(Object target) {
		if (target instanceof StatementHandler) {
			return Plugin.wrap(target, this);
		} else if (target instanceof Executor) {
			return Plugin.wrap(target, this);
		} else {
			return target;
		}
	}

	public void setProperties(Properties properties) {
		Object dialectValue = properties.get("dialect");
		if (dialectValue == null) {
			logger.warn("EasyMyBatisPagination - the defualt 'dialect' parameter is not set!");
			return;
		}
		String dialectValueStr = dialectValue.toString();
		if (dialectValueStr.equalsIgnoreCase("ORACLE")) {
			dialect = PageBean.ORACLE_DIALECT;
		} else if (dialectValueStr.equalsIgnoreCase("ORACLE_12C")) {
			dialect = PageBean.ORACLE_12C_DIALECT;
		} else if (dialectValueStr.equalsIgnoreCase("SQLSERVER")) {
			dialect = PageBean.SQLSERVER_DIALECT;
		} else if (dialectValueStr.equalsIgnoreCase("SQLSERVER_2012")) {
			dialect = PageBean.SQLSERVER_2012_DIALECT;
		} else if (dialectValueStr.equalsIgnoreCase("MYSQL")) {
			dialect = PageBean.MYSQL_DIALECT;
		} else {
			logger.warn("EasyMyBatisPagination - Unkonw defualt 'dialect' parameter value '" + dialectValueStr + "'!");
			// throw new EasyMyBatisPaginationException("the dialect '" +
			// dialect + "' unkonw!");
		}
	}
}