MyBatis入门

1. MyBatis简介

1.1 什么是框架

• 框架（Framework）是一个框子——指其约束性，也是一个架子——指其支撑性，即已经对基础的代码进行了封装并提供相应的API，开发者在使用框架是直接调用封装好的api可以省去很多代码编写，从而提高工作效率和开发速度。

1.2 什么是MyBatis

• MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、获取结果集等jdbc繁杂的过程代码。
• MyBatis 本是apache的一个开源项目iBatis， 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis。iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。

1.3 MyBatis的好处

• 传统JDBC代码分析

public class JdbcTest {
    public static void main(String[] args) {
        try {
            //1.加载数据库驱动
            Class.forName("com.mysql.jdbc.Driver");
            //2.创建连接对象
            String url = "jdbc:mysql://192.168.10.137:3306/ssm";
            Connection connection = DriverManager.getConnection(url, 
                                                                "root",
                                                                "1111");
            String sql = "select * from account";
            //3.准备PreparedStatement对象
            PreparedStatement pst = connection.prepareStatement(sql);
            //4.执行sql语句
            ResultSet rs = pst.executeQuery();
            //5.遍历结果集
            while(rs.next()){
                Integer id = rs.getInt("id");
                String name = rs.getString("name");
                Double money = rs.getDouble("money");
                System.out.println(id + " " + name + " " + money);
            }
            //6.关闭资源
            rs.close();
            pst.close();
            connection.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

通过分析以上代码不难发现，JDBC存在以下一些缺点：

• 需要手动创建和释放链接
• sql语句在代码中硬编码
• 对结果的解析

学习使用MyBatis可以解决以上缺点

2. 入门案例

2.1 创建工程

• 创建Maven工程，在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>

  <groupId>com.by</groupId>
  <artifactId>01_mybatis_HelloWorld</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
    <!-- 项目源码及编译输出的编码 -->
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <!-- 项目编译JDK版本 -->
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.4.5</version>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.32</version>
    </dependency>
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.17</version>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
    </dependency>
  </dependencies>
  <build>
    <!-- 如果不添加此节点src/main/java目录下的所有配置文件都会被漏掉。 -->
    <resources>
      <resource>
        <directory>src/main/java</directory>
        <includes>
          <include>**/*.xml</include>
        </includes>
      </resource>

      <resource>
        <directory>src/main/resources</directory>
      </resource>
    </resources>
  </build>
</project>

2.2 配置log4j

• 在resources目录下创建log4j.properties文件

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

• 使用log4j能够在控制台打印日志和sql语句

2.3 创建实体类

• 创建的实体类中的属性名要和数据库中对应表的字段名保持一致，下面以创建User实体类为例

public class User implements Serializable {
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "User{" +
        "id=" + id +
        ", username='" + username + '\'' +
        ", birthday=" + birthday +
        ", sex='" + sex + '\'' +
        ", address='" + address + '\'' +
        '}';
    }
}

2.4 编写Mapper接口

• 编写Mpper接口，下例只编写查询所有用户的方法

public interface UserMapper {
    public List<User> queryAll();
}

2.5 编写Mapper接口的XML配置文件

• 在MyBatis中不需要编写Mapper接口的实现类，只需要写配置文件，这样可以解决JDBC中sql语句在代码中硬编码的缺点，文件名一般和接口名一致

<?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">
<!--namespace：隔离sql，一般是接口名称的全类名-->
<mapper namespace="com.by.mapper.UserMapper">
  <!--
  id:和接口方法名保持一致
  resultType:和接口返回类型保持一致
  -->
  <select id="queryAll" resultType="com.by.pojo.User">
    select * from user
  </select>
</mapper>

2.6 编写MyBatis的XML配置文件

• 在resources目录下创建mybatis-config.xml文件

<?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>
  <!-- 和spring整合后 environments配置将废除-->
  <environments default="dev">
    <!-- dev环境 -->
    <environment id="dev">
      <!-- 配置事务的类型:type="JDBC | MANAGED" 两种方式
      JDBC:表示使用JDBC中原生的事务管理方式
      MANAGED:被管理，例如Spring
      -->
      <transactionManager type="JDBC"></transactionManager>
      <!-- 配置连接数据库的信息：用的是数据源(连接池) -->
      <dataSource type="POOLED">
        <!-- mysql5 -->
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis"/>
        <property name="username" value="root"/>
        <property name="password" value="1111"/>
      </dataSource>
    </environment>
  </environments>
  <!-- 告知 mybatis 映射配置的位置 -->
  <mappers>
    <mapper resource="com/by/mapper/Usermapper.xml"/>
  </mappers>
</configuration>

2.7 编写测试类进行测试

public class MyBatisTest {

    @Test
    public void testFindAll() throws IOException {
        //加载配置文件
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        //创建sqlSessionFactory
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        //创建sqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper接口的代理类
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        System.out.println(userMapper.getClass());//class com.sun.proxy.$Proxy5
        List<User> userList = userMapper.findAll();
        for (User user : userList) {
            System.out.println(user);
        }
    }
}

3. MyBatis运行过程

1. 加载 mybatis-config.xml 配置文件：读取 MyBatis 的全局配置文件，获取数据源、环境配置、事务管理器、插件、映射器等信息。
2. 创建 SqlSessionFactory：通过 SqlSessionFactoryBuilder 根据全局配置文件创建 SqlSessionFactory 实例。SqlSessionFactory 负责生成 SqlSession 实例。
3. 获取 SqlSession：通过 SqlSessionFactory 创建 SqlSession 实例。SqlSession 是执行数据库操作的主要接口。
4. 获取 Mapper 接口：通过 SqlSession 获取 Mapper 接口的代理对象。Mapper 接口定义了与数据库交互的方法。
5. 调用 Mapper 方法：调用 Mapper 接口的方法。每个方法对应一个 SQL 语句，该语句在映射文件 (Mapper XML 文件) 中定义。
6. 解析 SQL 语句：根据 Mapper XML 文件中的映射配置，解析 SQL 语句并进行参数替换。
7. 执行 SQL：MyBatis 使用执行器 (Executor) 执行解析后的 SQL 语句，查询数据库或执行其他操作。
8. 映射结果到 Java 对象：将数据库查询结果映射为 Java 对象。MyBatis 使用映射配置 (如 resultType 或 resultMap) 将结果集转换为相应的 Java 对象。将映射后的 Java 对象返回给调用 Mapper 方法的调用者。