MyBatis教程之分页和动态SQL语句基础

MyBatis教程之分页

上一篇文章里已经讲到了mybatis与spring MVC的集成，并且做了一个列表展示，显示出所有article 列表，但没有用到分页，在实际的项目中，分页是肯定需要的。而且是物理分页，不是内存分页。对于物理分页方案，不同的数据库，有不同的实现方法,对于mysql 来说 就是利用 limit offset,pagesize 方式来实现的。oracle 是通过rownum 来实现的，如果你熟悉相关数据库的操作，是一样的很好扩展，本文以mysql 为例子来讲述.先看一下效果图(源代码在文章最后提供下载):

实现mybatis 物理分页，一个最简单的方式是，是在你的mapper的SQL语句中直接写类似如下方式 :

<select id="getUserArticles" parameterType="Your_params" resultMap="resultUserArticleList">       select user.id,user.userName,user.userAddress,article.id aid,article.title,article.content from user,article               where user.id=article.userid and user.id=#{id} limit #{offset},#{pagesize}    </select>

请注意这里的 parameterType 是你传入的参数类，或者map ，里面包含了offset,pagesize ,和其他你需要的参数，用这种方式，肯定可以实现分页。这是简单的一种方式。但更通用的一种方式是用 mybatis 插件的方式. 参考了网上的很多资料 ，mybatis plugin 方面的资料。写自己的插件.

package com.yihaomen.util;import java.lang.reflect.Field;import java.sql.Connection;import java.sql.PreparedStatement;import java.sql.ResultSet;import java.sql.SQLException;import java.util.List;import java.util.Map;import java.util.Properties;import javax.xml.bind.PropertyException;import org.apache.ibatis.builder.xml.dynamic.ForEachSqlNode;import org.apache.ibatis.executor.ErrorContext;import org.apache.ibatis.executor.Executor;import org.apache.ibatis.executor.ExecutorException;import org.apache.ibatis.executor.statement.BaseStatementHandler;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.mapping.ParameterMapping;import org.apache.ibatis.mapping.ParameterMode;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.reflection.MetaObject;import org.apache.ibatis.reflection.property.PropertyTokenizer;import org.apache.ibatis.session.Configuration;import org.apache.ibatis.session.ResultHandler;import org.apache.ibatis.session.RowBounds;import org.apache.ibatis.type.TypeHandler;import org.apache.ibatis.type.TypeHandlerRegistry;@Intercepts({ @Signature(type = StatementHandler.class, method = "prepare", args = { Connection.class }) })public class PagePlugin implements Interceptor {    private static String dialect = "";    private static String pageSqlId = "";    @SuppressWarnings("unchecked")    public Object intercept(Invocation ivk) throws Throwable {        if (ivk.getTarget() instanceof RoutingStatementHandler) {            RoutingStatementHandler statementHandler = (RoutingStatementHandler) ivk                    .getTarget();            BaseStatementHandler delegate = (BaseStatementHandler) ReflectHelper                    .getValueByFieldName(statementHandler, "delegate");            MappedStatement mappedStatement = (MappedStatement) ReflectHelper                    .getValueByFieldName(delegate, "mappedStatement");            if (mappedStatement.getId().matches(pageSqlId)) {                BoundSql boundSql = delegate.getBoundSql();                Object parameterObject = boundSql.getParameterObject();                if (parameterObject == null) {                    throw new NullPointerException("parameterObject error");                } else {                    Connection connection = (Connection) ivk.getArgs()[0];                    String sql = boundSql.getSql();                    String countSql = "select count(0) from (" + sql + ") myCount";                    System.out.println("总数sql 语句:"+countSql);                    PreparedStatement countStmt = connection                            .prepareStatement(countSql);                    BoundSql countBS = new BoundSql(                            mappedStatement.getConfiguration(), countSql,                            boundSql.getParameterMappings(), parameterObject);                    setParameters(countStmt, mappedStatement, countBS,                            parameterObject);                    ResultSet rs = countStmt.executeQuery();                    int count = 0;                    if (rs.next()) {                        count = rs.getInt(1);                    }                    rs.close();                    countStmt.close();                    PageInfo page = null;                    if (parameterObject instanceof PageInfo) {                        page = (PageInfo) parameterObject;                        page.setTotalResult(count);                    } else if(parameterObject instanceof Map){                        Map<String, Object> map = (Map<String, Object>)parameterObject;                        page = (PageInfo)map.get("page");                        if(page == null)                            page = new PageInfo();                        page.setTotalResult(count);                    }else {                        Field pageField = ReflectHelper.getFieldByFieldName(                                parameterObject, "page");                        if (pageField != null) {                            page = (PageInfo) ReflectHelper.getValueByFieldName(                                    parameterObject, "page");                            if (page == null)                                page = new PageInfo();                            page.setTotalResult(count);                            ReflectHelper.setValueByFieldName(parameterObject,                                    "page", page);                        } else {                            throw new NoSuchFieldException(parameterObject                                    .getClass().getName());                        }                    }                    String pageSql = generatePageSql(sql, page);                    System.out.println("page sql:"+pageSql);                    ReflectHelper.setValueByFieldName(boundSql, "sql", pageSql);                }            }        }        return ivk.proceed();    }    private void setParameters(PreparedStatement ps,            MappedStatement mappedStatement, BoundSql boundSql,            Object parameterObject) throws SQLException {        ErrorContext.instance().activity("setting parameters")                .object(mappedStatement.getParameterMap().getId());        List<ParameterMapping> parameterMappings = boundSql                .getParameterMappings();        if (parameterMappings != null) {            Configuration configuration = mappedStatement.getConfiguration();            TypeHandlerRegistry typeHandlerRegistry = configuration                    .getTypeHandlerRegistry();            MetaObject metaObject = parameterObject == null ? null                    : configuration.newMetaObject(parameterObject);            for (int i = 0; i < parameterMappings.size(); i++) {                ParameterMapping parameterMapping = parameterMappings.get(i);                if (parameterMapping.getMode() != ParameterMode.OUT) {                    Object value;                    String propertyName = parameterMapping.getProperty();                    PropertyTokenizer prop = new PropertyTokenizer(propertyName);                    if (parameterObject == null) {                        value = null;                    } else if (typeHandlerRegistry                            .hasTypeHandler(parameterObject.getClass())) {                        value = parameterObject;                    } else if (boundSql.hasAdditionalParameter(propertyName)) {                        value = boundSql.getAdditionalParameter(propertyName);                    } else if (propertyName                            .startsWith(ForEachSqlNode.ITEM_PREFIX)                            && boundSql.hasAdditionalParameter(prop.getName())) {                        value = boundSql.getAdditionalParameter(prop.getName());                        if (value != null) {                            value = configuration.newMetaObject(value)                                    .getValue(                                            propertyName.substring(prop                                                    .getName().length()));                        }                    } else {                        value = metaObject == null ? null : metaObject                                .getValue(propertyName);                    }                    TypeHandler typeHandler = parameterMapping.getTypeHandler();                    if (typeHandler == null) {                        throw new ExecutorException(                                "There was no TypeHandler found for parameter "                                        + propertyName + " of statement "                                        + mappedStatement.getId());                    }                    typeHandler.setParameter(ps, i + 1, value,                            parameterMapping.getJdbcType());                }            }        }    }    private String generatePageSql(String sql, PageInfo page) {        if (page != null && (dialect !=null || !dialect.equals(""))) {            StringBuffer pageSql = new StringBuffer();            if ("mysql".equals(dialect)) {                pageSql.append(sql);                pageSql.append(" limit " + page.getCurrentResult() + ","                        + page.getShowCount());            } else if ("oracle".equals(dialect)) {                pageSql.append("select * from (select tmp_tb.*,ROWNUM row_id from (");                pageSql.append(sql);                pageSql.append(")  tmp_tb where ROWNUM<=");                pageSql.append(page.getCurrentResult() + page.getShowCount());                pageSql.append(") where row_id>");                pageSql.append(page.getCurrentResult());            }            return pageSql.toString();        } else {            return sql;        }    }    public Object plugin(Object arg0) {        // TODO Auto-generated method stub        return Plugin.wrap(arg0, this);    }    public void setProperties(Properties p) {        dialect = p.getProperty("dialect");        if (dialect ==null || dialect.equals("")) {            try {                throw new PropertyException("dialect property is not found!");            } catch (PropertyException e) {                // TODO Auto-generated catch block                e.printStackTrace();            }        }        pageSqlId = p.getProperty("pageSqlId");        if (dialect ==null || dialect.equals("")) {            try {                throw new PropertyException("pageSqlId property is not found!");            } catch (PropertyException e) {                // TODO Auto-generated catch block                e.printStackTrace();            }        }    }}

此插件有两个辅助类:PageInfo,ReflectHelper,你可以下载源代码参考。

写了插件之后，当然需要在 mybatis 的配置文件Configuration.xml 里配置这个插件

  <plugins>        <plugin interceptor="com.yihaomen.util.PagePlugin">            <property name="dialect" value="mysql" />            <property name="pageSqlId" value=".*ListPage.*" />        </plugin>    </plugins>

请注意，这个插件定义了一个规则，也就是在mapper中sql语句的id 必须包含ListPage才能被拦截。否则将不会分页处理.

插件写好了，现在就可以在 spring mvc 中的controller 层中写一个方法来测试这个分页:

@RequestMapping("/pagelist")    public ModelAndView pageList(HttpServletRequest request,HttpServletResponse response){        int currentPage = request.getParameter("page")==null?1:Integer.parseInt(request.getParameter("page"));        int pageSize = 3;        if (currentPage<=0){            currentPage =1;        }        int currentResult = (currentPage-1) * pageSize;                System.out.println(request.getRequestURI());        System.out.println(request.getQueryString());                PageInfo page = new PageInfo();        page.setShowCount(pageSize);        page.setCurrentResult(currentResult);        List<Article> articles=iUserOperation.selectArticleListPage(page,1);                System.out.println(page);                int totalCount = page.getTotalResult();                int lastPage=0;        if (totalCount % pageSize==0){            lastPage = totalCount % pageSize;        }        else{            lastPage =1+ totalCount / pageSize;        }                if (currentPage>=lastPage){            currentPage =lastPage;        }                String pageStr = "";        pageStr=String.format("<a href=\"%s\">上一页</a>    <a href=\"%s\">下一页</a>",                        request.getRequestURI()+"?page="+(currentPage-1),request.getRequestURI()+"?page="+(currentPage+1) );        //制定视图，也就是list.jsp        ModelAndView mav=new ModelAndView("list");        mav.addObject("articles",articles);        mav.addObject("pageStr",pageStr);        return mav;    }

然后运行程序，进入分页页面，你就可以看到结果了:

MyBatis教程之动态SQL语句

mybatis 的动态sql语句是基于OGNL表达式的。可以方便的在 sql 语句中实现某些逻辑. 总体说来mybatis 动态SQL 语句主要有以下几类:
1. if 语句 (简单的条件判断)
2. choose (when,otherwize) ,相当于java 语言中的 switch ,与 jstl 中的choose 很类似.
3. trim (对包含的内容加上 prefix,或者 suffix 等，前缀，后缀)
4. where (主要是用来简化sql语句中where条件判断的，能智能的处理 and or ,不必担心多余导致语法错误)
5. set (主要用于更新时)
6. foreach (在实现 mybatis in 语句查询时特别有用)
下面分别介绍这几种处理方式

mybaits if 语句处理 

   <select id="dynamicIfTest" parameterType="Blog" resultType="Blog">        select * from t_blog where 1 = 1        <if test="title != null">            and title = #{title}        </if>        <if test="content != null">            and content = #{content}        </if>        <if test="owner != null">            and owner = #{owner}        </if>    </select>

这条语句的意思非常简单，如果你提供了title参数，那么就要满足title=#{title}，同样如果你提供了Content和Owner的时候，它们也需要满足相应的条件，之后就是返回满足这些条件的所有Blog，这是非常有用的一个功能，以往我们使用其他类型框架或者直接使用JDBC的时候， 如果我们要达到同样的选择效果的时候，我们就需要拼SQL语句，这是极其麻烦的，比起来，上述的动态SQL就要简单多了

choose (when,otherwize) ,相当于java 语言中的 switch ,与 jstl 中的choose 很类似 

<select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">        select * from t_blog where 1 = 1         <choose>            <when test="title != null">                and title = #{title}            </when>            <when test="content != null">                and content = #{content}            </when>            <otherwise>                and owner = "owner1"            </otherwise>        </choose>    </select>

when元素表示当when中的条件满足的时候就输出其中的内容，跟JAVA中的switch效果差不多的是按照条件的顺序，当when中有条件满足的时候，就会跳出choose，即所有的when和otherwise条件中，只有一个会输出，当所有的我很条件都不满足的时候就输出otherwise中的内容。所以上述语句的意思非常简单， 当title!=null的时候就输出and titlte = #{title}，不再往下判断条件，当title为空且content!=null的时候就输出and content = #{content}，当所有条件都不满足的时候就输出otherwise中的内容。

trim (对包含的内容加上 prefix,或者 suffix 等，前缀，后缀) 

<select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">        select * from t_blog         <trim prefix="where" prefixOverrides="and |or">            <if test="title != null">                title = #{title}            </if>            <if test="content != null">                and content = #{content}            </if>            <if test="owner != null">                or owner = #{owner}            </if>        </trim>    </select>

trim元素的主要功能是可以在自己包含的内容前加上某些前缀，也可以在其后加上某些后缀，与之对应的属性是prefix和suffix；可以把包含内容的首部某些内容覆盖，即忽略，也可以把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正因为trim有这样的功能，所以我们也可以非常简单的利用trim来代替where元素的功能。

where (主要是用来简化sql语句中where条件判断的，能智能的处理 and or 条件

  <select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">        select * from t_blog         <where>            <if test="title != null">                title = #{title}            </if>            <if test="content != null">                and content = #{content}            </if>            <if test="owner != null">                and owner = #{owner}            </if>        </where>    </select><span style="font-family: 微软雅黑, Verdana, Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);">       </span>

where元素的作用是会在写入where元素的地方输出一个where，另外一个好处是你不需要考虑where元素里面的条件输出是什么样子的，MyBatis会智能的帮你处理，如果所有的条件都不满足那么MyBatis就会查出所有的记录，如果输出后是and 开头的，MyBatis会把第一个and忽略，当然如果是or开头的，MyBatis也会把它忽略；此外，在where元素中你不需要考虑空格的问题，MyBatis会智能的帮你加上。像上述例子中，如果title=null， 而content != null，那么输出的整个语句会是select * from t_blog where content = #{content}，而不是select * from t_blog where and content = #{content}，因为MyBatis会智能的把首个and 或 or 给忽略。

set (主要用于更新时)

 <update id="dynamicSetTest" parameterType="Blog">        update t_blog        <set>            <if test="title != null">                title = #{title},            </if>            <if test="content != null">                content = #{content},            </if>            <if test="owner != null">                owner = #{owner}            </if>        </set>        where id = #{id}    </update>

set元素主要是用在更新操作的时候，它的主要功能和where元素其实是差不多的，主要是在包含的语句前输出一个set，然后如果包含的语句是以逗号结束的话将会把该逗号忽略，如果set包含的内容为空的话则会出错。有了set元素我们就可以动态的更新那些修改了的字段。

foreach (在实现 mybatis in 语句查询时特别有用) 

foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。item表示集合中每一个元素进行迭代时的别名，index指定一个名字，用于表示在迭代过程中，每次迭代到的位置，open表示该语句以什么开始，separator表示在每次进行迭代之间以什么符号作为分隔符，close表示以什么结束，在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：
如果传入的是单参数且参数类型是一个List的时候，collection属性值为list
如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array
如果传入的参数是多个的时候，我们就需要把它们封装成一个Map了，当然单参数也可以封装成map，实际上如果你在传入参数的时候，在MyBatis里面也是会把它封装成一个Map的，map的key就是参数名，所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key

单参数List的类型

<select id="dynamicForeachTest" resultType="Blog">        select * from t_blog where id in        <foreach collection="list" index="index" item="item" open="(" separator="," close=")">            #{item}        </foreach>    </select><span style="font-family: 微软雅黑, Verdana, Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);">        </span>

上述collection的值为list，对应的Mapper是这样的

public List<Blog> dynamicForeachTest(List<Integer> ids); 

测试代码：

  @Test    public void dynamicForeachTest() {        SqlSession session = Util.getSqlSessionFactory().openSession();        BlogMapper blogMapper = session.getMapper(BlogMapper.class);        List<Integer> ids = new ArrayList<Integer>();        ids.add(1);        ids.add(3);        ids.add(6);        List<Blog> blogs = blogMapper.dynamicForeachTest(ids);        for (Blog blog : blogs)            System.out.println(blog);        session.close();    }

数组类型的参数

  <select id="dynamicForeach2Test" resultType="Blog">        select * from t_blog where id in        <foreach collection="array" index="index" item="item" open="(" separator="," close=")">            #{item}        </foreach>    </select>

对应mapper

public List<Blog> dynamicForeach2Test(int[] ids);  

Map 类型的参数

 <select id="dynamicForeach3Test" resultType="Blog">        select * from t_blog where title like "%"#{title}"%" and id in        <foreach collection="ids" index="index" item="item" open="(" separator="," close=")">            #{item}        </foreach>    </select>

mapper 应该是这样的接口:

public List<Blog> dynamicForeach3Test(Map<String, Object> params); 

通过以上方法，就能完成一般的mybatis 的 动态SQL 语句.最常用的就是  if where foreach这几个，一定要重点掌握。

源码下载：

MyBatis教程之分页      点击下载

文章出处 ：http://www.yihaomen.com/article/java/302.htm