MyBatis介绍与入门¶

1.官方文档¶

Mybatis中文手册：mybatis – MyBatis 3 或者 MyBatis中文网

Maven仓库：Maven Repository: org.mybatis » mybatis » 3.5.7 (mvnrepository.com)

2.概述¶

2.1传统Java程序操作DB¶

传统方式操作数据库的问题：

需要自己去连接数据库，这段代码由程序员编写(不一定标准)
程序不是OOP的方式来操作DB（我们希望在代码层面上是以对象的形式来操作，如insert(Object)）
SQL语句写在程序中，属于硬编码，没有解耦

2.2MyBatis基本介绍¶

Mybatis 是一个持久层框架
前身是 ibatis，在ibatis3.x 时，更名为Mybatis
Mybatis 在 Java 和 sql 之间提供更加灵活的映射方案
mybatis 可以对数据库表的操作(sql，方法)等等直接剥离，写到 xml 配置文件，实现和 java 代码的解耦
mybatis 通过 SQL 操作 DB，建库建表的操作仍需要程序员完成

2.3Mybatis工作原理¶

相对于传统方式，Mybatis的优势：

数据库的连接/连接池，只需要配置即可，标准可以统一
程序以OOP的方式来操作数据库
sql语句可以写在xml文件中，实现了解耦
Mybatis可以对DB操作进行优化，提高效率，比如配置缓存

3.MyBatis快速入门¶

3.1需求说明¶

要求：开发一个Mybatis项目，通过Mybatis的方式可以对monster表进行crud操作。

3.2环境搭建¶

（1）创建maven父项目，方便项目的jar包管理

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.li</groupId>
    <artifactId>mybatis</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <!--加入依赖-->
    <dependencies>
        <!--mysql依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.49</version>
        </dependency>
        <!--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>
            <!--指定该jar的作用范围在test目录下-->
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

（2）创建maven父项目的Module，视为子项目

此时父项目的pom.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!--说明：
        1.将 mybatis作为父项目管理多个子模块/子项目
        2.父项目的完整的坐标 groupId[组织名]+artifactId[项目名]
        3.后面该父项目会管理多个子模块/子项目，将来父项目中的引入的依赖可以直接给子项目用,
            这样开发简单，提高复用性，也便于管理
        4.<packaging>pom</packaging> 表示父项目以多个子模块/子项目管理工程
        5. 在 modules指定管理哪些子模块
     -->
    <groupId>com.li</groupId>
    <artifactId>mybatis</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>mybatis_quickstart</module>
    </modules>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <!--加入依赖，略，详见上面-->
    <dependencies>
        <!--mysql依赖-->
        <!--mybatis依赖-->
        <!--junit依赖-->
    </dependencies>
</project>

子模块的pom.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <!--说明
        1.parent指定了该模块的父项目的坐标 artifactId+groupId
        2.这样配置后，子模块就可以使用到父项目的依赖
        -->
    <parent>
        <artifactId>mybatis</artifactId>
        <groupId>com.li</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <!--子模块的名称，当前子模块的groupId默认和父项目的groupId相同，即com.li-->
    <artifactId>mybatis_quickstart</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

</project>

3.2代码实现¶

（1）创建数据库和表

-- 创建数据库
CREATE DATABASE `mybatis`;
USE `mybatis`;
-- 创建monster表
CREATE TABLE `monster`(
`id` INT NOT NULL AUTO_INCREMENT,
`age` INT NOT NULL,
`birthday` DATE DEFAULT NULL,
`email` VARCHAR(255) NOT NULL,
`gender` TINYINT NOT NULL,-- 1 male, 0 female
`name` VARCHAR(255) NOT NULL,
`salary` DOUBLE NOT NULL,
PRIMARY KEY(`id`)
)CHARSET=utf8

（2）在子模块 mybatis_quickstart 的 resources 目录创建配置文件 mybatis-config.xml（名称随意）

mybatis配置文件模板

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://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"/>
                <!--配置连接mysql的url
                    1.jdbc:mysql 协议
                    2.127.0.0.1:3306 连接数据库的 ip+port
                    3.mybatis 连接的数据库名称
                    4.useSSL=true 表示使用安全连接
                    5.&amp; 表示 & 符号，这里这样写是为了转义，防止解析错误
                    6.useUnicode=true 使用Unicode，防止编码错误
                    7.characterEncoding=UTF-8 使用utf-8，防止中文乱码
                    -->
                <property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?
                    useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <!--用户名-->
                <property name="username" value="root"/>
                <!--密码-->
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <!--这里配置需要管理的mapper.xml文件-->
    <mappers>
        <mapper resource="com/li/mapper/MonsterMapper.xml"/>
    </mappers>
</configuration>

（3）创建实体类 Monster.java

package com.li.entity;

import java.util.Date;

/**
 * @author 李
 * @version 1.0
 * 1.Monster和 monster表有对应关系
 * 2.原生的sql语句查询结果还是要封装成对象
 * 3.因此要求这里的实体类属性名和表的字段名保持相同
 */
public class Monster {
    //属性和表的字段对应
    private Integer id;
    private Integer age;
    private String name;
    private String email;
    private Date birthday;
    private double salary;
    private Integer gender;

    //省略无参构造器，全参构造器，setter,getter,toString方法
}

（4）创建MonsterMapper接口

package com.li.mapper;

import com.li.entity.Monster;

/**
 * @author 李
 * @version 1.0
 * 1.MonsterMapper接口用于声明操作monster表的方法
 * 2.这些方法可以通过注解或者xml文件来实现
 */
public interface MonsterMapper {
    //添加monster
    public void addMonster(Monster monster);
}

（5）创建接口对应的映射文件，实现方法

mybatis – MyBatis 3 | XML 映射器

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--说明
  1.这是一个mapper.xml文件
  2.该文件可以去实现对应的接口的方法
  3.namespace 指定当前xml文件和哪个接口对应！
-->
<mapper namespace="com.li.mapper.MonsterMapper">
    <!--配置addMonster方法
     1.id 就是对应接口的方法名
     2.parameterType 方法的入参
     3.写入sql语句
     4.(`age`,`birthday`,`email`,`gender`,`name`,`salary`) 表的字段
     5.#{age},#{birthday},#{email},#{gender},#{name},#{salary} 从传入的Monster对象属性中获取
     6.注意这里的 #{age}对应Monster对象的属性名，其他类推
     -->
    <insert id="addMonster" parameterType="com.li.entity.Monster">
        INSERT INTO `monster`
        (`age`,`birthday`,`email`,`gender`,`name`,`salary`)
        VALUES (#{age},#{birthday},#{email},#{gender},#{name},#{salary})
    </insert>
</mapper>

（6）工具类MybatisUtils，用于获取连接

package com.li.util;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;

/**
 * @author 李
 * @version 1.0
 * MybatisUtils工具类可以得到 SqlSession
 */
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;

    //静态代码块中初始化 SqlSessionFactory-会话工厂
    static {
        try {
            //指定资源文件（配置文件）
            String resource = "mybatis-config.xml";
            //获取配置文件对应的inputStream
            //说明：加载文件时，默认到resource目录对应的==>运行后的工作目录target/classes找
            InputStream resourceAsStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
            System.out.println("sqlSessionFactory=" + sqlSessionFactory.getClass());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    //编写方法，返回一个SqlSession对象-会话
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}

3.3测试¶

3.3.1添加¶

test 目录中创建测试类 MonsterMapperTest.java

package com.li.mapper;

import com.li.entity.Monster;
import com.li.util.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Before;
import org.junit.Test;

import java.util.Date;

/**
 * @author 李
 * @version 1.0
 */
public class MonsterMapperTest {
    //属性
    private SqlSession sqlSession;
    private MonsterMapper monsterMapper;

    /**
     * 编写方法，完成初始化
     * 当一个A方法标注了注解 @Before时，表示在执行你的目标测试方法前会先执行A方法
     */
    @Before
    public void init() {
        sqlSession = MybatisUtils.getSqlSession();
        //获取到 monsterMapper对象 =class com.sun.proxy.$Proxy7代理对象）
        //底层使用了动态代理机制，返回一个代理对象，通过这个对象去执行你的方法
        monsterMapper = sqlSession.getMapper(MonsterMapper.class);
        System.out.println("monsterMapper的类型=" + monsterMapper.getClass());
    }

    @Test
    public void addMonster() {
        for (int i = 0; i < 2; i++) {
            Monster monster = new Monster();
            monster.setAge(10 + i);
            monster.setBirthday(new Date());
            monster.setEmail("kate@qq.com");
            monster.setGender(1);
            monster.setName("松鼠精" + i + "号");
            monster.setSalary(1000 + i * 10);
            monsterMapper.addMonster(monster);
            System.out.println("添加对象--" + monster);
        }
        //如果是增删改，需要提交事务，因为它默认不提交
        if (sqlSession != null) {
            sqlSession.commit();
            //将连接释放回连接池
            sqlSession.close();
        }
        System.out.println("保存成功....");
    }
}

上面的代码一般会出现找不到xxxmapper.xml错误，原因是加载的资源文件时是到target目录下加载的，当maven项目运行时，源工程的MonsterMapper.xml并没有被拷贝到target目录下。

解决方法：在父工程的pom.xml加入build配置，作用是配置resource，防止资源导出失败

<!--将指定的目录以及它们的子目录下的xml、properties文件在build项目时
    导出到对应的target目录下-->
<build>
    <resources>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.xml</include>
            </includes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.xml</include>
                <include>**/*.properties</include>
            </includes>
        </resource>
    </resources>
</build>

然后选择build project

如果不行，可能是maven版本冲突，在setting中切换maven版本，然后点击父工程的maven的clean重新构建。

测试结果：

数据库monster表增加了两条记录：

3.3.2返回自增长¶

有时候我们需要获取数据库中自动生成(AUTO_INCREMENT)的主键，这时候可以使用Mybatis的useGeneratedKeys（开启新增主键返回功能）和 keyProperty（实体的主键属性）来配合获取。

（1）修改映射文件MonsterMapper.xml，在该文件中的方法映射中添加 useGenerateKeys 和 keyProperty

<mapper namespace="com.li.mapper.MonsterMapper">
    <insert id="addMonster" parameterType="com.li.entity.Monster" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO `monster`
        (`age`,`birthday`,`email`,`gender`,`name`,`salary`)
        VALUES (#{age},#{birthday},#{email},#{gender},#{name},#{salary})
    </insert>
</mapper>

（2）修改测试类，输出主键

（3）测试结果：

数据库表格：

3.3.3删除¶

（1）修改 MonsterMapper.java 接口，声明 delMonster() 方法

//根据id删除一个Monster
public void delMonster(Integer id);

（2）在映射文件 MonsterMapper.xml 中实现 delMonster() 方法

<!--配置delMonster方法
    1.java.lang.Integer是Java类型，可以简写为Integer
    2.写入delete语句
 -->
<delete id="delMonster" parameterType="Integer">
    DELETE FROM `monster` WHERE `id`=#{id};
</delete>

（3）修改测试类，添加测试方法

package com.li.mapper;

import com.li.entity.Monster;
import com.li.util.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Before;
import org.junit.Test;

import java.util.Date;

/**
 * @author 李
 * @version 1.0
 */
public class MonsterMapperTest {
    //属性
    private SqlSession sqlSession;
    private MonsterMapper monsterMapper;

    @Before
    public void init() {
        sqlSession = MybatisUtils.getSqlSession();
        monsterMapper = sqlSession.getMapper(MonsterMapper.class);
        System.out.println("monsterMapper的类型=" + monsterMapper.getClass());
    }

    @Test
    public void delMonster() {
        //删除id=2的记录
        monsterMapper.delMonster(2);
        //如果是增删改操作，需要提交事务，因为它默认不提交
        if (sqlSession != null) {
            sqlSession.commit();
            //将连接释放回连接池
            sqlSession.close();
        }
        System.out.println("删除成功....");
    }
}

测试结果：

数据库id=2的记录成功被删除：

3.3.4修改&查询¶

（1）修改 MonsterMapper.java 接口，声明修改和查询的方法

//修改Monster
public void updateMonster(Monster monster);
//查询-根据id
public Monster getMonsterById(Integer id);
//查询所有的Monster
public List<Monster> findAllMonster();

（2）映射文件 MonsterMapper.xml 中实现方法

<!--配置/实现updateMonster方法
    这里的入参可以使用类型别名，为Java类型设置一个缩写名字，可以降低冗余的全限定类名的书写
    类型别名在mybatis的配置文件中配置，而不是当前的文件-->
<update id="updateMonster" parameterType="Monster">
    UPDATE `monster`
    SET `age`=#{age},`birthday`=#{birthday},`email`=#{email},
    `gender`=#{gender},`name`=#{name},`salary`=#{salary}
    WHERE `id`=#{id};
</update>

<!--配置/实现getMonsterById方法,
resultType 期望从这条语句中返回结果的类全限定名或别名。
注意，如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身的类型。-->
<select id="getMonsterById" resultType="Monster">
    SELECT * FROM `monster` WHERE id=#{id};
</select>

<!--实现findAllMonster方法
如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身的类型-->
<select id="findAllMonster" resultType="Monster">
    SELECT * FROM `monster`;
</select>

（3）配置别名

（4）修改测试类，添加测试方法

package com.li.mapper;

import com.li.entity.Monster;
import com.li.util.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Before;
import org.junit.Test;

import java.util.Date;
import java.util.List;

/**
 * @author 李
 * @version 1.0
 */
public class MonsterMapperTest {
    //属性
    private SqlSession sqlSession;
    private MonsterMapper monsterMapper;

    @Before
    public void init() {
        sqlSession = MybatisUtils.getSqlSession();
        monsterMapper = sqlSession.getMapper(MonsterMapper.class);
        System.out.println("monsterMapper的类型=" + monsterMapper.getClass());
    }

    @Test
    public void updateMonster() {
        Monster monster = new Monster();
        monster.setAge(50);
        monster.setBirthday(new Date());
        monster.setEmail("king@qq.com");
        monster.setGender(0);
        monster.setName("白骨精");
        monster.setSalary(20000);
        monster.setId(3);
        monsterMapper.updateMonster(monster);
        if (sqlSession != null) {
            sqlSession.commit();
            sqlSession.close();
        }
        System.out.println("修改成功..");
    }

    @Test
    public void getMonsterById() {
        Monster monster = monsterMapper.getMonsterById(3);
        System.out.println("monster=" + monster);
        if (sqlSession != null) {
            sqlSession.close();
        }
    }

    @Test
    public void findAllMonster() {
        List<Monster> monsters = monsterMapper.findAllMonster();
        for (Monster monster : monsters) {
            System.out.println("monster="+monster);
        }
        if (sqlSession != null) {
            sqlSession.close();
        }
    }
}

测试updateMonster()方法：

测试getMonsterById()方法：

测试findAllMonster()方法：

4.日志输出-查看SQL¶

在开发Mybatis程序时，比如执行测试方法，程序员往往需要查看底层发给MySql的SQL语句到底长什么样，这时应该如何查看？

解决方案：日志输出。

（1）修改Mybatis-config.xml文件，加入日志输出配置，方便分析SQL语句

（2）比如测试updateMonster() 方法时，输出的结果为：

Logging initialized using 'class org.apache.ibatis.logging.stdout.StdOutImpl' adapter.
PooledDataSource forcefully closed/removed all connections.
PooledDataSource forcefully closed/removed all connections.
PooledDataSource forcefully closed/removed all connections.
PooledDataSource forcefully closed/removed all connections.
sqlSessionFactory=class org.apache.ibatis.session.defaults.DefaultSqlSessionFactory
monsterMapper的类型=class com.sun.proxy.$Proxy7
Opening JDBC Connection
Wed Feb 22 19:09:14 CST 2023 WARN: Establishing SSL connection without server's identity verification is not recommended. According to MySQL 5.5.45+, 5.6.26+ and 5.7.6+ requirements SSL connection must be established by default if explicit option isn't set. For compliance with existing applications not using SSL the verifyServerCertificate property is set to 'false'. You need either to explicitly disable SSL by setting useSSL=false, or set useSSL=true and provide truststore for server certificate verification.
Created connection 1475491159.
Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@57f23557]
==>  Preparing: UPDATE `monster` SET `age`=?,`birthday`=?,`email`=?, `gender`=?,`name`=?,`salary`=? WHERE `id`=?;
==> Parameters: 50(Integer), 2023-02-22 19:09:14.079(Timestamp), king333@qq.com(String), 0(Integer), 白骨精(String), 20000.0(Double), 3(Integer)
<==    Updates: 1
Committing JDBC Connection [com.mysql.jdbc.JDBC4Connection@57f23557]
Resetting autocommit to true on JDBC Connection [com.mysql.jdbc.JDBC4Connection@57f23557]
Closing JDBC Connection [com.mysql.jdbc.JDBC4Connection@57f23557]
Returned connection 1475491159 to pool.
修改成功..

Process finished with exit code 0

当进行多表联查的时候，日志输出对我们的调试很有帮助。