Mybatis

发表于 2023-11-26 更新于 2023-12-19 分类于 Java ， Mybatis

简单介绍持久层框架Mybatis的概念、MaBatis快速入门、Mapper代理开发以及MyBatis的核心配置文件

1. Mybatis概述

1.1 Mybatis概念

MyBatis 是一款优秀的持久层框架，用于简化 JDBC 开发

[MyBatis官网](mybatis – MyBatis 3 | 入门)，有教程、依赖安装和配置文件的编写。

持久层：

负责将数据保存到数据库的那一层代码。

以后开发我们会将操作数据库的Java代码作为持久层。而Mybatis就是对jdbc代码进行了封装。

JavaEE三层架构：表现层（负责页面展示）、业务层（负责业务处理）、持久层（负责将数据到保存到数据库）

框架：

框架就是一个半成品软件，是一套可重用的、通用的、软件基础代码模型，在框架的基础之上构建软件编写更加高效、规范、通用、可扩展

1.2 JDBC缺点

下面是 JDBC 代码，我们通过该代码分析都存在什么缺点：

硬编码
- 注册驱动、获取连接
  
  上图标1的代码有很多字符串，而这些是连接数据库的四个基本信息，以后如果要将Mysql数据库换成其他的关系型数据库的话，这四个地方都需要修改，如果放在此处就意味着要修改我们的源代码。
- SQL语句
  
  上图标2的代码。如果表结构发生变化，SQL语句就要进行更改。这也不方便后期的维护。
操作繁琐
- 手动设置参数
- 手动封装结果集
  
  上图标4的代码是对查询到的数据进行封装，而这部分代码是没有什么技术含量，而且特别耗费时间的。

1.3 Mybatis优点

硬编码可以配置到配置文件
操作繁琐的地方mybatis都自动完成

如图所示：

2. MyBatis快速入门

说实话是不想写了，写这种工具类的不知道有没有意义，只是为了回顾吗，算了，都写到这了。

MyBatis快速入门教学视频，这是b站上黑马程序员的视频，本来文档就抄的他的，视频内容大差不差，仅仅一些小内容有改变。

Mybatis快速入门-查询user表中所有数据步骤

创建user表，添加数据库数据

创建Maven模块，在pom.xml中导入MySQL、Mybatis等依赖的坐标
编写MyBatis核心配置文件mybatis-config.xml，替换数据库连接地址，用户名和密码等信息，解决硬编码问题
1
2
3
4
5
6
<dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="1234"/>
</dataSource>
编写SQL映射文件，统一管理SQL语句，解决硬编码问题
1
2
3
4

<select id="selectAll" resultType="com.itheima.pojo.User">
        select * from tb_user;
</select>
编码

(1). 定义pojo类

(2). 加载核心配置文件，获取SqlSessionFactory对象

(3). 获取SqlSession对象，执行SQL语句

(4). 释放资源

完成后的项目结构为：

maven项目
├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── com.itheima
    │   │       ├── MybatisDemo.java
    |	|		└── pojo
    │   │       	└── User.java
    |	|
    │   └── resources
    │       ├── mybatis-config.xml
    │       └── UserMapper.xml
    │           
    └── test
        ├── java
  		|
        └── resources

创建user表，添加数据

create database mybatis;
use mybatis;

drop table if exists tb_user;

create table tb_user(
	id int primary key auto_increment,
	username varchar(20),
	password varchar(20),
	gender char(1),
	addr varchar(30)
);

INSERT INTO tb_user VALUES (1, 'zhangsan', '123', '男', '北京');
INSERT INTO tb_user VALUES (2, '李四', '234', '女', '天津');
INSERT INTO tb_user VALUES (3, '王五', '11', '男', '西安');

创建模块，导入坐标

在创建好的模块中的 pom.xml 配置文件中添加依赖的坐标

<dependencies>
    <!--mybatis 依赖-->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.5</version>
    </dependency>

    <!--mysql 驱动-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.46</version>
    </dependency>
</dependencies>

编写 MyBatis 核心配置文件 – > 替换数据库连接信息，例如数据库连接，用户名和密码等，解决硬编码问题

在模块下的 resources 目录下创建mybatis的配置文件 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>

    <typeAliases>
        <package name="com.itheima.pojo"/>
    </typeAliases>
    
    <!--
    environments：配置数据库连接环境信息。可以配置多个environment，通过default属性切换不同的environment
    -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--数据库连接信息-->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="1234"/>
            </dataSource>
        </environment>

        <environment id="test">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--数据库连接信息-->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="1234"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
       <!--加载sql映射文件，是resource文件夹下的路径-->
       <mapper resource="UserMapper.xml"/>
    </mappers>
</configuration>

编写 SQL 映射文件 --> 统一管理sql语句，解决硬编码问题

在模块的 resources 目录下创建映射配置文件 UserMapper.xml（管理user表就命名为UserMapper.xml，管理order表就命名为OrderMapper.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">
<!--
	namespace ：名称空间现在不能随意起名字，网上说采用路径+类名可以
-->
<mapper namespace="com.itheima.pojo.User">
    <!-- id是此sql唯一标识，resultType是执行sql的返回结果 -->
    <select id="selectAll" resultType="com.itheima.pojo.User">
        select * from tb_user;
    </select>
</mapper>

编码

在 com.itheima.pojo 包下创建 User类

public class User {
    private int id;
    private String username;
    private String password;
    private String gender;
    private String addr;
    
    //省略了 setter 和 getter
}

在 com.itheima 包下编写 MybatisDemo 测试类并执行

public class MyBatisDemo {

    public static void main(String[] args) throws IOException {
        //1. 加载mybatis的核心配置文件，获取 SqlSessionFactory
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        //2. 获取SqlSession对象，用它来执行sql
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //3. 执行sql
        List<User> users = sqlSession.selectList("test.selectAll"); //参数是一个字符串，该字符串必须是映射配置文件的namespace.id
        System.out.println(users);
        //4. 释放资源
        sqlSession.close();
    }
}

3. Mapper代理开发

这一部分写的我很烦，以后不这样写这类工具的使用了，具体的使用教程直接放视频链接或者网址，只写一些大概步骤和要注意的细节问题。

3.1 Mapper代理开发概述

之前我们写的代码是基本使用方式，它也存在硬编码的问题，如下：

1
2
3

//3. 执行sql
List<User> users = sqlSession.selectList("com.itheima.pojo.User.selectAll"); //参数是一个字符串，该字符串必须是映射配置文件的namespace.id
System.out.println(users);

这里调用 selectList() 方法传递的参数是映射配置文件中的 namespace.id值。这样写也不便于后期的维护。如果使用 Mapper 代理方式（如下图）则不存在硬编码问题。

//3. 执行sql
//3.1 获取UserMapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//3.2 执行方法,其实就是执行sql语句
List<User> users = userMapper.selectAll();
System.out.println(users);

通过上面的描述可以看出 Mapper 代理方式的目的：

解决原生方式中的硬编码
简化后期执行SQL

3.2 使用Mapper代理要求

具体教程视频，强烈推荐

使用Mapper代理方式，必须满足以下要求：

1. 定义与SQL映射文件同名（类似UserMapper.xml）的Mapper接口，并且将Mapper接口和SQL映射文件放置在同一目录下，通常是改变SQL映射文件（像UserMapper.xml）的路径，通常是在resource文件夹下创建与Mapper接口同级的目录。这里要特别注意是如何在resource文件夹下创建与Mapper接口同级的目录，不同于包名com.itheima这种创建文件夹的形式，这里是com/itheima这种形式来创建文件夹。具体可以看教程视频。
1. 设置SQL映射文件的namespace属性为Mapper接口全限定名(即接口的路径名)
  1
  <mapper namespace="com.itheima.mapper.UserMapper" >

在 Mapper 接口中定义方法，方法名就是SQL映射文件中sql语句的id，并保持参数类型和返回值类型一致，这里要注意返回值，这里是返回很多个数据，所以是List,如果是单个数据返回值就是User

<!-- UserMapper.xml内容 -->

<mapper namespace="com.itheima.mapper.UserMapper">
    <!-- id是此sql唯一标识，resultType是执行sql的返回结果 -->
    <select id="selectAll" resultType="com.itheima.pojo.User">
        select * from tb_user;
    </select>
</mapper>

// 对于Mapper接口内容

package com.itheima.mapper;

import com.itheima.pojo.User;
import java.util.List;

public interface UserMapper {
    List<User> selectAll(); //这里要注意返回值，这里是返回很多个数据，所以是List<User>,如果是单个数据返回值就是User
}

编码

（1）通过SqlSession的getMapper方法获取Mapper接口的代理对象

（2）通过对应方法完成sql执行

//2. 获取SqlSession对象，用它来执行sql
SqlSession sqlSession = sqlSessionFactory.openSession();
//3. 执行sql
//3.1 获取UserMapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//3.2 执行方法,其实就是执行sql语句
List<User> users = userMapper.selectAll();
System.out.println(users);
//4. 释放资源
sqlSession.close();

细节：如果Mapper接口名称和SQL映射文件名称相同，并在同一目录下，则可以使用包扫描的方式简
化SQL映射文件的加载，只需将原mybatis-config.xml中加载sql映射文件的部分修改即可。因为首先是写这样的包名很麻烦，二是如果映射文件很多的话也是很麻烦。

修改前：
1
2
3
4
<mappers>

<mapper resource="com/itheima/mapper/UserMapper.xml"/>
</mappers>
修改后：
1
2
3
4
5
<mappers>


<package name="com.itheima.mapper"/>
</mappers>

3.3 案例代码实现

在 com.itheima.mapper 包下创建 UserMapper接口，代码如下：

public interface UserMapper {
    List<User> selectAll();
    User selectById(int id);
}

在 resources 下创建 com/itheima/mapper 目录，并在该目录下创建 UserMapper.xml 映射配置文件

<!--
    namespace:名称空间。必须是对应接口的全限定名
-->
<mapper namespace="com.itheima.mapper.UserMapper">
    <select id="selectAll" resultType="com.itheima.pojo.User">
        select *
        from tb_user;
    </select>
</mapper>

在 com.itheima 包下创建 MybatisDemo2 测试类，代码如下：

/**
 * Mybatis 代理开发
 */
public class MyBatisDemo2 {

    public static void main(String[] args) throws IOException {

        //1. 加载mybatis的核心配置文件，获取 SqlSessionFactory
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        //2. 获取SqlSession对象，用它来执行sql
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //3. 执行sql
        //3.1 获取UserMapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = userMapper.selectAll();

        System.out.println(users);
        //4. 释放资源
        sqlSession.close();
    }
}

注意：

如果Mapper接口名称和SQL映射文件名称相同，并在同一目录下，则可以使用包扫描的方式简化SQL映射文件的加载。也就是将核心配置文件的加载映射配置文件的配置修改为

<mappers>
    <!--加载sql映射文件-->
    <!-- <mapper resource="com/itheima/mapper/UserMapper.xml"/>-->
    <!--Mapper代理方式-->
    <package name="com.itheima.mapper"/>
</mappers>

4. MyBatis核心配置文件

MyBatis核心配置文件 mybatis-config.xml中现有的配置之前已经给大家进行了解释，而核心配置文件中还可以配置很多内容。我们可以通过查询官网看可以配置的内容,特别注意：configuration中各个属性像typeAliases和mappers他们的相对顺序是固定的，谁在前和谁在后的位置不可以颠倒，颠倒就会报错。

接下来我们先对里面的一些配置进行讲解。

4.1 多环境配置

在核心配置文件的 environments 标签中其实是可以配置多个 environment （类似可以连接不同的数据库），使用 id 给每段环境起名，在 environments 中使用 default='环境id' 来指定使用哪儿段配置。我们一般就配置一个 environment 即可，开发时default="development"，测试时改为default="test"。

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <!--数据库连接信息-->
            <property name="driver" value="com.mysql.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
            <property name="username" value="root"/>
            <property name="password" value="1234"/>
        </dataSource>
    </environment>

    <environment id="test">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <!--数据库连接信息-->
            <property name="driver" value="com.mysql.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
            <property name="username" value="root"/>
            <property name="password" value="1234"/>
        </dataSource>
    </environment>
</environments>=

4.2 类型别名

在映射配置文件（像UserMapper.xml）中的 resultType 属性需要配置数据封装的类型（类的全限定名）。而每次这样写是特别麻烦的，Mybatis 提供了 类型别名(typeAliases) 可以简化这部分的书写。

首先需要现在核心配置文件中配置类型别名，也就意味着给pojo包下所有的类起了别名（别名就是类名），不区分大小写，类似包扫描。内容如下：

<typeAliases>
    <!--name属性的值是实体类所在包-->
    <package name="com.itheima.pojo"/> 
</typeAliases>

通过上述的配置，我们就可以简化映射配置文件中 resultType 属性值的编写

没有别名:

<mapper namespace="com.itheima.mapper.UserMapper">
    <select id="selectAll" resultType="com.itheima.pojo.User">
        select * from tb_user;
    </select>
</mapper>

有别名：

<mapper namespace="com.itheima.mapper.UserMapper">
    <select id="selectAll" resultType="user">
        select * from tb_user;
    </select>
</mapper>