MyBatis之原理和快速入门学习

Table of Contents

 

MyBatis官网：https://mybatis.org/mybatis-3/zh/index.html

01.什么是 MyBatis？

1.1 mybatis介绍

1.2 传统的jdbc问题

1.3 mybatis原理

02.MyBatis快速入门案例(XML方式，注解后面再做笔记)

2.1 在pom.xml添加依赖：

2.2 创建实体类以及接口

2.3 创建IUserDao接口的XML映射文件

2.4 创建Mybatis的主配置⽂件

2.5 log4j日志配置：

2.5 编写测试类：

2.6 测试结果：

 03总结：

 

注意：这只是快速入门，后面会做更详细的笔记

---

MyBatis官网：https://mybatis.org/mybatis-3/zh/index.html

01.什么是 MyBatis？

mybatis是⼀个优秀的基于java的持久层框架，它内部封装了jdbc，使开发者只需要关注sql语句本身， ⽽不需要花费精⼒去处理加载驱动、创建连接、创建statement等繁杂的过程。

mybatis通过xml或注解的⽅式将要执⾏的各种statement配置起来，并通过java对象和statement中sql 的动态参数进⾏映射⽣成最终执⾏的sql语句，最后由mybatis框架执⾏sql并将结果映射为java对象并返 回。

采⽤ORM思想解决了实体和数据库映射的问题，对jdbc进⾏了封装，屏蔽了jdbc api底层访问细节，使 我们不⽤与jdbc api打交道，就可以完成对数据库的持久化操作。

1.1 mybatis介绍

• mybatis是⼀个持久层框架，⽤java编写的。
• 它封装了jdbc操作的很多细节，使开发者只需要关注sql语句本身，⽽⽆需关注注册驱动，创建连接等繁杂过程
• 它使⽤了ORM思想实现了结果集的封装。

ORM：Object Relational Mappging 对象关系映射 简单的说： 就是把数据库表和实体类及实体 类的属性对应起来 让我们可以操作实体类就实现操作数据库表。

1.2 传统的jdbc问题

1. 数据库链接创建、释放频繁造成系统资源浪费从⽽影响系统性能，如果使⽤数据库链接池可解决此问题。
2. Sql语句在代码中硬编码，造成代码不易维护，实际应⽤sql变化的可能较⼤，sql变动需要改变java 代码。
3. 使⽤preparedStatement向占有位符号传参数存在硬编码，因为sql语句的where条件不⼀定，可 能多也可能少，修改sql还要修改代码，系统不易维护。
4. 对结果集解析存在硬编码（查询列名），sql变化导致解析代码变化，系统不易维护，如果能将数 据库记录封装成pojo对象解析⽐较⽅便。

1.3 mybatis原理

首先了解4个核心对象：要结合JDBC来理解MyBatis的工作原理往往才能更透彻。

• JDBC的4个核心对象：

1. DriverManager，用于注册数据库连接
2. Connection，与数据库连接对象
3. Statement/PrepareStatement，操作数据库SQL语句的对象
4. esultSet，结果集或一张虚拟表

• Mybatis的4个核心对象：

1. SqlSession对象，该对象中包含了执行SQL语句的所有方法【1】。类似于JDBC里面的Connection 【2】。
2. Executor接口，它将根据SqlSession传递的参数动态地生成需要执行的SQL语句，同时负责查询缓存的维护。类似于JDBC里面的Statement/PrepareStatement。
3. MappedStatement对象，该对象是对映射SQL的封装，用于存储要映射的SQL语句的id、参数等信息。
4. ResultHandler对象，用于对返回的结果进行处理，最终得到自己想要的数据格式或类型。可以自定义返回类型。

【1】和【2】的说明如下：

在JDBC中，Connection不直接执行SQL方法，而是利用Statement或者PrepareStatement来执行方法。

在使用JDBC建立了连接之后，可以使用Connection接口的createStatement()方法来获取Statement对象，也可以调用prepareStatement()方法获得PrepareStatement对象，通过executeUpdate()方法来执行SQL语句。

而在MyBatis中，SqlSession对象包含了执行SQL语句的所有方法。但是它是委托Executor执行的。

从某种意义上来看，MyBatis里面的SqlSession类似于JDBC中的Connection，他们都是委托给其他类去执行。

MyBatis的工作原理如下图所示：

yBatis工作原理图

MyBatis内部每一步流程：

（1）读取MyBatis的配置文件。mybatis-config.xml为MyBatis的全局配置文件，用于配置数据库连接信息。

（2）加载映射文件。映射文件即SQL映射文件，该文件中配置了操作数据库的SQL语句，需要在MyBatis配置文件mybatis-config.xml中加载。mybatis-config.xml 文件可以加载多个映射文件，每个文件对应数据库中的一张表。

（3）构造会话工厂。通过MyBatis的环境配置信息构建会话工厂SqlSessionFactory。

（4）创建会话对象。由会话工厂创建SqlSession对象，该对象中包含了执行SQL语句的所有方法。

（5）Executor执行器。MyBatis底层定义了一个Executor接口来操作数据库，它将根据SqlSession传递的参数动态地生成需要执行的SQL语句，同时负责查询缓存的维护。

（6）MappedStatement对象。在Executor接口的执行方法中有一个MappedStatement类型的参数，该参数是对映射信息的封装，用于存储要映射的SQL语句的id、参数等信息。

（7）输入参数映射。输入参数类型可以是Map、List等集合类型，也可以是基本数据类型和POJO类型。输入参数映射过程类似于JDBC对preparedStatement对象设置参数的过程。

（8）输出结果映射。输出结果类型可以是Map、List等集合类型，也可以是基本数据类型和POJO类型。输出结果映射过程类似于JDBC对结果集的解析过程。

02.MyBatis快速入门案例(XML方式，注解后面再做笔记)

2.1 在pom.xml添加依赖：

• IDEA软件创建Maven工程，并在pom.xml添加mybatis依赖：

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
<!-- x.x.x只是版本号 -->
</dependency>

这里还有其他依赖：

        <!-- 测试相关的依赖 -->
        <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>8.0.18</version>
        </dependency>

        <!-- 日志工具相关依赖log4j好处就是可以看到sql语句的执行情况 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

• 创建一个简单数据库mybatis及表user以及测试数据:：

Caption

 

2.2 创建实体类以及接口

•  在demo.domain包下，创建对应的实体类User.java：

public class User {
    private int id;
    private String username;
    private String sex;
    private String address;

    public int getId() {
        return id;
    }

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

    public String getUsername() {
        return username;
    }

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

    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+
                ",sex=" +sex+
                "address=" +address+
                "}";
    }
}

• 在demo.dao下，创建一个接口IUserDao.java:

public interface IUserDao {
    /**
     * 查找所有用户
     * @return
     */
    public List<User> findAllUser();
}

注意的是，一般接口取名是xxxMapper之类（官方案例也是） ，但xxxDao这样只是个人好记

2.3 创建IUserDao接口的XML映射文件

• 在resource⽬录下创建demo.dao⽬录,并且创建IUserDao.xml：

 

<?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="demo.dao.IUserDao">
    <select id="findAllUser" resultType="demo.domain.User">
     select * from user
     </select>
</mapper>

 

2.4 创建Mybatis的主配置⽂件

•  Resource⽬录下创建并且编写mybatisConfig.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>
    <!-- 配置环境 -->
    <environments default="development">
        <!-- 配置mysql环境 -->
        <environment id="development">
            <!-- 配置事务 -->
            <transactionManager type="JDBC"/>
            <!-- 配置数据源连接池 -->
            <dataSource type="POOLED">
                <!-- 这⾥⽤得是mysql8的驱动包 -->
                <property name="driver" value="com.mysql.cj.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>
<!--        引入这个XML映射器文件-->
        <mapper resource="demo/dao/IUserDao.xml"/>
    </mappers>

</configuration>

2.5 log4j日志配置：

由于MyBatis默认使⽤log4j输出⽇志信息，所以如果要查看控制台的输出SQL语句，那么就需要在 classpath路径下配置其⽇志⽂件。在resourses下新建⼀个log4j.properties⽂件

# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE            debug   info   warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE

# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE

# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=d:\axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

 

2.5 编写测试类：

• 在test/java下创建测试类DemoTest.java：

public class DemoTest {
    InputStream inputStream;
    SqlSession session;
    SqlSessionFactory sqlSessionFactory;
    @Before
    public void init() throws IOException {
        //1.读取配置⽂件
        inputStream = Resources.getResourceAsStream("mybatisConfig.xml");
        //2.创建SqlSessionFactory的构建者对象,使⽤构建者创建⼯⼚对象SqlSessionFactory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        //3.使⽤SqlSessionFactory⽣产SqlSession对象
        session = sqlSessionFactory.openSession();
    }
    @After
    public void destroy() throws IOException{
        //6.释放资源
        session.close();
        inputStream.close();
    }
    @Test
    public void test() throws IOException {
        //4.使⽤SqlSession创建dao接⼝的代理对象
        IUserDao userDao = session.getMapper(IUserDao.class);
        //5.使⽤代理对象执⾏查询所有⽅法
        List<User> users = userDao.findAllUser();
        for (User user : users){
            System.out.println(user);
        }
    }
}

@Before和@After只是junit中的注解，表示运行@Test注解的方法前后 必须运行的代码段

2.6 测试结果：

 03总结：

通过快速⼊⻔示例，我们发现使⽤mybatis是⾮常容易的⼀件事情，因为只需要编写Dao接⼝并且按照 mybatis要求编写两个配置⽂件，就可以实现功能。远⽐我们之前的jdbc⽅便多了。我们使⽤注解之 后，将变得更为简单，只需要编写⼀个mybatis配置⽂件就够了。

说明 1.创建IUserDao.xml 和 IUserDao.java时名称是为了和我们之前的知识保持⼀致。 在 Mybatis中它把持久层的操作接⼝名称和映射⽂件也叫做：Mapper 所以：IUserDao 和 IUserMapper是⼀样的

1.  映射配置⽂件的mapper标签namespace属性的取值必须是dao接⼝的全限定类名
2. 映射配置⽂件的操作配置（select），id属性的取值必须是dao接⼝的⽅法名

当我们遵从了1、2点之后，我们在开发中就⽆须再写dao的实现类