Spring整合Mybatis实现一个简单的分页查询功能

上一篇:组织项目的目录结构

下面将从零开始配置Sprign和Mybatis,以实现一个简单的分页查询。
数据库为MySql,数据源为Druid。具体示例请访问:https://git.oschina.net/zhaowg3/ShopManage

下载Srping相关包并增加Spring配置文件

本例子使用Gradle构建,故在build.gradle中增加依赖即可,如果是非Gradle项目,可以自行下载,引入到工程中。

在build.gradle中增加依赖,下载spring相关的jar包。

/*spring框架*/
compile "org.springframework:spring-context:3.2.9.RELEASE"

在src/main/resources下面新建springContext.xml,该文件即spring的配置文件,后续的配置均放在该文件,包括数据库的配置,事物的配置等。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
    xmlns:tx="http://www.springframework.org/schema/tx" xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
           http://www.springframework.org/schema/context
           http://www.springframework.org/schema/context/spring-context-3.0.xsd
           http://www.springframework.org/schema/aop
           http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
           http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">
    <!-- 启动注解扫描 -->
    <context:annotation-config />
    <!-- 设定注解扫描基础包 -->
    <context:component-scan base-package="com.ai.emall" />  
</beans>

添加Druid数据源

下载mysql驱动和druid包。

在build.gradle中增加如下依赖

/*mysql驱动*/
compile 'mysql:mysql-connector-java:5.1.34'
/*druid数据连接池*/
compile "com.alibaba:druid:1.0.16"

新建存放Druid数据源信息的properties文件

例如,新建mybatis-emall.properties,内容如下:

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/gcf-emall?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true
jdbc.username=root
jdbc.password=root
#初始化连接数量
jdbc.initialSize=2
#最大并发连接数
jdbc.maxActive=4
#最小空闲连接数
jdbc.minIdle=3
#配置获取连接等待超时的时间
jdbc.maxWait=60000
#超过时间限制是否回收
jdbc.removeAbandoned=true
#超过时间限制多长
jdbc.removeAbandonedTimeout=180
#配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒
jdbc.timeBetweenEvictionRunsMillis=60000
#配置一个连接在池中最小生存的时间,单位是毫秒
jdbc.minEvictableIdleTimeMillis=300000
#用来检测连接是否有效的sql,要求是一个查询语句
jdbc.validationQuery=SELECT 1 FROM DUAL
#申请连接的时候检测
jdbc.testWhileIdle=true
#申请连接时执行validationQuery检测连接是否有效,配置为true会降低性能
jdbc.testOnBorrow=false
#归还连接时执行validationQuery检测连接是否有效,配置为true会降低性能
jdbc.testOnReturn=false
#打开PSCache,并且指定每个连接上PSCache的大小
jdbc.poolPreparedStatements=true
jdbc.maxPoolPreparedStatementPerConnectionSize=50
#属性类型是字符串,通过别名的方式配置扩展插件,常用的插件有: 监控统计用的filter:stat 日志用的filter:log4j
jdbc.filters=stat

在Spring配置文件中添加Druid数据源配置

<!-- 加载配置文件 -->
<bean id="propertyConfigurer"
    class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations">
        <list>
            <value>classpath:mybatis/mybatis-emall.properties</value>
        </list>
    </property>
</bean>
<!-- 配置数据源 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
    <property name="driverClassName" value="${jdbc.driverClassName}" />
    <property name="url" value="${jdbc.url}" />
    <property name="username" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />
     <!-- 初始化连接数量 -->        
   <property name="initialSize" value="${jdbc.initialSize}" />       
    <!-- 最大并发连接数 -->        
   <property name="maxActive" value="${jdbc.maxActive}" />                     
    <!-- 最小空闲连接数 -->        
    <property name="minIdle" value="${jdbc.minIdle}" />         
    <!-- 配置获取连接等待超时的时间 -->              
    <property name="maxWait" value="${jdbc.maxWait}" />         
    <!-- 超过时间限制是否回收 -->        
    <property name="removeAbandoned" value="${jdbc.removeAbandoned}" />         
    <!-- 超过时间限制多长; -->        
    <property name="removeAbandonedTimeout" value="${jdbc.removeAbandonedTimeout}" />         
    <!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 -->       
    <property name="timeBetweenEvictionRunsMillis" value="${jdbc.timeBetweenEvictionRunsMillis}" />     
    <!-- 配置一个连接在池中最小生存的时间,单位是毫秒 -->        
    <property name="minEvictableIdleTimeMillis" value="${jdbc.minEvictableIdleTimeMillis}" />         
    <!-- 用来检测连接是否有效的sql,要求是一个查询语句-->         
    <property name="validationQuery" value="${jdbc.validationQuery}" />        
    <!-- 申请连接的时候检测 -->        
    <property name="testWhileIdle" value="${jdbc.testWhileIdle}" />         
    <!-- 申请连接时执行validationQuery检测连接是否有效,配置为true会降低性能 -->        
    <property name="testOnBorrow" value="${jdbc.testOnBorrow}" />         
    <!-- 归还连接时执行validationQuery检测连接是否有效,配置为true会降低性能  -->        
    <property name="testOnReturn" value="${jdbc.testOnReturn}" />         
    <!-- 打开PSCache,并且指定每个连接上PSCache的大小 -->        
    <property name="poolPreparedStatements" value="${jdbc.poolPreparedStatements}" />              
    <property name="maxPoolPreparedStatementPerConnectionSize" value="${jdbc.maxPoolPreparedStatementPerConnectionSize}" />         
    <!--属性类型是字符串,通过别名的方式配置扩展插件,常用的插件有: 监控统计用的filter:stat 日志用的filter:log4j                防御SQL注入的filter:wall -->        
    <property name="filters" value="log4j" />               
</bean>

Spring事物配置

添加依赖

/*spring事物*/
compile 'org.springframework:spring-tx:3.2.9.RELEASE'
compile 'org.springframework:spring-jdbc:3.2.9.RELEASE'
/*支持aspectj*/
compile "org.aspectj:aspectjrt:1.7.1"
compile "org.aspectj:aspectjweaver:1.7.1"

springContext配置

<!-- Spring数据源事务管理器: -->
<bean id="transactionManager"
    class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="dataSource" />
</bean>
<!--AOP 事务配置 -->
<tx:advice id="txAdvice" transaction-manager="transactionManager">
    <tx:attributes>
        <tx:method name="save*" propagation="REQUIRED" rollback-for="Exception"/>
        <tx:method name="add*" propagation="REQUIRED" rollback-for="Exception"/>
        <tx:method name="insert*" propagation="REQUIRED" rollback-for="Exception"/>
        <tx:method name="update*" propagation="REQUIRED" rollback-for="Exception"/>
        <tx:method name="del*" propagation="REQUIRED" rollback-for="Exception"/>
        <tx:method name="*" />
    </tx:attributes>
</tx:advice>
<aop:config>
    <!-- 配置注入点 -->
    <aop:pointcut id="transactionPointcut" expression="execution(* com.ai.emall.business..*Impl.*(..))" />
    <aop:advisor pointcut-ref="transactionPointcut" advice-ref="txAdvice" />
</aop:config>
<!-- 使用annotation注解方式配置事务 -->
<tx:annotation-driven transaction-manager="transactionManager" />

Spring整合Mybatis配置

1. Mybatis-spring插件,配置创建session

具体使用可以参考:http://www.mybatis.org/spring/zh/index.html, 里面已经说的很详细了,我就不多说了,创建session有两种方法,1.使用SqlSessionTemplate,2.使用MapperScannerConfigurer,这里使用的是第二种。

在build.gradle中添加依赖

/*mybatis核心包*/
compile 'org.mybatis:mybatis:3.3.0'
/*mybatis-spring插件*/
compile 'org.mybatis:mybatis-spring:1.2.4'

在springContext.xml中增加创建session所需配置

<!-- 配置myBatis的sqlSessionFactory -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- 指定数据源 -->
    <property name="dataSource" ref="dataSource" />
    <!-- 指定mapper的xml文件位置 -->
    <property name="mapperLocations" value="classpath*:mybatis/*mapper/*.xml" />
</bean>
<!-- 使用MapperScannerConfigurer自动配置basePackage下面的所有映射器 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.ai.emall.dao" />
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
</bean>

2. Mybatis-generator插件,自动生成java代码

使用该插件可以自动生成mapper,bean,dao,很大的节约了开发时间,尤其是生成bean时同时生成example,example可以满足对单表的大部分操作,支持对每个字段的=,<,>,in,not in,is null,is not null,like,order by等常规操作,如果没有特殊需要,完成不需要再自己手写sql。

具体操作可以参考:Mybatis自动生成Dao,Bean,Mapper

3. Mybatis-pageHelper分页插件

详细操作和介绍请参考:https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md,这里我只说下我的配置和使用方式。

在build.gradle中添加依赖

/*mybatis分页插件*/
compile 'com.github.pagehelper:pagehelper:4.1.6'
compile 'com.github.jsqlparser:jsqlparser:0.9'

增加Mybatis配置文件,用以配置分页插件
在resource下面新建MybatisPlugin.xml,内容如下:

<?xml version="1.0" encoding="UTF-8" ?>  
<!DOCTYPE configuration  
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
"http://mybatis.org/dtd/mybatis-3-config.dtd">  
<!-- 配置管理器 -->  
<configuration>  
    <plugins>  
        <!-- com.github.pagehelper为PageHelper类所在包名 -->  
        <plugin interceptor="com.github.pagehelper.PageHelper">  
            <!-- 4.0.0以后版本可以不设置该参数 -->  
            <property name="dialect" value="mysql"/>   
            <!-- 和startPage中的pageNum效果一样-->  
            <property name="offsetAsPageNum" value="true"/>  
            <!-- 该参数默认为false -->  
            <!-- 设置为true时,使用RowBounds分页会进行count查询 -->  
            <property name="rowBoundsWithCount" value="true"/>  
            <!-- 设置为true时,如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->  
            <!-- (相当于没有执行分页查询,但是返回结果仍然是Page类型)-->  
            <property name="pageSizeZero" value="true"/>   
            <!-- 启用合理化时,如果pageNum<1会查询第一页,如果pageNum>pages会查询最后一页 -->  
            <!-- 禁用合理化时,如果pageNum<1或pageNum>pages会返回空数据 -->  
            <property name="reasonable" value="true"/>  
            <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->  
            <!-- 增加了一个`params`参数来配置参数映射,用于从Map或ServletRequest中取值 -->  
            <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默认值 -->  
            <!-- 不理解该含义的前提下,不要随便复制该配置 -->  
            <property name="params" value="pageNum=start;pageSize=limit;"/>  
            <!-- 支持通过Mapper接口参数来传递分页参数 -->  
            <property name="supportMethodsArguments" value="true"/>  
            <!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->  
            <property name="returnPageInfo" value="check"/>  
        </plugin>  
    </plugins>  
</configuration>

将上面的配置文件整合到spring中,在spirngContxt.xml的bean id=sqlSessionFactory下面增加
<property name="configLocation" value="classpath:mybatisPlugin.xml" />

<!-- 配置myBatis的sqlSessionFactory -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- 指定数据源 -->
    <property name="dataSource" ref="dataSource" />
    <!-- 指定mapper的xml文件位置 -->
    <property name="mapperLocations" value="classpath*:mybatis/*mapper/*.xml" />
    <!-- 设置配置文件地路径 -->
    <property name="configLocation" value="classpath:mybatisPlugin.xml" />
</bean>

分页查询测试

做完以上操作后,就可以真正开始编写分页查询了。假设我们有一张产品表,实现分页查询产品信息。

  1. 产品表结构
CREATE TABLE `product` (
  `PRODUCT_ID` bigint(9) NOT NULL auto_increment COMMENT '产品ID',
  `NAME` varchar(45) default NULL COMMENT '产品名称',
  `CREATER_ID` bigint(9) default NULL COMMENT '创建人',
  `CREATE_TIME` date default NULL COMMENT '创建时间',
  `MODIFIER_ID` bigint(9) default NULL COMMENT '修改人',
  `MODIFY_TIME` date default NULL COMMENT '修改时间',
  `PARAM` varchar(500) default NULL COMMENT '在线商品PRODUCT_ID和SKU_ID,用逗号分隔',
  `DRAINAGE_URL` varchar(300) default NULL COMMENT '引流URL',
  `SORT` bigint(15) default '0' COMMENT '排序',
  `PRODUCT_DESC` varchar(500) default NULL COMMENT '产品描述',
  PRIMARY KEY  (`PRODUCT_ID`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='产品表';

在数据库中随便增加几条信息,方便查询看效果。

  1. 使用Mybatis-generator生成java的bean,dao,mapper。
  2. 编写分页查询测试类:
/** 
 * 产品DAO相关操作测试
 * @author zhaowg3
 * @Date 2017年1月13日
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:springContext.xml")
public class ProductDaoTest {
    @Autowired
    private ProductMapper productMapper;
    
    /**
     * 测试分页查询
     * @throws Exception
     * @author zhaowg3
     * @Date 2017年1月16日
     */
    @Test
    public void testQueryByPage() throws Exception {
        ProductExample example = new ProductExample();
        //增加查询条件
        Criteria criteria = example.createCriteria();
        criteria.andCreaterIdEqualTo(123L);//创建人Id=123
        //增加排序
        example.setOrderByClause("product_id desc");//通过产品ID,降序排列
        //获取第1页,10条内容,默认查询总数count
        PageHelper.startPage(1, 10);
        List<Product> products = productMapper.selectByExample(example );
        if(CollectionUtils.isEmpty(products)){
            System.out.println("***************未查询到相关数据*************");
            return;
        }
        //将查询结果使用pageInfo包装
        PageInfo<Product> page = new  PageInfo<Product>(products);
        //测试PageInfo全部属性
        //PageInfo包含了非常全面的分页属性
        assertEquals(1, page.getPageNum());
        assertEquals(10, page.getPageSize());
        assertEquals(1, page.getStartRow());
        assertEquals(10, page.getEndRow());
        assertEquals(183, page.getTotal());
        assertEquals(19, page.getPages());
        assertEquals(1, page.getFirstPage());
        assertEquals(8, page.getLastPage());
        assertEquals(true, page.isIsFirstPage());
        assertEquals(false, page.isIsLastPage());
        assertEquals(false, page.isHasPreviousPage());
        assertEquals(true, page.isHasNextPage());
    }

}
分页查询测试

完整配置信息请参见:https://git.oschina.net/zhaowg3/ShopManage/tree/master/shopmanage-project/shpm-emall-project/src/main/resources

相关参考:
Mybatis 工具集
Mybatis 分页插件

下一篇:Spring 整合Dubbo提供服务

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,723评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,485评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,998评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,323评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,355评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,079评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,389评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,019评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,519评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,971评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,100评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,738评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,293评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,289评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,517评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,547评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,834评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,600评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,748评论 6 342
  • Spring 技术笔记Day 1 预热知识一、 基本术语Blob类型,二进制对象Object Graph:对象图...
    OchardBird阅读 961评论 0 2
  • 一 踩狗屎 有这么一个剑客,他的剑并没有达到最顶尖的水平。 但是大多江湖人却都有所耳闻他的名字。 因为他每次用剑都...
    月下破晓阅读 323评论 1 1
  • “腹有诗书气自华”这是我们对女生的一种评价。 倘若我们喜欢那个人,就会说好有气质,漂亮之类的话。 还记得开学第一课...
    青果果说阅读 223评论 0 4