下面将从零开始配置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>
分页查询测试
做完以上操作后,就可以真正开始编写分页查询了。假设我们有一张产品表,实现分页查询产品信息。
- 产品表结构
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='产品表';
在数据库中随便增加几条信息,方便查询看效果。
- 使用Mybatis-generator生成java的bean,dao,mapper。
- 编写分页查询测试类:
/**
* 产品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());
}
}
相关参考:
Mybatis 工具集
Mybatis 分页插件