mybatis使用总结

 一、简介

1、介绍

MyBatis最初是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation迁 移到了Google Code。随着开发团队转投Google Code旗下， iBatis3.x正式更名为MyBatis。

1） MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架

2） MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集

3） MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录

4） MyBatis 是一个 半自动的ORM（Object Relation Mapping）框架

5）官网地址：mybatis – MyBatis 3 | 简介

2、下载

MyBatis下载地址：https://github.com/mybatis/mybatis-3

 

二、入门项目

1、创建maven工程引入依赖

org.mybatis
mybatis
3.5.7



mysql
mysql-connector-java
8.0.16

 2、创建配置文件

习惯上命名为mybatis-config.xml，这个文件名仅仅只是建议，并非强制要求。后续和Spring整合 之后，这个配置文件可以省略，所以大家操作时可以直接复制、粘贴。 核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息， 配置文件存放的位置是src/main/resources目录下

连接信息几点说明： 

MySQL 5版本的url是 jdbc:mysql://localhost:3306/ssm

如果没有设置数据库编码，url还需跟上编码设置，但是mysql8不用跟编码，默认就是utf-8

MySQL 8版本url是 jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC 

MySQL 5版本使用jdbc5驱动，驱动类使用：com.mysql.jdbc.Driver

MySQL 8版本使用jdbc8驱动，驱动类使用：com.mysql.cj.jdbc.Driver

3、创建mapper接口

MyBatis中的mapper接口相当于以前的dao。但是区别在于，mapper仅仅是接口，我们不需要 提供实现类

public interface UserMapper { 
    /** * 添加用户信息 */ 
    int insertUser(); 
}

4、创建MyBatis的映射文件

1）、映射文件的命名规则： 表所对应的实体类的类名+Mapper.xml 例如：表t_user，映射的实体类为User，所对应的映射文件为UserMapper.xml 因此一个映射文件对应一个实体类，对应一张表的操作 MyBatis映射文件用于编写SQL，访问以及操作表中的数据 MyBatis映射文件存放的位置是src/main/resources/mappers目录下

2）、 MyBatis中可以面向接口操作数据，要保证两个一致：

a>mapper接口的全类名和映射文件的命名空间（namespace）保持一致

b>mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致

    
    insert into t_user values(null,'admin','123456',23,'男','[email protected]')
    

 5、测试

//读取MyBatis的核心配置文件
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        //创建SqlSessionFactoryBuilder对象
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new
                SqlSessionFactoryBuilder();
        //通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory，生产SqlSession对象
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
        //创建SqlSession对象，此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务
        //SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建SqlSession对象，此时通过SqlSession对象所操作的sql都会自动提交
        SqlSession sqlSession = sqlSessionFactory.openSession(true);
        //通过代理模式创建UserMapper接口的代理实现类对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        //调用UserMapper接口中的方法，就可以根据UserMapper的全类名匹配元素文件，通过调用的方法名匹配
        映射文件中的SQL标签，并执行标签中的SQL语句
        int result = userMapper.insertUser();
        //sqlSession.commit();
        System.out.println("结果：" + result);

SqlSession：代表Java程序和数据库之间的会话

SqlSessionFactory：是“生产”SqlSession的“工厂”

工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的 相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象。 

三、核心配置文件

四、MyBatis获取参数值

1、获取参数值的两种方式

${}获取：本质就是字符串拼接，使用字符串拼接的方式拼接sql，若为字符串类型或日期类型的字段进行赋值时，需要手动加单 引 号

#{}获取：本质就是占位符赋值，使用占位符赋值的方式拼接sql，此时为字符串类型或日期类型的字段进行赋值时， 可以自 动添加单引号

2、单个字面量类型的参数

若mapper接口中的方法参数为单个的字面量类型 此时可以使用${}和#{}以任意的名称获取参数的值，注意${}需要手动加单引号

select * from user where username= #{username}

select * from user where username= '${username}'

3、多个字面量类型的参数

若mapper接口中的方法参数为多个时 此时MyBatis会自动将这些参数放在一个map集合中，

第一种以arg0,arg1...为键，以参数为值；

第二种以 param1,param2...为键，以参数为值；

因此只需要通过${}和#{}访问map集合的键arg0,arg1...或param1,param2...就可以获取相 对应的 值，注意${}需要手动加单引号

4、map集合类型的参数

若mapper接口中的方法需要的参数为多个时，此时可以手动创建map集合，将这些数据放在 map中 只需要通过${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号

5、实体类类型的参数

若mapper接口中的方法参数为实体类对象时 此时可以使用${}和#{}，通过访问实体类对象中的属性名获取属性值，注意${}需要手动加单引号

6、使用@Param标识参数

可以通过@Param注解标识mapper接口中的方法参数 此时，会将这些参数放在map集合中，以@Param注解的value属性值为键，

以参数为值；以 param1,param2...为键，以参数为值；

只需要通过${}和#{}访问map集合的键就可以获取相对应 的值， 注意${}需要手动加单引号

五、查询

1、查询一个实体对象

select * from t_user where id = #{id}

 2、查询一个list集合

select * from t_user

返回值是User,不是全包名，是因为配置了实体别名

3、查询单个数据

在MyBatis中，对于Java中常用的类型都设置了类型别名 

例如：

java.lang.Integer-->int|integer 

int-->_int|_integer 

Map-->map,List-->list 

select count(id) from t_user

4、查询一条数据为map集合

select * from t_user where id = #{id}

 5、查询多条数据为map集合

方式一：

将表中的数据以map集合的方式查询，一条数据对应一个map；若有多条数据，就会产生多个map集合，此 时可以将这些map放在一个list集合中获取

List> getAllUserToMap();

select * from t_user

方式二：

将表中的数据以map集合的方式查询，一条数据对应一个map；若有多条数据，就会产生多个map集合，并 且最终要以一个map的方式返回数据，此时需要通过@MapKey注解设置map集合的键，值是每条数据所对应的 map集合

@MapKey("id")
Map getAllUserToMap();


    select * from t_user


结果
{
1={password=123456, sex=男, id=1, age=23, username=admin},
2={password=123456, sex=男, id=2, age=23, username=张三},
3={password=123456, sex=男, id=3, age=23, username=张三}
}

六、特殊SQL的执行

1、模糊查询

    
    
    select * from t_user where username like "%"#{mohu}"%"

2、批量删除

    delete from t_user where id in (${ids})

3、动态设置表名 

    select * from ${tableName}

4、 添加功能获取自增的主键

insert into t_user values(null,#{username},#{password},#{age},#{sex})


useGeneratedKeys：设置使用自增的主键
keyProperty：因为增删改有统一的返回值是受影响的行数，因此只能将获取的自增的主键放在传输的参
数user对象的某个属性中

七、自定义映射resultMap

1、字段名和实体类中的属性名不一致

若字段名和实体类中的属性名不一致，但是字段名符合数据库的规则（使用_），实体类中的属性 名符合Java的规则（使用驼峰）

此时也可通过以下两种方式处理字段名和实体类中的属性的映射关系

a、可以通过为字段起别名的方式，保证和实体类中的属性名保持一致

b、可以在MyBatis的核心配置文件中设置一个全局配置信息mapUnderscoreToCamelCase，可 以在查询表中数据时，自动将_类型的字段名转换为驼峰

例如：字段名user_name，设置了mapUnderscoreToCamelCase，此时字段名就会转换为 userName

2、resultMap处理字段和属性的映射关系

若字段名和实体类中的属性名不一致，则可以通过resultMap设置自定义映射

select id,user_name,password,age,sex from t_user where user_name like
concat('%',#{mohu},'%')

3、多对一关系处理

查询员工信息以及员工所对应的部门信息

方式一：级联方式处理映射关系

    
    
    
    
    
    




    select emp.*,dept.* from t_emp emp left join t_dept dept on emp.did =
dept.did where emp.eid = #{eid}

方式二：使用association处理映射关系

    
    
    
    
    
        
        
    



    select emp.*,dept.* from t_emp emp left join t_dept dept on emp.did =
dept.did where emp.eid = #{eid}

方式三：分步查询

①查询员工信息

    
    
    
    
    






select * from t_emp where eid = #{eid}


②根据员工所对应的部门id查询部门信息


    select * from t_dept where did = #{did}

4、一对多处理

根据部门id查新部门以及部门中的员工信息

方式1：

    
    
    
    
        
        
        
        
    




    select dept.*,emp.* from t_dept dept left join t_emp emp on dept.did =
emp.did where dept.did = #{did}

 方式二：分步查询

①查询部门信息









select * from t_dept where did = #{did}


②根据部门id查询部门中的所有员工


select * from t_emp where did = #{did}

分步查询的优点：可以实现延迟加载 但是必须在核心配置文件中设置全局配置信息： lazyLoadingEnabled：延迟加载的全局开关。当开启时，所有关联对象都会延迟加载 aggressiveLazyLoading：当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属 性会按需加载 此时就可以实现按需加载，获取的数据是什么，就只会执行相应的sql。

此时可通过association和 collection中的fetchType属性设置当前的分步查询是否使用延迟加载， fetchType="lazy(延迟加 载)|eager(立即加载)" 

八、动态sql

1、if标签

可通过test属性的表达式进行判断，若表达式的结果为true，则标签中的内容会执行；反之 标签中的内容不会执行

select * from t_emp where 1=1
    
        and ename = #{ename}
    
    
        and age = #{age}
    
    
        and sex = #{sex}
    

 2、where

where和if一般结合使用： a>若where标签中的if条件都不满足，则where标签没有任何功能，即不会添加where关键字 b>若where标签中的if条件满足，则where标签会自动添加where关键字，并将条件最前方多余的 and去掉 注意：where标签不能去掉条件最后多余的and

select * from t_emp
    
        
            ename = #{ename}
        
        
            and age = #{age}
        
        
            and sex = #{sex}
        
    

3、trim

trim用于去掉或添加标签中的内容 常用属性：

prefix：在trim标签中的内容的前面添加某些内容

prefixOverrides：在trim标签中的内容的前面去掉某些内容

suffix：在trim标签中的内容的后面添加某些内容

suffixOverrides：在trim标签中的内容的后面去掉某些内容 

select * from t_emp


    ename = #{ename} and


    age = #{age} and


    sex = #{sex}

4、choose、when、otherwise

choose、when、 otherwise相当于if...else if..else 

    
        select  from t_emp
        
            
                
                    ename = #{ename}
                
                
                    age = #{age}
                
                
                    sex = #{sex}
                
                
                    email = #{email}
                
            
        
    

5、foreach

    
        insert into t_emp values
        
            (null,#{emp.ename},#{emp.age},#{emp.sex},#{emp.email},null)
        
    
    
    
        delete from t_emp where
        
            eid = #{eid}
        
    
    
    
    delete from t_emp where eid in
    
                            #{eid}
    
    

 6、SQL片段

sql片段，可以记录一段公共sql片段，在使用的地方通过include标签进行引入

eid,ename,age,sex,did

select  from t_emp

九、mybatis缓存

1、一级缓存

默认是开启的

一级缓存是SqlSession级别的，通过同一个SqlSession查询的数据会被缓存，下次查询相同的数据，就 会从缓存中直接获取，不会从数据库重新访问 使一级缓存失效的四种情况：

1) 不同的SqlSession对应不同的一级缓存

2) 同一个SqlSession但是查询条件不同

3) 同一个SqlSession两次查询期间执行了任何一次增删改操作

4) 同一个SqlSession两次查询期间手动清空了缓存 

2、MyBatis的二级缓存

二级缓存是SqlSessionFactory级别，通过同一个SqlSessionFactory创建的SqlSession查询的结果会被 缓存；此后若再次执行相同的查询语句，结果就会从缓存中获取

二级缓存开启的条件：

a>在核心配置文件中，设置全局配置属性cacheEnabled="true"，默认为true，不需要设置

b>在映射文件中设置标签

    
    
    
        select * from user
    

c>二级缓存必须在SqlSession关闭或提交之后有效，如下关闭sqlSession.close();

d>查询的数据所转换的实体类类型必须实现序列化的接口

使二级缓存失效的情况：

两次查询之间执行了任意的增删改，会使一级和二级缓存同时失效

3、二级缓存的相关配置

在mapper配置文件中添加的cache标签可以设置一些属性：

①eviction属性：缓存回收策略，默认的是 LRU。

LRU（Least Recently Used） – 最近最少使用的：移除最长时间不被使用的对象。

FIFO（First in First out） – 先进先出：按对象进入缓存的顺序来移除它们。

SOFT – 软引用：移除基于垃圾回收器状态和软引用规则的对象

WEAK – 弱引用：更积极地移除基于垃圾收集器状态和弱引用规则的对象。

②flushInterval属性：刷新间隔，单位毫秒 默认情况是不设置，也就是没有刷新间隔，缓存仅仅调用语句时刷新

③size属性：引用数目，正整数 代表缓存最多可以存储多少个对象，太大容易导致内存溢出 ④readOnly属性：只读， true/false

true：只读缓存；会给所有调用者返回缓存对象的相同实例。因此这些对象不能被修改。这提供了 很重 要的性能优势。

false：读写缓存；会返回缓存对象的拷贝（通过序列化）。这会慢一些，但是安全，因此默认是 false。

4、MyBatis缓存查询的顺序

先查询二级缓存，因为二级缓存中可能会有其他程序已经查出来的数据，可以拿来直接使用。

如果二级缓存没有命中，再查询一级缓存 如果一级缓存也没有命中，则查询数据库 SqlSession关闭之后，一级缓存中的数据会写入二级缓存

5、整合第三方缓存EHCache

org.mybatis.caches
mybatis-ehcache
1.2.1

创建EHCache的配置文件ehcache.xml

 设置二级缓存的类型

EHCache配置文件说明

十、代码生成器

官网地址：MyBatis Generator Core – Introduction to MyBatis Generator

 学习使用地址：MyBatis代码生成器_程序三两行的博客-CSDN博客

十一、插件开发

1、分页插件

com.github.pagehelper
pagehelper
5.2.0

在MyBatis的核心配置文件中配置插件

 使用

    public Result queryAllByPage(Integer page, Integer limit,String startDate,String endDate){
        if(page == null){
            page = 1;
        }
        if(page <= 0){
            page = 1;
        }
        if(limit == null){
            limit = 10;
        }
        PageHelper.startPage(page,limit);
        List oplogList = oplogService.queryAll(startDate,endDate);
        PageInfo pageInfo = new PageInfo<>(oplogList);
        return Result.success(pageInfo);
    }

2、其他插件参考

 mybatis工具网站：MyBatis 工具 · 分页插件 PageHelper、通用 Mapper

3、如何自己开发插件

https://mp.weixin.qq.com/s/qcVSVeKIQA4RD4vlrzut7w