Mybatis二次深度学习整理——基础应用

前言

啰嗦两句，工作中使用Mybatis，感觉自己理解不深，又系统学习了一次，现在是第二次整理了，反反复复学习了三次，学习这东西本来就是学忘、忘学的过程

本篇是对Mybatis中基础应用的一个整理，在我眼里的基础应用都包括什么呢？Mybatis基础配置、Xml开发、注解开发、结果集映射——一对一、一对多、多对多，这些都是基础应用，说实话就是CRUD。
但是本篇应该不只有基础应用的介绍，还包括一些我在中文官方文档中看到的让我感觉新奇的配置属性以及一些其他信息。

再次推荐直接查看中文官方文档来全面了解Mybtis，遇到不理解的内容再去查询他人写的博客来辅助理解，因为毕竟不论谁写的博客都会加入一些个人的理解，这是不可避免的，最主要的是加入的个人理解还不一定正确，这是最可怕的。

下一篇将介绍一些Mybatis的高级应用，如缓存-一级、二级，插件-自定义插件、常用插件等

---

一、Mybtis简介

ORM Object/Relation Mapping：表示对象关系映射

ORM完成面向对象的编程语言到关系数据库的映射。
当ORM框架完成映射后，程序员既可以利用面向对象程序设计语言的简单易用性，又可以利用关系数据库的技术优势。ORM把关系数据库包装成面向对象的模型。ORM框架是面向对象设计语言与关系数据库发展不同步时的中间解决方案。
采用ORM框架后，应用程序不再直接访问底层数据库，而是以面向对象的放松来操作持久化对象，而ORM框架则将这些面向对象的操作转换成底层SQL操作。ORM框架实现的效果：把对持久化对象的保存、修改、删除 等操作，转换为对数据库的操作。

MyBatis是一款优秀的基于ORM的半自动轻量级持久层框架，它支持定制化SQL、存储过程以及高级映射。 MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。MyBatis可以使用简单的XML或注解来配置和映射原生类型、接口和Java的POJO （Plain Ordinary Java Objects,普通老式Java对 象）为数据库中的记录。

---

对于加粗的文字进行一个解释，因为关于这块以前的我看到时好像懂了，但是怎么也说不出来是什么意思。以下全是大白话

• ORM： Java对象和数据库表之间的一个映射关系，也就是Java对象中的属性域映射数据库表中的各个字段，这样就可以达到操作java对象从而操作数据库数据的目的；
• 半自动： 既然有半自动，那么肯定是有全自动的，全自动比较有名的框架是Hibernate，Hibernate也是一个持久层框架，不过它是全自动的，全自动是什么意思呢？它是完全隔离开数据库和程序员，在我们使用Hibernate操作数据库的时候，只需要调用Hibernate提供各种方法就可以完成对数据库的操作了。那么半自动其实就是将对数据库的操作的DQL、DML、存储过程保留了下来，由程序员自己来定义这些内容，这样的话，我们就可以根据不同的业务场景来出最优的SQL来。
• 轻量级： 量级指在其架构启动时需要系统资源的多少，而轻自然是比较少的含义了。
• 高级映射： 对于结果集的java Bean 和数据库表的多种映射关系，如一对一、一对多、多对多等。

二、快速入门

在准备学快速入门案例的时候，注意到了Mybatis的头部声明，一直都了解它是用来校验XML文件的正确性的，但是从未深入了解过它，借此机会用了几天时间跑去了解了一下DTD和XSD。
关于这两个XML的语法规范，对比起来DTD要简单一些，我项目中使用的Mybatis的头部声明就是DTD，XSD要更加丰富一下，可以限定的内容也更多一些，pom.xml文件、spring相关的xml配置文件使用的多是XSD。
如果想去了解XSD的同学可以看一下我的XSD问题整理，至于DTD我也整理了，但是比较简单我就没有发出来，想要了解的同学可自行百度。

入门案例就详细的将项目代码放到这吧，后面其他特性介绍和这个结构差不多，就不全部放到博客中了，要不内容太长了，有需要的可以去GitHub查看

1 依赖

直接上pom坐标了

        <dependency>
            <groupId>junitgroupId>
            <artifactId>junitartifactId>
            <version>4.13version>
        dependency>
        <dependency>
            <groupId>com.alibabagroupId>
            <artifactId>druidartifactId>
            <version>1.0.9version>
        dependency>
        <dependency>
            <groupId>org.mybatisgroupId>
            <artifactId>mybatisartifactId>
            <version>3.5.0version>
        dependency>
        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
            <version>8.0.13version>
        dependency>
        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
            <version>1.18.12version>
        dependency>

2 数据库sql

CREATE TABLE `user` (
  `id` int NOT NULL AUTO_INCREMENT,
  `username` varchar(50) DEFAULT NULL,
  `password` varchar(50) DEFAULT NULL,
  `birthday` varchar(50) DEFAULT NULL,
  PRIMARY KEY (`id`)
) 
INSERT INTO `mybatis-test`.`user`(`id`, `username`, `password`, `birthday`) VALUES (1, 'lucy', '123', '2021-05-13 17:08:20');
INSERT INTO `mybatis-test`.`user`(`id`, `username`, `password`, `birthday`) VALUES (2, 'tom', '123', '2021-05-13 17:08:20');
INSERT INTO `mybatis-test`.`user`(`id`, `username`, `password`, `birthday`) VALUES (3, 'ZHANGSAN', '456', '2021-05-13 17:08:20');

3 实体类

@Data
public class User {
    private Integer id;
    private String username;
    private String password;
    private String birthday;
}

这里图方便，使用了Lombok了，没有使用的同学要记得在ideaj中下载Lombok插件，也可以不使用Lombok，效果一样的。

4 Mapper

public interface UserMapper {

    List<User> findAll() throws Exception;

    User findOne(User user) throws Exception;

    Integer updateUserById(User user) throws Exception;

    Integer deleteUserById(String id,String userName) throws Exception;

    Integer insertUser(User user) throws Exception;
}

5 配置信息

SqlConfig.xml：Mybatis基础配置

DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    
    <properties resource="properties/jdbc.properties">
    properties>
    
    <environments default="simple">
        
        <environment id="simple">
            <transactionManager type="jdbc">transactionManager>
            <dataSource type="pooled">
                <property name="driver" value="${mysql.driver}"/>
                <property name="url" value="${mysql.url}"/>
                <property name="username" value="${mysql.username}"/>
                <property name="password" value="${mysql.password}"/>
            dataSource>
        environment>
    environments>

    
    <mappers>
        
        
        <mapper resource="simple\mappers\UserMapper.xml"/>
    mappers>
configuration>

UserMapper.xml：用户表增删改查信息

DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hs.mybatis.simple.dao.UserMapper">
    <select id="findAll" resultType="com.hs.mybatis.simple.pojo.User">
        SELECT `id`, `username`, `password`, `birthday` FROM `user`;
    select>
    <select id="findOne" resultType="com.hs.mybatis.simple.pojo.User">
        SELECT id,username,password,birthday FROM `user` WHERE id = #{id} AND username = #{username};
    select>

    <update id="updateUserById">
        UPDATE `user` SET `username` = #{username}, `password` = #{password}, `birthday` = #{birthday}
        WHERE `id` = #{id};
    update>

    <delete id="deleteUserById">
        DELETE FROM `user` WHERE id = #{id} AND username = #{username};
    delete>

    <insert id="insertUser">
        INSERT INTO `user` VALUES(#{id},#{username},#{password},#{birthday});
    insert>
mapper>

上面有一点需要注意一下，就是SqlConfig.xml中的这块

这是指刚刚UserMapper.xml在项目中的配置，我的位置是在这里，要注意调整实际的位置。

jdbc.properties：数据库配置信息

mysql.driver=com.mysql.cj.jdbc.Driver
mysql.url=jdbc:mysql://127.0.0.1:3307/mybatis-test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=TRUE&serverTimezone=GMT%2B8
mysql.username=root
mysql.password=123

这里调整成自己的数据库配置就可以了

6 测试类

public class SimpleMybatisTest {
    /**
     * 使用动态代理方式去使用mybatis开发
     */
    @Test
    public void simpleDynamicTest() throws Exception {
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("simple/SqlConfig.xml"));
        SqlSession sqlSession =factory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = mapper.findAll();
        users.forEach(user -> System.out.println(user));
    }
    /**
     * 使用传统方式去使用mybatis开发
     */
    @Test
    public void simpleNonDynamicTest() throws Exception {
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("simple/SqlConfig.xml"));
        SqlSession sqlSession =factory.openSession();
        List<User> users = sqlSession.selectList("com.hs.mybatis.simple.dao.UserMapper.findAll");
        users.forEach(user -> System.out.println(user));
    }

}

其实这就是一个简单的Mybatis入门案例，主要是分析一下Mybatis 是如何工作的，这个看了我上一节的同学应该知道一个自定义ORM框架是如何工作的了，其实那个自定义ORM就是仿照Mybatis写的，那么这里也是一样的。
可以看到不管是传统方式还是代理模式都是先使用SqlSessionFactoryBuilder创建一个SqlSessionFactory，然后通过SqlSessionFactory生成一个一个的SqlSession会话，在SqlSession中包含对数据库的增删改查、事务、缓存等等的操作。这个就和自定义ORM框架很像了吧，只不过Mybatis要更加的完善。
在这个流程中，Mybatis根据加载到的SqlConfig.xml来组装Configuration，到SqlSession时已经拿到一个组装好的Configuration，然后在底层执行JDBC，进行缓存匹配、参数封装、结果集映射等等操作。
传统方式和动态代理唯一的差别就是，使用了代理模式，并且在之前生成Factory的时候，将对应的Mapper接口注册到MapperRegistry中，为后续的动态代理做准备。
官方中对这三个类的介绍
SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式：

try (SqlSession session = sqlSessionFactory.openSession()) {  // 你的应用逻辑代码}

在所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。

当然，如果你正在使用对象生命周期和依赖注入框架，如spring，那么就不需要考虑上面的声明周期的问题了

三、配置文件深入了解

这部分内容来自于官网，只是对常用内容进行了整理

1 核心配置文件

首先根据头部信息的限制，它的配置各个元素是有顺序的，这个初学者一定要理解清楚。
下面的介绍也将是由上而下开展

1.1 properties（重要）

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。例如：

<properties resource="org/mybatis/example/config.properties">  <property name="username" value="dev_user"/>  <property name="password" value="F2Fa3!33TYyg"/>properties>

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值。比如:

<dataSource type="POOLED">  <property name="driver" value="${driver}"/>  <property name="url" value="${url}"/>  <property name="username" value="${username}"/>  <property name="password" value="${password}"/>dataSource>

也可以在 SqlSessionFactoryBuilder.build() 方法中传入属性值。例如：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props);// ... 或者 ...SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);

如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照下面的顺序来加载：

• 首先读取在 properties 元素体内指定的属性。
• 然后根据 properties 元素中的 resource 属性读取类路径下属性文件，或根据 url 属性指定的路径读取属性文件，并覆盖之前读取过的同名属性。
• 最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的则是 properties 元素中指定的属性。
从 MyBatis 3.4.2 开始，你可以为占位符指定一个默认值。例如：

<dataSource type="POOLED">    <property name="username" value="${username:ut_user}"/> dataSource>

这个特性默认是关闭的。要启用这个特性，需要添加一个特定的属性来开启这个特性。例如：

<properties resource="org/mybatis/example/config.properties">    <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> properties>

如果想使用三元运算符的话，修改一下default-value-separator就可以了，这个看官网吧

1.2 settings（重要）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。只会列出常用的哦

设置名	描述	有效值	默认值
cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。（这里指二级缓存）	true | false	true
useGeneratedKeys	允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作（如 Derby）。	true | false	False
defaultStatementTimeout	设置超时时间，它决定数据库驱动等待数据库响应的秒数。	任意正整数	未设置 (null)
defaultFetchSize	为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。主要是防止一次性将太多数据加载到内存中，导致内存崩溃	任意正整数	未设置 (null)
returnInstanceForEmptyRow	当返回行的所有列都是空时，MyBatis默认返回 null。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）	true | false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀。	任何字符串	未设置
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	未设置

1.3 typeAliases

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。例如：

<typeAliases>  <typeAlias alias="Author" type="domain.blog.Author"/>  <typeAlias alias="Blog" type="domain.blog.Blog"/>typeAliases>

当这样配置时，Blog 可以用在任何使用 domain.blog.Blog 的地方。这就有点像，我在自定义ORM框架中使用PWrapMapping.properties文件了，本质是一样的，使用一个常用的缩写名字来代替比较复杂全限定名。

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如：

<typeAliases>  <package name="domain.blog"/>typeAliases>

每一个在包 domain.blog 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 domain.blog.Author 的别名为 author；若有注解，则别名为其注解值。见下面的例子：

@Alias("author")public class Author {    ...}

下面是一些为常见的 Java 类型内建的类型别名。它们都是不区分大小写的，注意，为了应对原始类型的命名重复，采取了特殊的命名风格。

别名	映射的类型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

可以看出来Primitive Type(基础数据类型)使用的是_下划线加类型名，而包装类使用的别名未加下划线。

1.4 typeHandlers

MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时， 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。

这块有点没理解，后面查看Mybatis源码的时候着重理解一下吧

类型处理器

1.5 objectFactory

对象工厂，不常用，但是比较简单，也记录一下

每次 MyBatis 创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成实例化工作。 默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认无参构造方法，要么通过存在的参数映射来调用带有参数的构造方法。 如果想覆盖对象工厂的默认行为，可以通过创建自己的对象工厂来实现。比如：

// ExampleObjectFactory.javapublic class ExampleObjectFactory extends DefaultObjectFactory {  public Object create(Class type) {    return super.create(type);  }  public Object create(Class type, List constructorArgTypes, List