Mybatis框架——使用案例详细教程

文章目录

- 一、项目创建
- - 1.1 创建 Idea 项目
  - 1.2 导入必要依赖
- 二、数据库配置
- - 2.1 创建数据库
  - 2.2 配置数据库连接信息
- 三、MyBatis 配置
- - 3.1 创建配置文件 mybatis-config.xml
  - 3.2 创建 SqlSessionFactory 实例
- 四、项目测试和运行
- - 4.1 创建实体类
  - 4.2 创建 mapper.xml 文件
  - 4.3 创建 mapper 接口
  - 4.4 配置映射关系
  - 4.5 测试 mapper 接口
- 参考资料

本文源代码地址为 https://github.com/idealzouhu/java-demos/tree/main/spring-boot-mybatis

一、项目创建

1.1 创建 Idea 项目

通过 start.springboot.io 创建工程。选择 MySQL Driver、Spring Web 、Lombock基本依赖，点击 “GENERATE” 下载到本地后，导入到IDEA中。

请添加图片描述

1.2 导入必要依赖

mybatis 的依赖主要有以下两种:

mybatis: 核心框架，适用于任何 Java 应用。
mybatis-spring-boot-starter: 针对 Spring Boot 的简化封装，提供开箱即用的体验。自动配置了 MyBatis 的基本组件，如 SqlSessionFactory 和 MapperScannerConfigurer。

本文选择 mybatis 依赖，具体版本查看 Maven Repository: org.mybatis (mvnrepository.com)

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.3.2</version>
</dependency>

<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
    <scope>runtime</scope>
</dependency>

二、数据库配置

2.1 创建数据库

创建数据库 reggie ，运行项目的 src/main/resources/sql/db_reggie.sql ，导入表结构和数据。

数据库的来源为黑马程序员Java项目实战《瑞吉外卖》bilibili

# 创建数据库
$ CREATE DATABASE `reggie` CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_general_ci';

# 运行sql文件，导入表结构和数据
$ use reggie
$ source D:/spring-boot-redis/src/main/resources/sql/db_reggie.sql

在数据库中，不同表的具体含义如下：

序号	表名	说明
1	employee	员工表
2	category	菜品和套餐分类表
3	dish	菜品表
4	setmeal	套餐表
5	setmeal_dish	套餐菜品关系表
6	dish_flaver	菜品口味关系表
7	user	用户表(C端）
8	address_book	地址薄表
9	shopping_cart	购物车表
10	orders	订单表
11	order_detail	订单明细表

2.2 配置数据库连接信息

数据库的连接配置内容在 mybatis-config.xml 里面设置。

设置内容如下：

<configuration>
    <properties>
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/reggie?useSSL=false&amp;serverTimezone=UTC"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
    </properties>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

三、MyBatis 配置

3.1 创建配置文件 mybatis-config.xml

新建 src/main/resources/mybatis-config.xml，设置数据源和外部的 mapper.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>
    <properties>
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/reggie?useSSL=false&amp;serverTimezone=UTC"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
    </properties>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 注册mapper(映射器)  -->
    <!-- 使用相对于类路径 mybatis-config.xml 的资源引用  -->
    <mappers>
        <mapper resource="mapper/UserMapper.xml"/>
    </mappers>

</configuration>

3.2 创建 SqlSessionFactory 实例

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。具体细节查看入门_MyBatis中文网

@Configuration
public class MyBatisConfig {
    @Bean
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        String resource = "mybatis-config.xml";
        try {
            InputStream inputStream = Resources.getResourceAsStream(resource);
            System.out.println("Resource loaded successfully.");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            return sqlSessionFactory;
        } catch (Exception e) {
            System.err.println("Failed to create SqlSessionFactory: " + e.getMessage());
            throw e;
        }
    }
}

既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。我们可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：

try (SqlSession session = sqlSessionFactory.openSession()) {
    UserMapper mapper = session.getMapper(UserMapper.class);
    List<User> users = mapper.selectAll();
    for (User user : users) {
        System.out.println(user);
    }
}

四、项目测试和运行

在配置数据库和 MyBatis 后，项目步骤为：

创建实体类：定义与数据库表结构相对应的 Java 类，通常包括属性、构造方法、getter 和 setter 方法。
创建映射文件：使用 XML 文件定义数据库操作语句（如查询、插入、更新和删除），并设置结果映射到 Java 对象的规则。
创建映射接口：为每个映射文件创建对应的 Java 接口，定义与映射文件中相同的操作方法。
配置映射关系：在 mybatis-config.xml 文件中，将映射文件和映射接口关联，指定它们的路径和命名空间。=
调用Mapper接口进行查询：使用 SqlSessionFactory 创建一个 SqlSession 实例，然后利用获得的 Mapper 接口实例调用方法执行数据库操作。

4.1 创建实体类

新建文件 com/zouhu/springboot/mybatis/entity/User.java，内容如下：

import lombok.Data;
import java.io.Serializable;

/**
 * 用户信息
 */
@Data
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    private Long id;

    //姓名
    private String name;


    //手机号
    private String phone;


    //性别 0 女 1 男
    private String sex;


    //身份证号
    private String idNumber;


    //头像
    private String avatar;


    //状态 0:禁用，1:正常
    private Integer status;
}

4.2 创建 mapper.xml 文件

为了数据库持久层的实现，需要添加对应的MyBatis框架的XML映射文件，MyBatis的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="">

</mapper>

现在，我们可以创建 User 类对应的文件 com/zouhu/springboot/mybatis/mapper/UserMapper.java，实现查询所有用户的方法 selectAll。具体代码如下：

<?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.zouhu.springboot.mybatis.mapper.UserMapper">
    <select id="selectAll" resultType="com.zouhu.springboot.mybatis.entity.User">
        select * from user
    </select>
</mapper>

4.3 创建 mapper 接口

新建 com/zouhu/springboot/mybatis/mapper/UserMapper.java ，具体内容如下：

import com.zouhu.springboot.mybatis.entity.User;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper
public interface UserMapper {
    List<User> selectAll();
}

4.4 配置映射关系

在 mybatis-config.xml 文件中，使用 <mappers> 标签将映射文件和对应的 Mapper 接口关联，指定映射文件的位置。

  <!-- 注册mapper(映射器)  -->
    <!-- 使用相对于类路径 mybatis-config.xml 的资源引用  -->
    <mappers>
        <mapper resource="mapper/UserMapper.xml"/>
    </mappers>

4.5 测试 mapper 接口

创建测试方法，具体内容如下：

@SpringBootTest
class MyBatisConfigTest {
    @Autowired
    private SqlSessionFactory sqlSessionFactory;

    @Test
    void test() {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            List<User> users = mapper.selectAll();
            for (User user : users) {
                System.out.println(user);
            }
        }
    }
}

测试结果为：

User(id=1, name=张三, phone=13800138000, sex=男, idNumber=null, avatar=null, status=1)
User(id=2, name=李四, phone=13900139000, sex=女, idNumber=null, avatar=null, status=1)
User(id=3, name=王五, phone=13700137000, sex=男, idNumber=null, avatar=null, status=0)
User(id=4, name=赵六, phone=13600136000, sex=女, idNumber=null, avatar=null, status=1)
User(id=5, name=钱七, phone=13500135000, sex=男, idNumber=null, avatar=null, status=0)