F001MyBatis学习笔记-入门

淡淡的烟草味﹌ 2023-10-09 13:11 32阅读 0赞

> **最后编辑时间：2022年4月18日20点42分**

# 一、前置知识 #

## 1、什么是框架 ##

框架（Framework）是整个或部分系统的可重用设计，表现为一组抽象构件及构件实例间交互的方法;另一种定义认为，框架是可被应用开发者定制的应用骨架。前者是从应用方面而后者是从目的方面给出的定义。

## 2、三层架构 ##

表现层：用于展示数据；

> @Controller：仅与前端进行交互！

业务层：用于业务处理；

> @Service：核心业务逻辑代码！

持久层：用于和数据库交互；

> @Repository：与数据库交互！

图示：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70][]

## 3、持久层技术解决方案 ##

### JDBC技术： ###

Connection；

PreparedStatement；

ResultSet；

### Spring的dbcTemplate： ###

**Spring中对JDBC的简单封装；**

### Apache的DBUtils： ###

与Spring中对JDBC很像，也是对JDBC的简单封装；

备注：以上都不是框架，JDBC是规范，后面两个只算是工具类；

# 二、MyBatis概述 #

## 1、简介 ##

> **白话简介：JDBC是用Java操作数据库，但是JDBC太麻烦，MyBatis是对JDBC的进一步封装。**

MyBatis 是一款优秀的**持久层框架**，它**支持定制化 SQL、存储过程以及高级映射**；

MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集；

MyBatis 可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 的 POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录；

MyBatis使用了**ORM的思想**实现了**结果集**的封装；

作用：
    1、用来访问数据库，进行持久化操作；
    2、本质上是对JDBC进行封装；

## 2、ORM思想 ##

Object Relational Mapping 对象关系映射

> **白话：****把数据库表和实体类的属性对应起来，让我们可以通过操作实体类来实现操作数据库表；**

## 3、官方文档地址 ##

[mybatis – MyBatis 3 | 简介][mybatis _ MyBatis 3 _]

# 三、MyBatis环境搭建 #

## 1、内容 ##

POM.XML文件：用于指定所用到云端框架的坐标；
    实体类：实体类对应要操作的表；
    接口：接口是对数据库进行操作的Java代码（方法）；
    主配置文件：配置数据库的信息用于访问数据库，指定映射配置文件；
    映射配置文件：指定接口中的方法所执行的SQL语句；

## 2、MyBatis的基本构成 ##

### SqlSessionFactoryBuilder（构造器）： ###

根据配置信息或者代码来生成SqlSessionFactory（工厂接口）；

### SqlSessionFactory（工厂接口）： ###

依靠工厂来生成SqlSession（会话）；

**概述：**

> 1、每个MyBatis应用都是以**SqlSessionFactory**的实例为中心的；
> 
> 2、SqlSessionFactory的实例SqlSessionFactoryBuilder来获得；
> 
> 3、SqlSessionFactory是一个工厂接口而不是一个类，它的任务是创建SqlSession；
> 
> 4、SqlSession是一个会话，类似JDBC的Connection对象；
> 
> 5、MyBatis提供了两种方式去创建SqlSessionFactory：XML配置的方式（推荐）和代码的方式；
> 
> 6、Configuration存在于整个MyBatis应用的生命周期中，体积小，性能高，解析一次XML文件保存到Configuration中，可重复读取使用；
> 
> 7、DefaultSqlSessionFactory是SqlSessionFactory的一个实现类；

**使用XML方式构建SqlSessionFactory：**

**（见SqlMapConfig.xml）**

**代码方式创建SqlSessionFactory：**

> **大部分情况下不用，需要加入自己特性的时候才用到，例如数据源配置的信息要求是加密的时候我们需要把他们转化过来。**

package com.zibo.mybatis_crud.utils;
    
    import com.zibo.mybatis_crud.dao.IUserDao;
    import com.zibo.mybatis_crud.domain.User;
    import org.apache.ibatis.datasource.pooled.PooledDataSource;
    import org.apache.ibatis.mapping.Environment;
    import org.apache.ibatis.session.Configuration;
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.apache.ibatis.session.SqlSessionFactoryBuilder;
    import org.apache.ibatis.transaction.TransactionFactory;
    import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory;
    
    public class GetSqlSessionFactory {
        public static SqlSessionFactory get(){
            //1、构建数据库连接池
            PooledDataSource dataSource = new PooledDataSource();
            dataSource.setDriver("com.mysql.cj.jdbc.Driver");
            dataSource.setUrl("jdbc:mysql://localhost:3306/zibo?serverTimezone=UTC");
            dataSource.setUsername("root");
            dataSource.setPassword("zibo15239417242");
            //2、构建数据库事务方式
            TransactionFactory transactionFactory = new JdbcTransactionFactory();
            //3、创建数据库运行环境
            Environment environment = new Environment("development",transactionFactory,dataSource);
            //4、构建Configuration对象
            Configuration configuration = new Configuration(environment);
            //5、注册一个MyBatis上下文别名
            configuration.getTypeAliasRegistry().registerAlias("user", User.class);
            //6、加入一个映射器
            configuration.addMapper(IUserDao.class);
            //7、使用SqlSessionFactoryBuilder构建SqlSessionFactory
            return new SqlSessionFactoryBuilder().build(configuration);
        }
    }

### SqlSession（会话）： ###

是一个可以**发送SQL去执行**并返回结果，也可以获取Mapper的接口；

**SqlSession（会话）的两种用途：**

> 1、获取映射器，让映射器通过命名空间和方法名称找到对应的SQL，发送给数据库执行后返回结果；
> 
> 2、直接通过命名空间信息去执行SQL返回结果；

### SQL Mapper（映射器）： ###

是MyBatis新设计的组件，是由一个接口和XML文件（或者注解）构成的，需要给出对应的SQL和映射规则，负责发送SQL去执行并返回结果；

**作用：**

> 1、定义参数类型；
> 
> 2、描述缓存；
> 
> 3、描述SQL语句；
> 
> 4、定义查询结果和POJO的映射关系；

SQL Mapper（映射器）可以用XML方式和代码方式实现，强烈建议XML方式，代码方式不再演示，XML见（**IStudentDao.xml**）：

## 3、步骤： ##

### 第一步：创建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.zibo.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>1.0-SNAPSHOT</version>
        <packaging>jar</packaging>
        <dependencies>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.4.6</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.17</version>
            </dependency>
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.13-beta-3</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </project>

### 第二步：创建实体类和dao的接口； ###

**实体类：**

package com.zibo.mybatis;
    
    import java.io.Serializable;
    
    public class Student implements Serializable {
        private int id;
        private String name;
        private int age;
        private String sex;
    
        public int getId() {
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
        public String getSex() {
            return sex;
        }
    
        public void setSex(String sex) {
            this.sex = sex;
        }
    
        @Override
        public String toString() {
            return "Student{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    ", age=" + age +
                    ", sex='" + sex + '\'' +
                    '}';
        }
    }

**接口：**

package com.zibo.mybatis;
    
    import java.util.List;
    
    public interface IStudentDao {
        List<Student> findAll();
    }

### 第三步：创建MyBatis的主配置文件； ###

**SqlMapConfig.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="mysql">
    
            <environment id="mysql">
    
                <transactionManager type="JDBC"></transactionManager>
    
                <dataSource type="POOLED">
    
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://rm-wz94daz94uktn3x7x4o.mysql.rds.aliyuncs.com/zibo?useUnicode=true;useJDBCCompliantTimezoneShift=true;useLegacyDatetimeCode=false;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="zibo@709570094"/>
                </dataSource>
            </environment>
        </environments>
    
        <mappers>
            <mapper resource="com/zibo/mybatis/IStudentDao.xml"/>
        </mappers>
    </configuration>

### 第四步：创建映射配置文件； ###

**IStudentDao.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="com.zibo.mybatis.IStudentDao">
    
        <select id="findAll" resultType="com.zibo.mybatis.Student">
            select * from student;
        </select>
    </mapper>

### 各个文件位置图： ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 1][]

## 4、注意事项 ##

①MyBatis把持久层的操作接口和映射文件也叫做Mapper，所以文件XXXDao和XXXMapper是一样的；

②在idea创建目录的时候，它和包是不一样的：

包的创建：com.zibo.XXX是三级目录；

目录的创建：com.zibo.XXX是一级目录；

③MyBatis的映射配置文件的位置必须和dao接口的包结构相同；

④映射配置文件的mapper标签的namespace属性的取值必须是dao接口（Mapper）的全类名；

⑤映射配置文件的操作配置（select），id的属性取值必须是dao接口的方法名；

当遵循了③④⑤点之后，我们在开发中就无需再写dao实现类；

# 四、入门 #

> 2022年4月18日20点37分
> 
> 那个时候的自己似乎比现在更加虔诚！

## 1、步骤 ##

第一步：读取配置文件；

第二步：创建一个SqlSessionFactory工厂；

第三步：使用工厂生产SqlSession对象；

第四步：使用SqlSession对象创建接口的代理对象；

第五步：使用代理对象执行方法；

第六步：释放资源

## 2、代码演示 ##

### 配置文件： ###

**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

### 测试代码： ###

package com.zibo.mybatis;
    
    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;
    import java.util.List;
    
    public class Test {
        public static void main(String[] args) throws IOException {
            //第一步：读取配置文件；
            InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
            //第二步：创建一个SqlSessionFactory工厂；
            SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
            SqlSessionFactory factory = builder.build(in);
            //第三步：使用工厂生产SqlSession对象；
            SqlSession session = factory.openSession();
            //第四步：使用SqlSession对象创建接口的代理对象；
            IStudentDao iStudentDao = session.getMapper(IStudentDao.class);
            //第五步：使用代理对象执行方法；
            List<Student> students = iStudentDao.findAll();
            for (Student student : students) {
                System.out.println(student);
            }
            //第六步：释放资源
            session.close();
            in.close();
        }
    }

### 运行结果： ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 2][]

# 五、入门案例分析 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 3][]

# 六、MyBatis基于注解的入门案例 #

## 1、原基础修改步骤： ##

第一步：删除IStudentDao.xml；

第二步：在IStudentDao的方法上使用Select注解，并指定SQL语句；

@Select("select * from student")

第三步：在SqlMapConfig.xml中的mapper配置中使用class属性指定被注解的dao全限定类名；

## 2、关于dao实现类 ##

实际开发中越简便越好，所有不管是XML配置还是注解配置都采用不写dao实现类的方式，但是MyBatis是支持写dao实现类的；

## 3、写dao实现类的演示 ##

### 修改步骤： ###

第一步：创建一个dao的接口实现类；

package com.zibo.mybatis;
    
    import org.apache.ibatis.session.SqlSession;
    import org.apache.ibatis.session.SqlSessionFactory;
    
    import java.util.List;
    
    public class IStudentDaoImpl implements IStudentDao {
    
        private SqlSessionFactory factory;
    
        public IStudentDaoImpl(SqlSessionFactory factory) {
            this.factory = factory;
        }
    
        @Override
        public List<Student> findAll() {
            //1、使用工厂生产SqlSession对象
            SqlSession session = factory.openSession();
            //2、使用session执行查询方法
            //3、返回查询结果
            return session.selectList("com.zibo.mybatis.IStudentDao.findAll");
        }
    }

第二步：修改Test测试类：

package com.zibo.mybatis;
    
    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;
    import java.util.List;
    
    public class Test {
        public static void main(String[] args) throws IOException {
            //第一步：读取配置文件；
            InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
            //第二步：创建一个SqlSessionFactory工厂；
            SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
            SqlSessionFactory factory = builder.build(in);
            //第三步：使用工厂生产SqlSession对象；
            IStudentDaoImpl iStudentDao = new IStudentDaoImpl(factory);
    
    //        SqlSession session = factory.openSession();
    //        //第四步：使用SqlSession对象创建接口的代理对象；
    //        IStudentDao iStudentDao = session.getMapper(IStudentDao.class);
            //第五步：使用代理对象执行方法；
            List<Student> students = iStudentDao.findAll();
            for (Student student : students) {
                System.out.println(student);
            }
            //第六步：释放资源
    //        session.close();
            in.close();
        }
    }

# 七、生命周期 #

## 1、SqlSessionFactoryBuilder ##

> Builder 创建工厂（SqlSessionFactory）！

是利用XML或者Java代码的方式**构建SqlSessionFactory**，通过它可以构建多个SqlSessionFactory。

它的作用是一个构建器，一旦我们构建了SqlSessionFactory就不再需要它了，因此它一般在局部代码中；

## 2、SqlSessionFactory ##

> 工厂（SqlSessionFactory）创建会话（SqlSession）！

SqlSessionFactory作用是创建SqlSession，而SqlSession是一个会话，相当于JDBC的Connection对象，每次应用程序访问数据库，都需要通过SqlSessionFactory创建SqlSession对象，所以SqlSessionFactory应该存在于MyBatis应用的整个生命周期；

如果我们多次创建同一个数据库的SqlSessionFactory，数据库连接（Connection）资源很快就会被耗尽，所以SqlSessionFactory的责任是唯一的，就是创建SqlSession，我们果断采用单例模式，所以每个数据库应该只对应一个SqlSessionFactory；

## 3、SqlSession ##

> 会话（SqlSession）发送语句，并拿到返回结果！

SqlSession是一个会话，相当于JDBC中的Connection对象，它的生命周期应该是在请求数据库请求事务的过程中。它是一个**线程不安全**的对象，在涉及多线程的时候我们要特别当心，操作数据库需要注意其**隔离级别**、**数据库锁**等高等特性；

此外，**每次创建的SqlSession都要及时关闭它**，否则对系统性能的影响很大；

它存活于一个应用的请求和操作，可以执行多条SQL语句，保证事务的一致性；

## 4、Mapper ##

> 是 MyBatis 新设计的组件！作用是发送SQL去执行并返回结果！

Mapper是一个接口，没有任何实现类，它的作用是**发送SQL**，然后返回我们需要的结果，或者执行SQL从而修改数据库的数据，因此它应该在一个SqlSession方法之内，是一个方法级别的东西，所以尽量在Sqlsession方法事务中使用它，然后废弃掉。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191002154355776.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[mybatis _ MyBatis 3 _]: https://mybatis.org/mybatis-3/zh/index.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191002165035575.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191004112403965.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20191004112822123.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI5Njg5MzQz,size_16,color_FFFFFF,t_70