一 、 Mybatis概览
说到mybatis就不得不说ORM框架，即对象-关系映射（Object-Relational Mapping），面向对象的开发方法是当今企业级应用开发环境中的主流开发方法，关系数据库是企业级应用环境中永久存放数据的主流数据存储系统。对象和关系数据是业务实体的两种表现形式，业务实体在内存中表现为对象，在数据库中表现为关系数据。内存中的对象之间存在关联和继承关系，而在数据库中，关系数据无法直接表达多对多关联和继承关系。因此，对象-关系映射(ORM)系统一般以中间件的形式存在，主要实现程序对象到关系数据库数据的映射。
1. Mybatis的框架设计
MyBatis本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation迁移到了google code，并且改名为MyBatis 。iBATIS一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架
mybatis框架图
接口层
Mybatis和数据库交互的两种方式：
-
使用传统的Mybatis提供的api
传递查询语句和查询参数给SqlSession对象，使用SqlSession对象完成和数据库的交互；Mybatis提供了非常方便的api，供用户实现对数据库的增删改查。
mybatis api具体的SqlSession提供的接口如下：
public interface SqlSession extends Closeable { <T> T selectOne(String var1); <T> T selectOne(String var1, Object var2); <E> List<E> selectList(String var1); <E> List<E> selectList(String var1, Object var2); <E> List<E> selectList(String var1, Object var2, RowBounds var3); <K, V> Map<K, V> selectMap(String var1, String var2); <K, V> Map<K, V> selectMap(String var1, Object var2, String var3); <K, V> Map<K, V> selectMap(String var1, Object var2, String var3, RowBounds var4); <T> Cursor<T> selectCursor(String var1); <T> Cursor<T> selectCursor(String var1, Object var2); <T> Cursor<T> selectCursor(String var1, Object var2, RowBounds var3); void select(String var1, Object var2, ResultHandler var3); void select(String var1, ResultHandler var2); void select(String var1, Object var2, RowBounds var3, ResultHandler var4); int insert(String var1); int insert(String var1, Object var2); int update(String var1); int update(String var1, Object var2); int delete(String var1); int delete(String var1, Object var2); //事务提交 void commit(); void commit(boolean var1); //事务回滚 void rollback(); void rollback(boolean var1); List<BatchResult> flushStatements(); //关闭连接 void close(); void clearCache(); Configuration getConfiguration(); <T> T getMapper(Class<T> var1); //连接数据库 Connection getConnection(); }
上述使用MyBatis 的方法，是创建一个和数据库打交道的SqlSession对象，然后根据Statement Id 和参数来操作数据库，这种方式固然很简单和实用，但是它不符合面向对象语言的概念和面向接口编程的编程习惯。由于面向接口的编程是面向对象的大趋势，MyBatis 为了适应这一趋势，增加了第二种使用MyBatis 支持接口（Interface）调用方式。
-
使用Mapper接口
MyBatis 将配置文件中的每一个<mapper> 节点抽象为一个 Mapper 接口，而这个接口中声明的方法和跟<mapper> 节点中的<select|update|delete|insert> 节点项对应，即<select|update|delete|insert> 节点的id值为Mapper 接口中的方法名称，parameterType 值表示Mapper 对应方法的入参类型，而resultMap 值则对应了Mapper 接口表示的返回值类型或者返回结果集的元素类型。<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="org.cloud.dao.RandomGener_Dao"> <resultMap type="org.cloud.model.RandomId" id="getId_List"> <id column="id" property="id"/> </resultMap> <select id="selectUnusingId" resultType="Integer"> SELECT id FROM randomID where tag = 0 limit 1 for UPDATE </select> <update id="updateId" parameterType="Integer"> UPDATE randomID set tag=1 where id = #{id} </update> </mapper>
然后编写对应接口文件
public interface RandomGener_Dao {
//搜索tag不为1的id
Integer selectUnusingId();
//更新tag 为1
void updateId(@Param("id") Integer id);
}
根据MyBatis 的配置规范配置好后，通过SqlSession.getMapper(XXXMapper.class) 方法，MyBatis 会根据相应的接口声明的方法信息，通过动态代理机制生成一个Mapper 实例，我们使用Mapper 接口的某一个方法时，MyBatis 会根据这个方法的方法名和参数类型，确定Statement Id，底层还是通过SqlSession.select("statementId",parameterObject);或者SqlSession.update("statementId",parameterObject); 等等来实现对数据库的操作。
数据处理层
数据处理层是Mybatis 的核心，它主要完成三个功能：
- 通过传入参数构建动态sql语句
动态语句生成可以说是MyBatis框架非常优雅的一个设计，MyBatis 通过传入的参数值，使用 Ognl 来动态地构造SQL语句，使得MyBatis 有很强的灵活性和扩展性。参数映射指的是对于java 数据类型和jdbc数据类型之间的转换：这里有包括两个过程：查询阶段，我们要将java类型的数据，转换成jdbc类型的数据，通过preparedStatement.setXXX()来设值；另一个就是对resultset查询结果集的jdbcType 数据转换成java 数据类型。 - sql语句的执行
- 封装查询结果转化为List<E>
框架支撑层
- 事务管理机制
- 连接池管理机制
- 缓存机制
为了提高数据利用率和减小服务器和数据库的压力，MyBatis 会对于一些查询提供会话级别的数据缓存，会将对某一次查询，放置到SqlSession 中，在允许的时间间隔内，对于完全相同的查询，MyBatis 会直接将缓存结果返回给用户，而不用再到数据库中查找。
引导层
引导层是配置和启动MyBatis 配置信息的方式。MyBatis 提供两种方式来引导MyBatis ：基于XML配置文件的方式和基于Java API 的方式，我们将在下面介绍spring整合mybatis的配置信息。
2. Mybatis的主要构件及相互关系
mybatis的主要核心部件：
| 组件 | 说明 |
|---|---|
| SqlSession | 每一个SqlSession实例代表应用程序和数据库的一次连接 ,每次打开一个SqlSession都会绑定一个事务管理实例，执行器实例。 |
| Executor | MyBatis执行器，是MyBatis 调度的核心，负责SQL语句的生成和查询缓存的维护 |
| MappedStatement | MappedStatement维护了一条<select update delete insert>节点的封装 |
| Configuration | MyBatis所有的配置信息都维持在Configuration对象之中。 |
二、Spring整合mybatis
1. 配置Mybatis
-
在pom中添加mybatis包
<!--mybatis 包--> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.2</version> </dependency> <!--mybatis 整合spring的适配包--> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.3.1</version> </dependency> <!--数据库连接池--> <dependency> <groupId>c3p0</groupId> <artifactId>c3p0</artifactId> <version>0.9.1.2</version> </dependency> <!--java mysql驱动版本要与mysql数据库的版本对应--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.11</version> </dependency> -
在spring容器的配置文件中整合mybatis
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"> <property name="jdbcUrl" value="${db.url}"></property> <property name="driverClass" value="${db.driver}"></property> <property name="user" value="${db.user}"></property> <property name="password" value="${db.pw}"></property> </bean> <!--整合 mybatis--> <bean id="sessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <!--指定mybatis的全局配置文件--> <property name="configLocation" value="classpath:mybatis-config.xml"></property> <property name="mapperLocations" value="classpath:mapper/*.xml"></property> <property name="dataSource" ref="dataSource"></property> <!--<property name="mapperLocations" value="classpath*:mapper/*.xml"></property>--> </bean> <!--配置扫描器 将mybatis接口实现加入到ioc容器中--> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.hust.dao" ></property> </bean> <!--事务控制 为了便于管理数据库--> <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <!--配置数据源--> <property name="dataSource" ref="dataSource"/> <!--开启基于注解的事务 或者是xml配置事务--> </bean> <!--配置一个可以批量执行的sqlSession--> <bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate"> <constructor-arg name="sqlSessionFactory" ref="sessionFactory"/> <constructor-arg name="executorType" value="BATCH"/> </bean>Spring 中的 DataSourceTransactionManager用来管理事务，它允许mybatis参与到Spring的事务管理中，而不是为mybatis创建一个新的特定的事务管理器。要注意, 为事务管理器指定的 DataSource 必须和用来创建 SqlSessionFactoryBean 的 是同一个数据源,否则事务管理器就无法工作了。
-
mybatis逆向生成工具
mybatsi逆向生成工具可以根据数据库中的的字段，创建相应的pojo类以及其对应的mapper.xml文件，mapper中包含一些常用的CRUD方法。
首先在pom中加入依赖<!--mybatis 逆向生成工具--> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.5</version> </dependency>然后添加mbg.xml配置文件
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <generatorConfiguration> <properties resource="db.properties"></properties> <!--配置数据库连接信息--> <context id="DB2Tables" targetRuntime="MyBatis3"> <!--不让生成注释--> <commentGenerator> <property name="suppressAllComments" value="true"></property> </commentGenerator> <!--idea 将&当成了特殊符号 这里需要转义 & = &--> <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/gm?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT&useSSL=false" userId="root" password="root"> </jdbcConnection> <javaTypeResolver > <property name="forceBigDecimals" value="false" /> </javaTypeResolver> <!--指定javabean的生成位置--> <javaModelGenerator targetPackage="com.hust.bean" targetProject=".\src\main\java"> <property name="enableSubPackages" value="true" /> <property name="trimStrings" value="true" /> </javaModelGenerator> <!--指定sql映射文件的位置--> <sqlMapGenerator targetPackage="mapper" targetProject=".\src\main\resources"> <property name="enableSubPackages" value="true" /> </sqlMapGenerator> <!--指定dao接口的生成位置--> <javaClientGenerator type="XMLMAPPER" targetPackage="com.hust.dao" targetProject=".\src\main\java"> <property name="enableSubPackages" value="true" /> </javaClientGenerator> <!--指定每个表的生成策略--> <table tableName="mg_employee" domainObjectName="Employee" ></table> <table tableName="mg_inventory" domainObjectName="Inventory"></table> <table tableName="mg_sale" domainObjectName="Sale"></table> <table tableName="mg_user" domainObjectName="User"></table> </context> </generatorConfiguration>
配置文件中的注释对各个节点的作用进行了详细的说明
编写一个测试类生成对应的pojo类和mapper文件
public class Mbg {
public static void main(String[] args) throws Exception {
List<String> warnings = new ArrayList<>();
boolean overwrite = true;
File configFile = new File("E:mbg.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration configuration = cp.parseConfiguration(configFile);
//是否覆盖已有的文件
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator generator = new MyBatisGenerator(configuration,callback,warnings);
generator.generate(null);
Logger logger = LogManager.getLogger("info");
logger.info("mybatis逆向生成工具完成任务");
}
}
三、pageHelper分页工具
pagehelper是一款由国人编写的开源免费的mybatis第三方物理插件，我们可以在github上看到它的源码，下面我们介绍一下mybatis的基本使用以及它的实现原理。
1. PageHelper的配置
引入maven依赖
<!--分页工具-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.0.0</version>
</dependency>
将pagehelper整合到mybatis中
<!--配置分页插件-->
<plugins>
<plugin interceptor="com.github.pagehelper.PageInterceptor">
<!--指定数据库-->
<property name="dialect" value="mysql" />
<!-- 该参数默认为false -->
<!-- 设置为true时，会将RowBounds第一个参数offset当成pageNum页码使用 -->
<!-- 和startPage中的pageNum效果一样 -->
<property name="offsetAsPageNum" value="false" />
<!-- 该参数默认为false -->
<!-- 设置为true时，使用RowBounds分页会进行count查询 -->
<property name="rowBoundsWithCount" value="true" />
<!-- 设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->
<!-- （相当于没有执行分页查询，但是返回结果仍然是Page类型） <property name="pageSizeZero" value="true"/> -->
<!-- 3.3.0版本可用 - 分页参数合理化，默认false禁用 -->
<!-- 启用合理化时，如果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,不配置映射的用默认值 -->
<!-- 不理解该含义的前提下，不要随便复制该配置 <property name="params" value="pageNum=start;pageSize=limit;"/> -->
</plugin>
</plugins>
2. PageHelper原理分析
pagehelper通过mybatis的plugin实现了interceptor接口
分页实现过程
实现原理：
pageHelper会使用ThreadLocal获取到同一线程中的变量信息，各个线程之间的Threadlocal不会相互干扰，也就是Thread1中的ThreadLocal1之后获取到Tread1中的变量的信息，不会获取到Thread2中的信息
所以在多线程环境下，各个Threadlocal之间相互隔离，可以实现，不同thread使用不同的数据源或不同的Thread中执行不同的SQL语句
所以，PageHelper利用这一点通过拦截器获取到同一线程中的预编译好的SQL语句之后将SQL语句包装成具有分页功能的SQL语句，并将其再次赋值给下一步操作，所以实际执行的SQL语句就是有了分页功能的SQL语句
关于pagehelper的更详细的实现，可以查看这篇博文
