MyBatis学习笔记

Posted 2022-11-05 ΘLLΘ

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了MyBatis学习笔记相关的知识，希望对你有一定的参考价值。

文章目录

1.MyBatis简介
- 1.1 MyBatis历史
- 1.2 MyBatis特性
- 1.3 和其它持久化层技术对比
2.搭建MyBatis
- 2.1 开发环境
- 2.2 创建maven工程
- 2.3 创建MyBatis的核心配置文件
- 2.4 创建mapper接口
- 2.5 创建MyBatis的映射文件
- 2.6 通过junit测试功能
- 2.7 加入log4j日志功能
3.核心配置文件详解
4.MyBatis的增删改查
5.MyBatis获取参数值的两种方式（重点）
- 5.1 单个字面量类型的参数
- 5.2 多个字面量类型的参数
- 5.3 map集合类型的参数
- 5.4 实体类类型的参数
- 5.5 使用@Param标识参数
- 5.6 总结
6.MyBatis的各种查询功能
- 6.1 查询一个实体类对象
- 6.2 查询一个List集合
- 6.3 查询单个数据
- 6.4 查询一条数据为map集合
- 6.5 查询多条数据为map集合
- - 方法一
  - 方法二
7.特殊SQL的执行
- 7.1 模糊查询
- 7.2 批量删除
- 7.3 动态设置表名
- 7.4 添加功能获取自增的主键
8.自定义映射resultMap
- 8.1 resultMap处理字段和属性的映射关系
- 8.2 多对一映射处理
- 8.3 一对多映射处理
- 8.4 延迟加载
9.动态SQL
- 9.1 if
- 9.2 where
- 9.3 trim
- 9.4 choose、when、otherwise
- 9.5 foreach
- 9.6 SQL片段
10.MyBatis的缓存
- 10.1 MyBatis的一级缓存
- 10.2 MyBatis的二级缓存
- 10.3 二级缓存的相关配置
- 10.4 MyBatis缓存查询的顺序
- 10.5 整合第三方缓存EHCache（了解）
11.分页插件
- 11.1 分页插件使用步骤
- - 1. 添加依赖
  - 2. 配置分页插件
- 11.2 分页插件的使用

MyBatis中文文档参考：https://mybatis.org/mybatis-3/zh/index.html
视频连接：https://www.bilibili.com/video/BV1VP4y1c7j7?spm_id_from=333.1007.top_right_bar_window_custom_collection.content.click

1.MyBatis简介

1.1 MyBatis历史

MyBatis最初是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation迁移到了Google Code。随着开发团队转投Google Code旗下，iBatis3.x正式更名为MyBatis。代码于2013年11月迁移到Github
iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。iBatis提供的持久层框架包括SQL Maps和Data Access Objects（DAO）

1.2 MyBatis特性

MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架
MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集
MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录
MyBatis 是一个半自动的ORM（Object Relation Mapping）框架

1.3 和其它持久化层技术对比

JDBC
- SQL 夹杂在Java代码中耦合度高，导致硬编码内伤
- 维护不易且实际开发需求中 SQL 有变化，频繁修改的情况多见
- 代码冗长，开发效率低
Hibernate 和 JPA
- 操作简便，开发效率高
- 程序中的长难复杂 SQL 需要绕过框架
- 内部自动生产的 SQL，不容易做特殊优化
- 基于全映射的全自动框架，大量字段的 POJO 进行部分映射时比较困难。
- 反射操作太多，导致数据库性能下降
MyBatis
- 轻量级，性能出色
- SQL 和 Java 编码分开，功能边界清晰。Java代码专注业务、SQL语句专注数据
- 开发效率稍逊于HIbernate，但是完全能够接受

2.搭建MyBatis

2.1 开发环境

IDE：idea 2019.2
构建工具：maven 3.5.4
mysql版本：MySQL 5.7
MyBatis版本：MyBatis 3.5.7

2.2 创建maven工程

打包方式：jar
引入依赖

<dependencies>
	<!-- Mybatis核心 -->
	<dependency>
		<groupId>org.mybatis</groupId>
		<artifactId>mybatis</artifactId>
		<version>3.5.7</version>
	</dependency>
	<!-- junit测试 -->
	<dependency>
		<groupId>junit</groupId>
		<artifactId>junit</artifactId>
		<version>4.12</version>
		<scope>test</scope>
	</dependency>
	<!-- MySQL驱动 -->
	<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
		<version>5.1.3</version>
		</dependency>
</dependencies>

2.3 创建MyBatis的核心配置文件

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

<?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>
    <!--设置连接数据库的环境-->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url"
                          value="jdbc:mysql://localhost:3306/MyBatis"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <!--引入映射文件-->
    <mappers>
        <mapper resource="mappers/UserMapper.xml"/>
    </mappers>
</configuration>

2.4 创建mapper接口

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

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

2.5 创建MyBatis的映射文件

相关概念：ORM（Object Relationship Mapping）对象关系映射。
- 对象：Java的实体类对象
- 关系：关系型数据库
- 映射：二者之间的对应关系

Java概念	数据库概念
类	表
属性	字段/列
对象	记录/行

映射文件的命名规则：表所对应的实体类的类名+Mapper.xml
- 例如：表t_user，映射的实体类为User，所对应的映射文件为UserMapper.xml
- 因此一个映射文件对应一个实体类，对应一张表的操作
- MyBatis映射文件用于编写SQL，访问以及操作表中的数据
- MyBatis映射文件存放的位置是src/main/resources/mappers目录下
MyBatis中可以面向接口操作数据，要保证两个一致
1. mapper接口的全类名和映射文件的命名空间namespace保持一致
2. mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致

<?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="com.atguigu.mybatis.mapper.UserMapper">  
	<!--int insertUser();-->  
	<insert id="insertUser">  
		insert into t_user values(null,'张三','123',23,'女')  
	</insert>  
</mapper>

SQL 映射文件只有9个顶级元素（按照应被定义的顺序列出）：

cache：该命名空间的缓存配置。
cache-ref：引用其它命名空间的缓存配置。
resultMap：描述如何从数据库结果集中加载对象，是最复杂也是最强大的元素。
parameterMap：老式风格的参数映射。此元素已被废弃，并可能在将来被移除！请使用行内参数映射。文档中不会介绍此元素。
sql：可被其它语句引用的可重用语句块。
insert：映射插入语句。
update：映射更新语句。
delete：映射删除语句。
select：映射查询语句。

2.6 通过junit测试功能

SqlSession：代表Java程序和数据库之间的会话。（HttpSession是Java程序和浏览器之间的会话）
SqlSessionFactory：是生产SqlSession的工厂
工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象

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

此时需要手动提交事务，如果要自动提交事务，则在获取sqlSession对象时，使用SqlSession sqlSession = sqlSessionFactory.openSession(true);，传入一个Boolean类型的参数，值为true，这样就可以自动提交

2.7 加入log4j日志功能

加入依赖

<!-- log4j日志 -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

加入log4j的配置文件

log4j的配置文件名为log4j.xml，存放的位置是src/main/resources目录下
日志的级别：FATAL(致命)>ERROR(错误)>WARN(警告)>INFO(信息)>DEBUG(调试) 从左到右打印的内容越来越详细

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Encoding" value="UTF-8" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-5p %dMM-dd HH:mm:ss,SSS %m (%F:%L) \\n" />
        </layout>
    </appender>
    <logger name="java.sql">
        <level value="debug" />
    </logger>
    <logger name="org.apache.ibatis">
        <level value="info" />
    </logger>
    <root>
        <level value="debug" />
        <appender-ref ref="STDOUT" />
    </root>
</log4j:configuration>

3.核心配置文件详解

核心配置文件中的标签必须按照固定的顺序（有的标签可以不写，但顺序一定不能乱）：

properties（属性）
- 这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置
settings（设置）
typeAliases（类型别名）
- typeAlias
  - type：需要设置别名的类型的全类名
  - alias：设置此类型的别名，且别名不区分大小写。若不设置此属性，该类型拥有默认的别名，即类名
- package：以包为单位，设置改包下所有的类型都拥有默认的别名，即类名且不区分大小写
typeHandlers（类型处理器）
objectFactory（对象工厂）
objectWrapperFactory
reflectorFactory
plugins（插件）
environments（环境配置）
- environments：配置多个连接数据库的环境
  - default：设置默认使用的环境的id
- environment：配置某个具体的环境
  - id：表示连接数据库的环境的唯一标识，不能重复
- transactionManager：设置事务管理方式
  - type：设置事务管理方式，type=“JDBC|MANAGED”
    - type=“JDBC”：这个配置直接使用了 JDBC 的提交和回滚设施，设置当前环境的事务管理都必须手动处理
    - type=“MANAGED”：设置事务被管理，例如spring中的AOP
- dataSource：设置数据源
  - type：设置数据源的类型，type=“POOLED|UNPOOLED|JNDI”
    - type=“POOLED”：使用数据库连接池，即会将创建的连接进行缓存，下次使用可以从缓存中直接获取，不需要重新创建
    - type=“UNPOOLED”：不使用数据库连接池，即每次使用连接都需要重新创建
    - type=“JNDI”：调用上下文中的数据源
databaseIdProvider（数据库厂商标识）
mappers（映射器）
1. mapper resource：使用相对于类路径的资源引用
2. mapper url：使用完全限定资源定位符（URL）
3. mapper class：使用映射器接口实现类的完全限定类名
4. package name：将包内的映射器接口实现全部注册为映射器
  
  注意：此方式必须保证mapper接口和mapper映射文件必须在相同的包下。mapper接口要和mapper映射文件的名字一致

<?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>
    <!--引入properties文件，此时就可以$属性名的方式访问属性值-->
    <properties resource="jdbc.properties"></properties>
    <settings>
        <!--将表中字段的下划线自动转换为驼峰-->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <!--开启延迟加载-->
        <setting name="lazyLoadingEnabled" value="true"/>
    </settings>
    <typeAliases>
        <!--<typeAlias type="com.atguigu.mybatis.bean.User"></typeAlias>-->
        <!--<typeAlias type="com.atguigu.mybatis.bean.User" alias="user">
        </typeAlias>-->
        <package name="com.atguigu.mybatis.bean"/>
    </typeAliases>
    <!--environments：设置多个连接数据库的环境-->
    <environments default="mysql_test">
        <environment id="mysql_test">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--设置驱动类的全类名-->
                <property name="driver" value="$jdbc.driver"/>
                <!--设置连接数据库的连接地址-->
                <property name="url" value="$jdbc.url"/>
                <!--设置连接数据库的用户名-->
                <property name="username" value="$jdbc.username"/>
                <!--设置连接数据库的密码-->
                <property name="password" value="$jdbc.password"/>
            </dataSource>
        </environment>
    </environments>
    <!--引入映射文件-->
    <mappers>
        <!-- <mapper resource="UserMapper.xml"/> -->
        <package name="com.atguigu.mybatis.mapper"/>
    </mappers>
</configuration>

默认的类型别名

4.MyBatis的增删改查

添加

<!--int insertUser();-->
<insert id="insertUser">
	insert into t_user values(null,'admin','123456',23,'男','12345@qq.com')
</insert>

删除

<!--int deleteUser();-->
<delete id="deleteUser">
    delete from t_user where id = 6
</delete>

修改

<!--int updateUser();-->
<update id="updateUser">
    update t_user set username = '张三' where id = 5
</update>

查询一个实体类对象

<!--User getUserById();-->  
<select id="getUserById" resultType="com.atguigu.mybatis.bean.User">  
	select * from t_user where id = 2  
</select>

查询集合

<!--List<User> getUserList();-->
<select id="getUserList" resultType="com.atguigu.mybatis.bean.User">
	select * from t_user
</select>

注意：
1. 查询的标签select必须设置属性resultType或resultMap，用于设置实体类和数据库表的映射关系
  - resultType：自动映射，用于属性名和表中字段名一致的情况
  - resultMap：自定义映射，用于一对多或多对一或字段名和属性名不一致的情况
2. 当查询的数据为多条时，不能使用实体类作为返回值，只能使用集合，否则会抛出异常TooManyResultsException；但是若查询的数据只有一条，可以使用实体类或集合作为返回值

5.MyBatis获取参数值的两种方式（重点）

MyBatis获取参数值的两种方式：$和#
$的本质就是字符串拼接，#的本质就是占位符赋值
$使用字符串拼接的方式拼接sql，若为字符串类型或日期类型的字段进行赋值时，需要手动加单引号；但是#使用占位符赋值的方式拼接sql，此时为字符串类型或日期类型的字段进行赋值时，可以自动添加单引号

5.1 单个字面量类型的参数

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

<!--User getUserByUsername(String username);-->
<select id="getUserByUsername" resultType="User">
	select * from t_user where username = #username
</select>

<!--User getUserByUsername(String username);-->
<select id="getUserByUsername" resultType="User">  
	select * from t_user where username = '$username'  
</select>

5.2 多个字面量类型的参数

若mapper接口中的方法参数为多个时，此时MyBatis会自动将这些参数放在一个map集合中
1. 以arg0、arg1…为键，以参数为值
2. 以param1、param2…为键，以参数为值
因此只需要通过$和#访问map集合的键就可以获取相对应的值，注意$需要手动加单引号。
使用arg或者param都行，要注意的是，arg是从arg0开始的，param是从param1开始的

<!--User checkLogin(String username,String password);-->
<select id="checkLogin" resultType="User">  
	select * from t_user where username = #arg0 and password = #arg1  
</select>

<!--User checkLogin(String username,String password);-->
<select id="checkLogin" resultType="User">
	select * from t_user where username = '$param1' and password = '$param2'
</select>

5.3 map集合类型的参数

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

<!--User checkLoginByMap(Map<String,Object> map);-->
<select id="checkLoginByMap" resultType="User">
	select * from t_user where username = #username and password = #password
</select>

以上是关于MyBatis学习笔记的主要内容，如果未能解决你的问题，请参考以下文章 
 SQL——MyBatis
 MyBatis学习总结——实现关联表查询（转载）
 MyBatis学习总结——实现关联表查询
 MyBatis学习总结——实现关联表查询
 MyBatis学习总结——实现关联表查询(转)
 MyBatis学习总结_05_实现关联表查询