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

已于 2024-08-14 20:28:58 修改
阅读量725 收藏 11
点赞数 20
分类专栏： tools 文章标签： mybatis
于 2024-08-14 20:09:15 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44814196/article/details/141199193
版权

文章目录

本文源代码地址为 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

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

序号表名说明
1employee员工表
2category菜品和套餐分类表
3dish菜品表
4setmeal套餐表
5setmeal_dish套餐菜品关系表
6dish_flaver菜品口味关系表
7user用户表(C端）
8address_book地址薄表
9shopping_cart购物车表
10orders订单表
11order_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 后，项目步骤为：

  1. 创建实体类：定义与数据库表结构相对应的 Java 类，通常包括属性、构造方法、getter 和 setter 方法。
  2. 创建映射文件：使用 XML 文件定义数据库操作语句（如查询、插入、更新和删除），并设置结果映射到 Java 对象的规则。
  3. 创建映射接口：为每个映射文件创建对应的 Java 接口，定义与映射文件中相同的操作方法。
  4. 配置映射关系：在 mybatis-config.xml 文件中，将映射文件和映射接口关联，指定它们的路径和命名空间。=
  5. 调用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)

参考资料

Mybatis基本使用教程（小白向）_使用mybatis操作数据库有哪些具体步骤?-CSDN博客

Spring Boot 整合 MyBatis - spring 中文网 (springdoc.cn)

【框架篇】MyBatis starter 介绍及使用（详细教程）_mybatis是干嘛用的怎么用-CSDN博客

idealzouhu
关注
  • 20
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Mybatis框架——入门1（框架的概念，概念，xml实现）
sduihoal的博客
03-13 160
一、预知识 1、什么是框架？ 是软件开发中的一套解决方案，不同的框架解决的是不同的问题。框架封装了很多细节，使开发者使用极简的方式实现功能。大大提高开发效率。 2、三层架构 表现层：展示数据 业务层：处理业务需求 持久层：与数据库交互 3、持久层技术解决方案 JDBC技术：Connection、PrepareStatement、ResultSet Spring的JDBCTemplate：Spring中对JDBC的封装 Apache的DBUtils：对JDBC的简单封装。 但以上都不是框架。其中JDBC是规
Mybatis实例——可直接导入eclipse运行
09-22
Mybatis 是一款流行的Java持久层框架，它实现了SQL映射框架，使得开发者可以直接编写SQL语句，无需关注JDBC的繁琐操作，提高了开发效率。这个实例是为方便开发者在Eclipse环境中快速上手和运行Mybatis而设计的。 在...
框架——MyBatis的入门案例
m0_73671382的博客
03-07 638
MyBatis是一个开源轻量级的数据持久化框架，是JDBC和Hibernate的替代方案。MyBatis 前身为IBatis，2002 年由 Clinton Begin 发布。2010 年从Apache 移到 Google并改名为 MyBatis，2013 年又迁移到了Github。mybatis是一个优秀的基于java的持久层框架，它内部封装了jdbc，使开发者只需要关注sql 语句本身，而不需要花费精力去处理加载驱动、创建连接、创建statement 等繁杂的过程。
（1）Mybatis————如何自定义一个Mybatis框架
qq_2533491534的博客
06-19 310
1，MyBatis简介 1.1，MyBatis历史 1.2，为什么要使用MyBatis？ 1.3，MyBatis入门案例 1.4，基于注解的 mybatis 2，自定义一个Mybatis框架 2.1，流程分析图 2.2，环境搭建步骤 2.3，示例代码 MyBatis简介 MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架 MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集 MyBatis可以使用简单的XML或注解用于配置和原始映射，
Mybatis框架——搭建流程
Cool.R的博客
09-10 481
Mybatis框架 构建过程
Mybatis框架——动态sql语句
qq_45838562的博客
07-23 160
Mybatis框架——动态sql语句 mybatis的一个强大的特性之一通常是它的动态sql能力，提供了OGNL表达式动态生成sql的功能。 动态sql有： 1.if 场景：查询男性用户，如果输入姓名，按照姓名查询 方法的形式参数没有封装到对象中如何解决： ①如果参数没有封装到POJO中，例如：selectUserListBySexAndName(String sex,String username);，在mybatis中，可以使用#{param1} #{param2}去使用该传递的参数，但是建议使用对象
ORM框架系列——Mybatis1——概述，半自动的ORM
做一个善良的人，做好自己的事，如果愿意，再发一份光。
06-09 589
🔥本篇概览：半自动ORM框架mybatis的概述，介绍ORM。🌈⭕🔥
ORM框架系列——Mybatis3——快速上门完整流程
做一个善良的人，做好自己的事，如果愿意，再发一份光。
06-09 1144
🔥本篇概览：详细讲解了Mybatis的快速上门完整流程。🌈⭕🔥
ORM框架系列——Mybatis0——JDBC
做一个善良的人，做好自己的事，如果愿意，再发一份光。
06-09 625
🔥本篇概览：详细讲解了JAVA中用于执行SQL语句的API集——JDBC，为之后的mybatis学习奠基。🌈⭕🔥
MyBatis——源码解析MyBatis框架底层的执行原理
★★光亭★★
06-18 6269
mybatis底层执行原理（源码解析）
mybatis——mybatis框架的介绍
m0_72216019的博客
10-21 52
框架、框架解决的问题 、mybatis框架介绍
SSM框架——详细整合教程（Spring+SpringMVC+MyBatis）.zip
07-03
本次为您带来的是最新的 Java 框架零基础从入门到精通的教程笔记项目，无论您是完全没有基础的小白，还是想要进一步提升的开发者，这套教程都将是您的理想之选。 教程内容丰富详实，涵盖了从基础知识的细致讲解，到...
SSM框架——详细整合教程.pdf
06-12
SSM框架，全称为Spring、SpringMVC和MyBatis的整合框架，是Java开发中常用的Web应用程序开发架构。SSM框架的整合旨在提供一种高效、灵活且易于维护的开发方式，尤其适用于大型的企业级应用。 1. **Spring框架**： ...
项目管理与SSM框架——Maven学习与案例练习
03-29
【Maven学习与案例练习】 Maven是一个强大的项目管理工具，尤其在Java开发领域中广泛使用，它简化了项目的构建、依赖管理...对于学习SSM框架（Spring, Struts, MyBatis）的开发者来说，掌握Maven更是必不可少的技能。
web框架PPT——Struts 2+Hibernate+MyBatis+Spring 网站开发案例课堂 书籍附带PPT课件
02-01
在现代的Web应用程序开发中，Java Web框架的组合使用已经成为了一种常见的模式，特别是Struts 2、Hibernate、MyBatis和Spring这四个组件的整合，它们分别在MVC架构的不同层面发挥着关键作用。本课程围绕这个组合展开...
Python 操作 MySQL 数据库.pdf
最新发布
08-13
Python 操作 MySQL 数据库.pdf
安装包单片机开发.zip
08-13
安装包
信息安全简单介绍.pdf
08-13
信息安全简单介绍.pdf
简历-求职简历-word-文件-简历模版免费分享-应届生-高颜值简历模版-个人简历模版-简约大气-大学生在校生-求职-实习
08-13
python简历-求职简历-word-文件-简历模版免费分享-应届生-高颜值简历模版-个人简历模版-简约大气-大学生在校生-求职-实习 简历是展示个人经历、技能和能力的重要文档，以下是一个常见的简历格式和内容模板，供您参考： 简历格式： 头部信息：包括姓名、联系方式（电话号码、电子邮件等）、地址等个人基本信息。 求职目标（可选）：简短描述您的求职意向和目标。 教育背景：列出您的教育经历，包括学校名称、所学专业、就读时间等。 工作经验：按时间顺序列出您的工作经历，包括公司名称、职位、工作时间、工作职责和成就等。 技能和能力：列出您的专业技能、语言能力、计算机技能等与职位相关的能力。 实习经验/项目经验（可选）：如果您有相关实习或项目经验，可以列出相关信息。 获奖和荣誉（可选）：列出您在学术、工作或其他领域获得的奖项和荣誉。 自我评价（可选）：简要描述您的个人特点、能力和职业目标。 兴趣爱好（可选）：列出您的兴趣爱好，展示您的多样性和个人素质。 参考人（可选）：如果您有可提供推荐的人员，可以在简历中提供其联系信息。 简历内容模板： 姓名: 联系方式: 地址: 求职目标: （简短描
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值