MyBatis -- 必知必会 / 开普饭

顶哥说官网:www.dintalk.cn 同时更新!

MyBatis概述开发环境,流程及生命周期映射器动态sql和高级查询嵌套查询和延迟加载事务控制及数据源MyBatis的缓存附录:常用配置一:MyBatis概述MyBatis的前身是Apache的一个开源项目iBatis，2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis。2013年11月迁移到GitHub，因此目前MyBatis是由GitHub维护的。同样作为持久层框架的Hibernate在前些年非常的火，它在配置了映射文件和数据库连接文件后就可以通过Session操作，它甚至提供了HQL去操作POJO进而操作数据库的数据，几乎可以使编程人员脱离sql语言。可是为什么MyBatis却越来越受欢迎呢？我们稍稍总结如下：Hibernate: 1.不方便的全表映射，比如更新时需要发送所有的字段；2.无法根据不同的条件组装不同sql;3.对多表关联和复制sql查询支持较差；4.有HQL但性能较差，做不到sql优化；5.不能有效支持存储过程；在当今的大型互联网中，灵活、sql优化，减少数据的传递是最基本的优化方法，但是Hibernate却无法满足我们的需求，而MyBatis提供了更灵活、更方便的方法。在MyBatis里，我们需要自己编写sql，虽然比Hibernate配置要多，但是是MyBatis可以配置动态sql，也可以优化sql,且支持存储过程，MyBatis几乎能做到 JDBC 所能做到的所有事情！凭借其高度灵活、可优化、易维护等特点，成为目前大型移动互联网项目的首选框架。二：开发环境、流程及生命周期1.开发环境1.1 导入依赖jar包导入mybatis的jar包，如果采用Maven进行部署，只需导入mybatis坐标。导入数据库驱动jar包或坐标。代码调试阶段可导入日志工具jar包或坐标，如log4j。导入Junit单元测试坐标。1.2 创建mybatis的主配置文件在resources目录下建立一个名字为mybatis-config.xml（名称随意）配置文件，编写所需配置信息。1.3 准备实体类和表结构遵循开发规范：类属性命名尽量和表字段保持一致。实体类实现序列化接口。实体类属性使用包装类型定义，如Integer。Tips: 有时可以考虑通过定义时初始化来避免可能的空指针异常！如：private List<String> list = new ArrayList<>() ;1.4 创建Mapper接口（Dao接口）建立接口方法和sql映射文件创建Mapper接口，在内定义CRUD方法。**Tips:** 方法名唯一，需要在对应的mapper.xml文件中配置id。在resources下创建sql映射文件。**Tips:** 同对应的Mapper接口保持包结构及命名一致。如：Mapper接口：cn.dintalk.dao.UserMapper对应配置文件：cn.dintalk.dao.UserMapper.xml1.5 将映射文件加入到mybatis主配置文件中将映射文件通过引入的方式加入到mybatis的主配置文件中。**Tips:** 所有映射文件会随主配置文件在程序运行时加入内存，任一映射文件出错都会导致整个环境报错！（初学者经常搞混resultType和resultMap)。1.6 编写代码进行CRUD操作在映射文件中编写sql进行crud操作，在单元测试中，或service层中调用方法！2.开发流程环境搭建好后开发基本流程为：接口定义方法。Mapper.xml文件中编写sql。单元测试或service调用。Tips: 接口中方法名称和Mapper.xml文件中sql语句的id保持一致！3.生命周期MyBatis的核心组件：SqlSessionFactoryBuilder(构造器)：根据配置信息或代码生成SqlSessionFactorySqlSessionFactory(工厂接口):依靠工厂来生成SqlSession(会话)。SqlSession(会话): 既可以发生sql去执行并返回结果，也可以获取Mapper的接口SQL Mapper:它是MyBatis新设计的组件，它是由一个java接口和xml文件（或注解）构成的，需要给出对应的sql和映射规则。它负责发送sql去执行，并返回结果。正确理解并掌握上述核心组件的生命周期可以让我们写出高效的程序，还可避免带来严重的并发问题。3.1 SqlSessionFactoryBuilder其作用就是利用xml或java编码获得资源来构建SqlSessionFactory对象，构建成功就失去了存在的意义，将其回收。所以它的生命周期只存在于方法的局部。3.2 SqlSessionFactorySqlSessionFactory的作用是创建SqlSession，而SqlSession就是一个会话，相当于JDBC中的Connection对象，每次访问数据库都需要通过SqlSessionFactory创建SqlSession，所以SqlSessionFactory应该在MyBatis应用的整个生命周期中。我们使每一个数据库只对应一个SqlSessionFactory（单例模式）。3.3 SqlSessionSqlSession是一个会话，相当于JDBC的一个Connection对象，它的生命周期应该是在请求数据库处理事务的过程中。是一个线程不安全的对象，涉及多线程时格外当心。此外，每次创建的SqlSession都必须及时关闭它。3.4 MapperMapper是一个接口，没有任何实现类，其作用是发送sql,返回我们需要的结果，或者执行sql修改数据库数据，因此它也因该在一个SqlSession事务方法之内，是一个方法级别的东西。就如同 JDBC中的一条sql语句的执行，它的最大范围和SqlSession是相同的。Tips: 根据核心组件封装工具、形成SqlSession使用模板public class MyBatisUtil {private static SqlSessionFactory build =null;static {try { //使用MyBatis的Resources加载资源获得输入流，构建工厂InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");build = new SqlSessionFactoryBuilder().build(inputStream);} catch (IOException e) {throw new RuntimeException("资源文件加载失败!");}}//使用工厂生产sqlSessionpublic static SqlSession openSession(){return build.openSession();}}SqlSession使用方法//1.定义sqlSessionSqlSession sqlSession = null;try {sqlSession = openSession();//2.获取映射器UserMapper mapper = sqlSession.getMapper(UserMapper.class);//3.some code like 'User u = mapper.findById(id);'//4.sqlSession不提交默认回滚！增删改需格外注意！sqlSession.commit();} catch (Exception e) {throw new RuntimeException(e);} finally {if (sqlSession != null) {sqlSession.close();}}三：映射器1.映射器元素简介我们可以在映射器中定义哪些元素，以及它们有何作用呢？元素名称作用insert定义插入语句delete定义删除语句update定义修改语句select定义查询语句parameterMap定义参数映射关系resultMap提供从数据库结果集到POJO映射规则cache配置当前命名空间的缓存配置（二级缓存）sql定义部分sql，各个地方都可引用cache-ref引用其他命名空间的缓存配置在各个元素当中又有相当多的属性配置项，这里不多赘述，通过下一节掌握常用的内容即可。这里特别说明sql元素的使用：<sql id="user_columns"> id, name, password</sql><select ....>select <include refid="user_columns"/> from users where uid=#{id}</select>2.简单CRUD操作2.1添加用户<insert id="add" parameterType="User">INSERT into users (name,password) VALUES (#{name},#{password});</insert>2.2添加用户并返回数据库中的主键<insert id="add" parameterType="User" useGeneratedKeys="true" keyProperty="uid">insert into users (name,password) values(#{name},#{password});</insert><insert id="add" parameterType="User"><selectKey keyColumn="uid" keyProperty="uid" resultType="int" order="AFTER">select last_insert_id();</selectKey>insert into users (name,password) values(#{name},#{password});</insert>2.3修改/删除用户<update id="update" parameterType="User">update users set name=#{name},password=#{password} where uid=#{uid};</update><delete id="delete" >delete from users where uid=#{uid};</delete>2.4查询用户<resultMap id="userMap" type="User"><id column="id" property="uid"></id><result column="姓名" property="name"></result><result column="password" property="password"></result></resultMap><select id="findAll" resultMap="userMap">select uid as id,name as '姓名',password from users;</select><select id="findById" parameterType="int" resultType="User">select uid,name,password from users where uid=#{uid};</select><select id="findByNamePassword" resultType="User">select uid,name,password from users where name=#{name} and password=#{password};</select><select id="findByUser" parameterType="User" resultType="User">select uid,name,password from users where name=#{name};</select><select id="findUsersLikeName" resultType="User">select uid,name,password from users where name like concat("%",#{name},"%");</select>Tips: sql中如果有特殊符号可使用 <![CDATA[ ]]> 将语句抱起来。四：动态sql和高级查询1.动态sqlMyBatis的动态sql包含这些元素：if | choose(when ohterwise) |trim(where set) | foreach ，通过这些元素来动态组装sql语句，主要是增改查操作。(实际开发中，严禁使用select * 操作。这里为了简便使用select *演示）！1.1使用 if,实现动态sql,完成查询操作<select id="findByCondition" parameterType="user" resultType="user">select uid,name,password,email from users where 1 = 1<if test="name != null and name !=''">and name like concat("%",#{name},"%")</if><if test="password != null and password != '' ">and password = #{password}</if></select>1.2使用if,实现动态sql,完成更新操作<update id="updateUser" parameterType="user">update users set<if test="name != null and name != '' ">name=#{name},</if><if test="password != null and password != '' ">password=#{password},</if>uid=#{uid} where uid=#{uid}; </update>1.3使用if,实现动态sql,完成添加操作<insert id="addUser" parameterType="user">insert into users (name,<if test="password != null and password != '' ">password,</if>email,phoneNumber,birthday) values(#{name},<if test="password != null and password != '' ">#{password},</if>#{email},#{phoneNumber},#{birthday});</insert>1.4使用choose when otherwise,实现动态sql,完成查询操作<select id="findByCondition" parameterType="user" resultType="user">select * from users where 1 = 1 <choose><when test="name != null and name != '' ">and name like concat("%",#{name},"%");</when><otherwise>and 1 = 2; </otherwise></choose></select>1.5使用if和where,实现动态sql,完成查询操作 ★★★<select id="findByCondition" resultType="user" parameterType="user">select * from users<where> <if test="name != null and name != '' ">and name like concat("%",#{name},"%")</if><if test="password != null and password != '' ">and password=#{password}</if></where></select>1.6使用if和set,实现动态sql,完成更新操作 ★★<update id="updateUser" parameterType="user">update users<set> <if test="name != null and name != '' ">name=#{name},</if><if test="password != null and password != '' ">password=#{password},</if>uid=#{uid},</set>where uid=#{uid};</update><trim prefix="where" prefixOverrides="and|or"></trim> <trim prefix="set" suffixOverrides=","></trim> 1.7使用foreach,实现动态sql,完成根据id集合、数组等的查询操作<select id="findByIds" resultType="user">select * from users where uid in<foreach collection="collection" open="(" close=")" separator="," item="uid">#{uid}</foreach></select>1.8bind元素bind元素的作用是通过OGNL表达式自定义一个上下文变量，这样更方便我们使用。在进行模糊查询的时候，如果是MySQL数据库，我们常用concat函数用“%”和参数连接。然而在Oracle数据则是用连接符号“||”。这样sql就需要提供两种形式去实现。用bind元素，我们就不必使用数据库语言，只要使用MyBatis的语言即可与所需参数相连。<select id="findByCondition" parameterType="user" resultType="user"><bind name="pattern" value="'%' + name + '%' "/>select uid,name,password,email from users where 1 = 1<if test="name != null and name !=''">and name like #{pattern}</if><if test="password != null and password != '' ">and password = #{password}</if></select>2.高级查询（多表查询）2.1一对多关联查询<resultMap id="userMap" type="user"><id column="uid" property="uid" /><result column="name" property="name"/><result column="password" property="password"/></resultMap><resultMap id="userLoginInfoMap" extends="userMap" type="user"><collection property="loginInfos" ofType="loginInfo"><id column="lid" property="lid"/><result column="ip" property="ip"/><result column="loginTime" property="loginTime"/></collection></resultMap><select id="findAllUsers" resultMap="userLoginInfoMap">select * from users u left join login_infos li on u.uid = li.uid;</select>2.2多对一关联查询(别名映射|resultMap映射|resultMap结合association映射)<select id="findAllLoginInfos" resultType="loginInfo">select li.*,u.uid "user.uid",u.name "user.name",u.password "user.password"from login_infos li,users uwhere li.uid = u.uid;</select><resultMap id="userMap" type="loginInfo"><id column="uid" property="user.uid"/><result column="name" property="user.name"/><result column="password" property="user.password"/></resultMap><resultMap id="userLoginInfoMap" extends="userMap" type="loginInfo"><id column="lid" property="lid"/><result column="ip" property="ip"/><result column="loginTime" property="loginTime"/></resultMap><select id="findAllLoginInfos1" resultMap="userLoginInfoMap">select * from users u,login_infos li where u.uid=li.uid;</select><resultMap id="loginInfoMap" type="loginInfo"><id column="lid" property="lid"/><result column="ip" property="ip"/><result column="loginTime" property="loginTime"/></resultMap><resultMap id="loginInfoUserMap" extends="loginInfoMap" type="loginInfo"><association property="user" javaType="user"><id column="uid" property="uid"/><result column="name" property="name"/><result column="password" property="password"/></association></resultMap><select id="findAllLoginInfos2" resultMap="loginInfoUserMap">select * from users u,login_infos li where u.uid=li.uid;</select>2.3多对多关联查询<resultMap id="userRoleMap" extends="userMap" type="user"><collection property="roles" ofType="role"><id column="rid" property="rid"/><result column="name" property="name"/><result column="description" property="description"/></collection></resultMap><select id="findAllUsers" resultMap="userRoleMap">select * from users u left join users_roles uron u.uid=ur.uid inner join roles r on ur.rid=r.rid;</select>五：嵌套查询和延迟加载1.加载策略在关联查询时，对于关联的一方是否查询出来，要根据业务需求而定。不能通过编码方式进行策略的改变，而应该通过修改配置文件改变加载策略。可以使用嵌套查询（分步查询）。2.嵌套查询2.1根据多的一方，嵌套查询少的一方<resultMap id="loginInfoMap" type="loginInfo"><id column="lid" property="lid"/><result column="ip" property="ip"/><result column="loginTime" property="loginTime"/></resultMap><resultMap id="loginInfoUserMap" extends="loginInfoMap" type="loginInfo"><association property="user" column="uid"select="cn.dintalk.UserMapper.findById"/></resultMap><select id="findAllLoginInfos3" resultMap="loginInfoUserMap">select * from login_infos;</select><select id="findById" resultType="user">select * from users where uid = #{uid};</select>2.2根据少的一方，嵌套查询多的一方<resultMap id="userLoginInfoMap" extends="userMap" type="user"><collection property="loginInfos" column="uid"select="cn.dintalk.dao.LoginInfoMapper.findAllLoginInfos"/></resultMap><select id="findAllUser" resultMap="userLoginInfoMap1">select * from users;</select><select id="findAllLoginInfos" resultType="loginInfo">select * from login_infos where uid=#{uid};</select>3.配置延迟加载3.1全局配置，修改mybatis.xml主配置文件<settings><setting name="lazyLoadingEnabled" value="true"/><setting name="lazyLoadTriggerMethods" value=""/></settings>启用延迟加载后，mybatis默认有toString、equals等4个触发加载的方法。我们也可以将其覆盖掉。延迟加载，即用到关联数据的时候再去查，不用就不查。（service层中会有很多方法调用dao方法，根据service层中的实际需求动态调整加载策略，高效利用资源！)3.2每个association和collection都有fetchType属性该属性的值或覆盖掉全局配置fetchType="lazy"(默认） | eagerlazy ：支持延迟加载eager : 立即加载六：事务控制及数据源1.事务控制默认情况下：MySql的事务是自动提交的。通过 JDBC 可以手动控制：Connection.setAutoCommit(false);Connection.commit();Connection.rollback();// 开启事务后，未提交会自动回滚！MyBatis中: mybatis-config.xml 作如下配置<transactionManager type="JDBC"></transactionManager>相当于使用 JDBC 进行事务控制：（增删改时不提交会自动回滚！）获取SqlSession时：SqlSessionFactory.openSession(); // 手动控制事务 ★SqlSessionFactory.openSession(true); //自动提交事务2.数据源2.1mybatis内置数据源mybatis内置了三种数据源：UNPOOLED :不带有池（连接池）|学习时用POOLED : 带有池的 | 实际生产环境使用JNDI : mybatis提供的JndiDataSourceFactory来获取数据源2.2内部原理POOLED对应的是PooledDataSource数据源，PooledDataSourceFactory用来生产带有池的数据源。UNPOOLED对应的是UnpooledDataSource数据源，UnpooledDataSourceFactory用来生产不带有池的数据源。2.3使用Druid等第三方数据源(以Druid为例)第一步：引入Druid的Jar包或数据源<dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>1.1.14</version></dependency>第二步：编写工厂类，用来产生Druid的数据源，一般选择继承UnpooledDataSourceFactorypublic class DataSourceFactory extends UnpooledDataSourceFactory{public DataSourceFactory(){this.dataSource = new DruidDataSource();//创建druid数据源}}第三步：在mybatis-config.xml中进行配置<typeAliases><typeAlias type="cn.dintalk.dataSource.DataSourceFactory" alias="DRUID"/></typeAliases><environments default="mysql"><environment id="mysql"><transactionManager type="JDBC"></transactionManager><dataSource type="DRUID"><property name="driverClassName" value="${jdbc.driver}"></property><property name="url" value="${jdbc.url}"></property><property name="username" value="${jdbc.username}"></property><property name="password" value="${jdbc.password}"></property></dataSource></environment></environments>七：MyBatis的缓存1.系统缓存MyBatis对缓存提供支持，但是在没有配置的默认情况下，它只开启一级缓存。1.1一级缓存一级缓存只是相对于同一个SqlSession而言的。使用SqlSession第一次查询后，MyBatis会将其放在缓存中，以后再查询时，如果没有声明需要刷新，且缓存未超时的情况下，SqlSession都只会取出当前缓存的数据，而不会再次发送Sql到数据库。1.2二级缓存二级缓存是在SqlSessionFactory层面上的，可以将缓存提供给各个SqlSession对象共享。开启二级缓存配置mybatis-confi.xml文件中(默认开启，可忽略)<settings><setting name="cacheEnabled" value="true"/></settings>Mapper.xml文件中<mapper namespace="cn.dintalk.dao.UserMapper"><cache/> </mapper>Tips:一级缓存中存放的是对象本身，是同一个对象！二级缓存中存放的是对象的拷贝，对象所属类必须实现jav.io.Serializable接口!配置缓存<cache evicition="LRU" flushInterval="100000" size="1024" readOnly=true/>eviction: 代表的是缓存回收策略，目前MyBatis提供以下策略：（1）LRU, 最近最少使用的，移除最长时间不用的对象。（2）FIFO, 先进先出，按对象进入缓存的顺序来移除它们。（3）SOFT,软引用，移除基于垃圾回收器状态和软引用规则的对象。（4）WEAK,弱引用，更积极地移除基于垃圾收集器状态和弱引用规则的对象。flushInterval: 刷新间隔时间，单位为毫秒。size: 引用数目，代表缓存最多可以存储多少个对象。readOnly: 只读，意味着缓存数据只读。2.自定义缓存系统缓存是MyBatis应用机器上的本地缓存，我们也可以使用缓存服务器来定制缓存，如比较流行的Redis缓存。我们需要实现MyBatis为我们提供的接口org.apache.ibatis.cache.Cache,缓存接口简介：//获取缓存编号String getId();//保存key值缓存对象void putObject(Object key,Object value);//通过key获取缓存对象Object getObject(Object key);//通过key删除缓存对象Object removeObject(Object key);//清空缓存void clear();//获取缓存对象大小int getSize();//获取缓存的读写锁ReadWriterLock getReadWriterLock();由于每种缓存都有其不同的特点，上面的接口都需要我们去实现。假设我们已经有一个实现类：cn.dintalk.MyCache。则配置如下：<cache type="cn.dintalk.MyCache"/>完成上述配置，就能使用自定义的缓存了。MyBatis也支持在缓存中定义常用的属性，如：<cache type="cn.dintalk.MyCache"><property name="host" value="localhost"/></cache>如果我们在MyCache这个类中增加setHost(String host) 方法,那么它在初始化的时候就会被调用，这样我们可以对自定义的缓存设置一些外部参数。Tips: 我们也可配置Sql层面的缓存规则，来决定它们是否需要刷新或使用缓存。<insert ...flushCache="true"/><delete ...flushCache="true"/><update ...flushCache="true"/><select ...flushCache="false" useCache="true"/>八：附录-MyBatis常用配置附录1：mybatis-config.xml常用配置<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"><configuration><properties resource="jdbc.properties"/><settings><setting name="lazyLoadingEnabled" value="true"/><setting name="lazyLoadTriggerMethods" value=""/></settings><typeAliases><typeAlias type="cn.dintalk.dataSource.DataSourceFactory" alias="DRUID"/><package name="cn.dintalk.domain"/></typeAliases><environments default="mysql"><environment id="mysql"><transactionManager type="JDBC"></transactionManager><dataSource type="DRUID"><property name="driverClassName" value="${jdbc.driver}"></property><property name="url" value="${jdbc.url}"></property><property name="username" value="${jdbc.username}"></property><property name="password" value="${jdbc.password}"></property></dataSource></environment></environments><mappers><package name="cn.dintalk.dao"/></mappers></configuration>附录2：Mapper.xml头约束<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="cn.dintalk.dao.UserMapper"><cache/> </mapper>

MyBatis -- 必知必会

相关推荐