Mybatis 初识

玖汐」

已于 2023-08-12 14:17:45 修改

阅读量511

点赞数 1

分类专栏： JavaEE 文章标签： java mybatis spring boot 后端数据库 spring intellij-idea

于 2023-08-12 14:16:08 首次发布

本文链接：https://blog.csdn.net/yezh1yong_cr/article/details/132248343

版权

JavaEE 专栏收录该内容

19 篇文章 0 订阅

订阅专栏

MyBatis xml保存路径和xml命名规范

2.2 MyBatis 业务代码 (以查询为例)

2.2.5 控制器层 Controller

2.2.6 程序测试

浏览器测试

Postman 测试

1. MyBatis入门

1.1 MyBatis的定义

MyBatis 是一款优秀的 持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 去除了几乎所有的JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的XML 或注解来配置和映射原始类型、接口和 Java POJO (Plain Old Java Obiects，普通老式 Java 对象)为数据库中的记录。

简单来说 MyBatis 是更简单完成程序和数据库交互的工具，也就是更简单的操作和读取数据库工具。

MyBatis官网

持久化: 将内存中的数据长久的保存到磁盘中.
MyBatis是半自动化的框架: 要实现一个业务, 所有SQL需要自己实现.
存储过程: 将多个SQL语句连成一个方法.
高级映射: 将数据库中的多个表映射到一个对象中.

1.2 MyBatis的核心

对于后端开发来说，程序是由以下两个重要的部分组成的:

后端程序
数据库

而这两个重要的组成部分要通讯，就要依靠数据库连接工具MyBatis(之前则使用JDBC) 那么MyBatis是为了简化JDBC操作而诞生的.

MyBatis的核心

MyBatis的核心分为两部分

配置MyBatis 开发环境;
使用MyBatis 模式和语法操作数据库.

JDBC 的操作回顾

创建数据库连接池 DataSource
通过 DataSource 获取数据库连接 Connection
编写要执行带?占位符的 SQL 语句
通过 Connection 及 SQL 创建操作命令对象 Statement
替换占位符: 指定要替换的数据库字段类型，占位符索引及要替换的值
使用 Statement 执行 SQL 语句
查询操作: 返回结果集 ResultSet，更新操作:返回更新的数量
处理结果集
释放资源

下面的一个完整案例，展示了通过 JDBC 的 API 向数据库中添加一条记录，修改一条记录，查询一条记录的操作。

-- 创建数据库
create database if not exists `library` default character set utf8mb4;
-- 使用数据库
use library;
-- 创建表
create table if not exists `soft_bookrack` (
    `book_name` varchar(32) NOT NULL,
    `book_author` varchar(32) NOT NULL,
    `book_isbn` varchar(32) NOT NULL primary key
);

以下是 JDBC 操作的具体实现代码:

package com.example.demo;

import lombok.Getter;
import lombok.Setter;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

public class SimpleJdbcOperation {
    private final DataSource dataSource;

    public SimpleJdbcOperation(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    /**
     * 添加一本书
     */
    public void addBook() {
        Connection connection = null;
        PreparedStatement stmt = null;
        try {
            //获取数据库连接
            connection = dataSource.getConnection();
            //创建语句
            stmt = connection.prepareStatement(
                    "insert into soft_bookrack (book_name, book_author, book_isbn) values( ?,?,?);");
            //参数绑定
            stmt.setString(1, "Spring in Action");
            stmt.setString(2, "Craig Walls");
            stmt.setString(3, "9787115417305");
            //执行语句
            stmt.execute();
        } catch (SQLException e) {
            //处理异常信息
        } finally {
            //清理资源
            try {
                if (stmt != null) {
                    stmt.close();
                }
                if (connection != null) {
                    connection.close();
                }
            } catch (SQLException e) {
                //
            }
        }
    }

    /**
     * 更新一 本书
     */
    public void updateBook() {
        Connection connection = null;
        PreparedStatement stmt = null;
        try {
            //获取数据库连接
            connection = dataSource.getConnection();
            //创建语句
            stmt = connection.prepareStatement("update soft_bookrack set book_author=? where book_isbn=?;");
            //参数绑定
            stmt.setString(1, "张卫滨");
            stmt.setString(2, "9787115417305");
            //执行语句
            stmt.execute();
        } catch (SQLException e) {
            //处理异常信息
        } finally {
            //清理资源
            try {
                if (stmt != null) {
                    stmt.close();
                }
                if (connection != null) {
                    connection.close();
                }
            } catch (SQLException e) {
                //
            }
        }
    }

    /**
     * 查询一本书
     */
    public void queryBook() {
        Connection connection = null;
        PreparedStatement stmt = null;
        ResultSet rs = null;
        Book book = null;
        try {
            //获取数据库连接
            connection = dataSource.getConnection();
            //创建语句
            stmt = connection.prepareStatement("select book_name, book_author, book_isbn from soft_bookrack where book_isbn =?");
            //参数绑定
            stmt.setString(1, "9787115417305");
            //执行 语句
            rs = stmt.executeQuery();
            if (rs.next()) {
                book = new Book();
                book.setName(rs.getString("book_name"));
                book.setAuthor(rs.getString("book_author"));
                book.setIsbn(rs.getString("book_isbn"));
            }
            System.out.println(book);
        } catch (SQLException e) {
            //处理异常信息
        } finally {
            //清理资源
            try {
                if (rs != null) {
                    rs.close();
                }
                if (stmt != null) {
                    stmt.close();
                }
                if (connection != null) {
                    connection.close();
                }
            } catch (SQLException e) {
                //
            }
        }
    }

    @Setter
    @Getter
    public static class Book {
        private String name;
        private String author;
        private String isbn;
    }
}

从上述代码和操作流程可以看出，对于JDBC 来说，整个操作非常的繁琐，我们不但要拼接每一个参数，而且还要按照模板代码的方式，一步步的操作数据库，并且在每次操作完，还要手动关闭连接等而所有的这些操作步骤都需要在每个方法中重复书写。所以为了简化数据库的操作, 就有了MyBatis.

1.3 MyBatis的执行流程

上图描述了一个程序执行的标准流程, 那么其中的Mapper就是MyBatis的所在.
MyBatis包括Interface和.xml(实现接口), 那么Interface是方法的声明(接口), 但是没有方法的实现; 而方法的实现就在.xml中实现(SQL写在这里面). 但是在调用的时候调用的是Interface.
那么程序员操作的就是这两个组件, 这两个组件的操作也是基于JDBC的, 也就是说MyBatis是基于JDBC, 即 JDBC是给数据库上面封装了一层操作, 而MyBatis则是在JDBC基础上再加了一层, 能够更加的方便易用.

MyBatis基本工作原理

MyBatis 也是一个 ORM 框架，ORM(Object RelationalMapping)，即对象关系映射。在面向对象编程语言中，将关系型数据库中的数据与对象建立起映射关系，进而自动的完成数据与对象的互相转换:

将输入数据 (即传入对象) +SQL 映射成原生 SQL
将结果集映射为返回对象，即输出对象

ORM 把数据库映射为对象:

数据库表 (table) --> 类 (class)
记录 (record，行数据)--> 对象 (object)
字段 (field) --> 对象的属性 (attribute)

一般的 ORM 框架，会将数据库模型的每张表都映射为一个 Java 类。也就是说使用 MyBatis可以像操作对象一样来操作数据库中的表，可以实现对象和数据库表之间的转换。

2. MyBatis的使用

2.1 MyBatis环境搭建

2.1.1 创建数据库和表

首先我们要实现的功能是: 使用 MyBatis 的方式来读取用户表中的所有用户，我们使用个人博客的数据库和数据包，具体 SQL 如下。

-- 创建数据库
drop database if exists mycnblog;
create database mycnblog DEFAULT CHARACTER SET utf8mb4;

-- 使用数据数据
use mycnblog;

-- 创建表[用户表]
drop table if exists  userinfo;
create table userinfo(
    id int primary key auto_increment,
    username varchar(100) not null,
    password varchar(32) not null,
    photo varchar(500) default '',
    createtime timestamp default current_timestamp,
    updatetime timestamp default current_timestamp,
    `state` int default 1
) default charset 'utf8mb4';

-- 创建文章表
drop table if exists  articleinfo;
create table articleinfo(
    id int primary key auto_increment,
    title varchar(100) not null,
    content text not null,
    createtime timestamp default current_timestamp,
    updatetime timestamp default current_timestamp,
    uid int not null,
    rcount int not null default 1,
    `state` int default 1
)default charset 'utf8mb4';

-- 创建视频表
drop table if exists videoinfo;
create table videoinfo(
      vid int primary key,
      `title` varchar(250),
      `url` varchar(1000),
        createtime timestamp default current_timestamp,
        updatetime timestamp default current_timestamp,
      uid int
)default charset 'utf8mb4';

-- 添加一个用户信息
INSERT INTO `mycnblog`.`userinfo` (`id`, `username`, `password`, `photo`, `createtime`, `updatetime`, `state`) VALUES 
(1, 'admin', 'admin', '', '2021-12-06 17:10:48', '2021-12-06 17:10:48', 1);

-- 文章添加测试数据
insert into articleinfo(title,content,uid)
    values('Java','Java正文',1);
    
-- 添加视频
insert into videoinfo(vid,title,url,uid) values(1,'java title','http://www.baidu.com',1);

2.1.2 添加MyBatis框架支持

添加 MyBatis 框架支持分为两种情况:一种情况是对自己之前的 Spring 项目进行升级，另一种情况是创建一个全新的 MyBatis 和 Spring Boot 的项目，下面我们分别来演示这两种情况的具体实现。

老项目添加MyBatis

如果是在老项目中新增功能，添加框架支持:

在pom.xml下的<dependencies>标签内部Alt+Insert, 并点击Edit Starters(安装好这个插件),

点击OK, 即可在窗口中添加相关框架.

新项目添加MyBatis

如果是新项目创建Spring Boot 项目的时候添加引用就可以了，如下图所示:

注意: 添加MyBatis框架支持之后直接运行是会报错的, 所以要再设置MyBatis配置信息.

2.1.3 设置MyBatis配置信息

在application.properties配置文件中配置MyBatis相关信息. (也可以用yml, 这里省略)

设置数据库连接的相关信息

# 数据库连接配置
spring.datasource.url=jdbc:mysql://localhost:3306/mycnblog?characterEncoding=utf8&useSSL=false
spring.datasource.username=root
# 注意! password 要写自己本机 mysql 的密码, 不是此处固定的111111
spring.datasource.password=111111
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

MyBatis xml保存路径和xml命名规范

# 设置 MyBatis
mybatis.mapper-locations=classpath:/mybatis/*Mapper.xml

下图为用户表的Mapper.xml, 即UserMapper.xml

2.2 MyBatis 业务代码 (以查询为例)

2.2.1 MyBatis的开发模式

配置完MyBatis的开发环境之后, 就要按照MyBatis的模式来开发我们的业务代码.

上图描述了MyBatis的开发模式, 针对于MyBatis来说, 它只有Interface和XXX.xml两个文件, Interface是给其他人调用的, 这个就是Java中普通的Interface接口, 然后通过注入的方式将这个接口注入上去, 那么问题是这个接口没有方法实现的, 前文提到, MyBatis在实现业务的时候是需要我们自己来写SQL代码的, 那么SQL就会写在XXX.xml中.
也就是说, 每一个功能都会对应两个组件, 一个是Interface给我们的服务层调用, 然后是针对Interface的代码实现.
那么在Java中只有普通的类可以实现接口, 重写接口的方法, 那xml怎么能够实现Interface中的方法?
这就是MyBatis的厉害之处, MyBatis通过代理的方式实现Interface中的方法, 也就是说, 对于我们用户来说, 我们感知的是Interface和XXX.xml, 到了MyBatis中运行时就会生成一个代理对象, 然后这个代理对象会将Interface里面的方法声明和XXX.xml里面的方法实现给它们组合成一个代理对象的方法进行填充.
也就是说在其他层去调用MyBatis, 其实就是调用那个代理对象了, 那么代理对象就是一个普通类了. 那么普通类中就自然而然有方法, 有方法的实现.
所以说, 我们看到的虽然是这两个组件, 但是最终实现的时候, MyBatis框架会帮我们封装好进行操作.

MyBatis模式开发由两部分组成:

Interface: 让其他层可以注入使用的接口
MyBatis: xml -> 具体实现SQL【它是上面Interface的"实现"】

明确了MyBatis中的构成之后我们才能够去合理的写它的代码, 由UserMapper.xml的图可知, xml的命名格式必须得是*Mapper.xml, 并且必须得放在/mybatis文件夹下. (注意: 配置了什么路径就得将xml放在什么文件夹下, 文件夹名要和路径相同)

2.2.2 添加实体类

先添加用户的实体类, 注意属性名和字段名尽量和SQL中的表一致, 这样MyBatis就会自动实现映射和关联(如果名字不一样就不会关联了):

package com.example.demo.entity;

import lombok.Data;

import java.time.LocalDateTime;

@Data
public class UserEntity {
    private Integer id;
    private String username;
    private String password;
    private String photo;
    private LocalDateTime createtime;
    private LocalDateTime updatetime;
    private Integer state;
}

2.2.3 数据持久层实现

Interface

以用户的查询功能为例, 在mapper下建立UserMapper, 注意这个类不需要有实现, 因为SQL是写在xml中, 它只需要有方法的声明让别人去调用即可.

package com.example.demo.mapper;

import com.example.demo.entity.UserEntity;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper // 注意添加此注解
public interface UserMapper {
    List<UserEntity> getAll();
}

注意, 创建这个Interface之后的第一件事情就是加@Mapper注解, 因为这不是一个普通的类, 这个类是MyBatis的一个接口, 这个接口是需要和xml去对应起来的, 所以要把这个对象托管给MyBatis, 即加@Mapper注解.

以上就是第一个Interface的实现, 接下来就要实现*Mapper.xml, 它需要在resources.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="com.example.demo.mapper.UserMapper">
   
</mapper>

添加 UserMapper.xmlUserMapper.xml 查询所有用户的具体实现 SQL:

<?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.example.demo.mapper.UserMapper">
    <select id="getAll" resultType="com.example.demo.entity.UserEntity">
        select * from userinfo
    </select>
</mapper>

以下是对以上标签的说明

<mapper>标签: namespace属性是指定当前xml实现的类是哪个Interface接口. 值为"包名.类名"
<select>查询标签: 是用来执行数据库的查询操作的:
- id: 是和Interface(接口) 中定义的方法名称一样的，表示对接口的具体实现方法。
- resultType: 是返回的数据类型，也就是开头我们定义的实体类。

2.2.4 服务层Service

添加 Service服务层, 实现代码如下:

package com.example.demo.service;

import com.example.demo.entity.UserEntity;
import com.example.demo.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {
    @Autowired
    private UserMapper userMapper;

    public List<UserEntity> getAll(){
        return userMapper.getAll();
    }
}

2.2.5 控制器层 Controller

控制器层的实现代码如下:

package com.example.demo.controller;

import com.example.demo.entity.UserEntity;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RequestMapping("/user")
@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping("/getall")
    public List<UserEntity> getAll(){
        return userService.getAll();
    }
}

2.2.6 程序测试

浏览器测试

以上代码写完，整个 MyBatis 的查询功能就实现完了，接下来我们启动项目, 先使用浏览器输入路径的方式测试一下.

可以看到已经成功实现了查询功能, 查到了admin. 那么我们可以往数据库中再添加一条数据, 就可以查到第二条数据.

INSERT INTO `mycnblog`.`userinfo` (`id`, `username`, `password`, `photo`, `createtime`, `updatetime`, `state`) VALUES 
(2, 'zhangsan', 'zhangsan', '', '2021-12-06 17:10:48', '2021-12-06 17:10:48', 1);

插入第二条数据之后刷新页面, 可以看到数据成功的插入到数据库中了.