MyBatis 学习总结

cyt涛

于 2024-09-30 15:00:00 发布

阅读量681

点赞数 7

分类专栏： java 文章标签： mybatis 学习数据库 mysql sql JDBC lombok

本文链接：https://blog.csdn.net/qq_46637011/article/details/142533974

版权

java 专栏收录该内容

69 篇文章 0 订阅

订阅专栏

1. MyBatis 简介

MyBatis 是一款优秀的持久层框架，简化了 Java 程序与数据库的交互，通过 SQL 映射将 SQL 语句与 Java 对象关联起来。它基于传统 JDBC 的操作进行了封装，使得开发者无需手动编写复杂的 SQL 操作代码。

MyBatis 的特点包括：

SQL 映射：通过 XML 或注解直接编写 SQL，灵活性高。
简化 JDBC：自动处理连接管理和结果集映射。
支持动态 SQL：通过 XML 配置文件或注解实现动态查询。

2. MyBatis 入门

2.1 MyBatis 的基本使用步骤

MyBatis 的使用流程通常包括以下几个步骤：

（1）配置 MyBatis 环境：配置数据库连接信息，导入 mybatis-spring-boot-starter 和 mysql-connector 等依赖。

（2）创建数据库表与实体类：通过表与实体类映射数据库中的记录到 Java 对象。

（3）编写 Mapper 接口：使用注解或 XML 映射 SQL 语句到接口方法。

（4）测试：通过单元测试验证数据库操作。

示例：

（1）创建表 user：

CREATE TABLE user (
    id INT UNSIGNED PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(100),
    age TINYINT UNSIGNED,
    gender TINYINT UNSIGNED,
    phone VARCHAR(11)
);

（2）创建对应的实体类 User

实体类的属性名与表中的字段名一一对应。

@Data
public class User {
    private Integer id;
    private String name;
    private Short age;
    private Short gender;
    private String phone;
}

（3）编写 Mapper 接口 UserMapper

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    List<User> listAllUsers();
}

@Mapper注解：表示是mybatis中的Mapper接口

程序运行时：框架会自动生成接口的实现类对象(代理对象)，并给交Spring的IOC容器管理

@Select注解：代表的就是select查询，用于书写select查询语句

2.2 数据库连接配置

可以在 Spring Boot 中，使用 application.properties 配置数据库连接信息：

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis
spring.datasource.username=root
spring.datasource.password=1234

3. 解决SQL警告与提示

默认我们在UserMapper接口上的@Select注解中编写SQL语句是没有提示的。如果想让idea给出提示，可以做如下配置：

配置完成之后，发现SQL语句中的关键字有提示了，但还存在不识别表名(列名)的情况：

解决方案：在Idea中配置MySQL数据库连接

在配置的时候指定连接那个数据库，如上图所示连接的就是mybatis数据库。

4. MyBatis 基础操作

MyBatis 通过 @Insert、@Delete、@Update 和 @Select 注解实现数据库的增删改查操作。也可以使用 XML 文件来编写 SQL 语句。

4.1 查询操作：

@Select("SELECT * FROM emp WHERE id=#{id}")
Emp getEmpById(Integer id);

4.1.1 注意事项

实体类属性名和数据库表查询返回的字段名一致，mybatis会自动封装。

如果实体类属性名和数据库表查询返回的字段名不一致，不能自动封装。

4.1.2 解决方案

（1）起别名

在SQL语句中，对不一样的列名起别名，别名和实体类属性名一样。

（2）结果映射

通过 @Results及@Result 进行手动结果映射。

@Results({@Result(column = "dept_id", property = "deptId"),
@Result(column = "create_time", property = "createTime"),
@Result(column = "update_time", property = "updateTime")})
@Select("select id, username, password, name, gender, image, job,
entrydate, dept_id, create_time, update_time from emp where id=#{id}")
public Emp getById(Integer id);

（3）开启驼峰命名(推荐)

如果字段名与属性名符合驼峰命名规则，mybatis会自动通过驼峰命名规则映射

# 在application.properties中添加：
mybatis.configuration.map-underscore-to-camel-case=true

4.1.3 模糊查询

姓名：要求支持模糊匹配

sql:

select id, username, password, name, gender, image, job, entrydate,
dept_id, create_time, update_time
from emp
where name like '%张%'

java:

@Mapper
public interface EmpMapper {
@Select("select * from emp " +
"where name like '%${name}%' " 
public List<Emp> list(String name, Short gender, LocalDate begin,
LocalDate end);
}

模糊查询使用${...}进行字符串拼接，这种方式呢，由于是字符串拼接，并不是预编译的形式，所以效率不高、且存在sql注入风险。

解决方案：

使用MySQL提供的字符串拼接函数：concat('%' , '关键字' , '%')

@Mapper
public interface EmpMapper {
@Select("select * from emp " +
"where name like concat('%',#{name},'%') " 
public List<Emp> list(String name, Short gender, LocalDate
begin, LocalDate end);
}

4.2 新增操作

4.2.1 基本新增

@Insert("INSERT INTO emp(username, name, gender) VALUES (#{username}, #{name}, #{gender})")
void insertEmp(Emp emp);

4.2.2 主键返回

在数据添加成功后，需要获取插入数据库数据的主键。

默认情况下，执行插入操作时，是不会主键值返回的。如果我们想要拿到主键值，需要在Mapper 接口中的方法上添加一个Options注解，并在注解中指定属性useGeneratedKeys=true和 keyProperty="实体类属性名"

@Mapper
public interface EmpMapper {
//会自动将生成的主键值，赋值给emp对象的id属性
@Options(useGeneratedKeys = true,keyProperty = "id")
@Insert("insert into emp(username, name, gender, image, job,
entrydate, dept_id, create_time, update_time) values (#{username}, #
{name}, #{gender}, #{image}, #{job}, #{entrydate}, #{deptId}, #
{createTime}, #{updateTime})")
public void insert(Emp emp);
}

4.3 删除操作

@Delete("DELETE FROM emp WHERE id=#{id}")
void deleteEmp(Integer id);

4.4 更新操作

@Update("UPDATE emp SET name=#{name}, gender=#{gender} WHERE id=#{id}")
void updateEmp(Emp emp);

4.5 日志输入

在Mybatis当中我们可以借助日志，查看到sql语句的执行、执行传递的参数以及执行结果。具体操作如下：

1. 打开application.properties文件

2. 开启mybatis的日志，并指定输出到控制台

#指定mybatis输出日志的位置, 输出控制台
mybatis.configuration.log-
impl=org.apache.ibatis.logging.stdout.StdOutImpl

4.6 预编译SQL

4.6.1 介绍

预编译SQL有两个优势：

（1）性能更高

（2）更安全(防止SQL注入)

性能更高：预编译SQL，编译一次之后会将编译后的SQL语句缓存起来，后面再次执行这条语句时，不会再次编译。（只是输入的参数不同）

更安全(防止SQL注入)：将敏感字进行转义，保障SQL的安全性。

4.6.2 SQL注入

SQL注入：是通过操作输入的数据来修改事先定义好的SQL语句，以达到执行代码对服务器进行攻击的方法。

由于没有对用户输入进行充分检查，而SQL又是拼接而成，在用户输入参数时，在参数中添加一些 SQL关键字，达到改变SQL运行结果的目的，也可以完成恶意攻击。

用户在页面提交数据的时候人为的添加一些特殊字符，使得sql语句的结构发生了变化，最终可以在没有用户名或者密码的情况下进行登录。

4.6.3 参数占位符

在Mybatis中提供的参数占位符有两种：${...} 、#{...}

（2）#{...}

执行SQL时，会将#{…}替换为?，生成预编译SQL，会自动设置参数值

使用时机：参数传递，都使用#{…}

（2）${...}

拼接SQL。直接将参数拼接在SQL语句中，存在SQL注入问题

使用时机：如果对表名、列表进行动态设置时使用

注意事项：在项目开发中，建议使用 #{...} ，生成预编译 SQL ，防止 SQL 注入安全。

5. MyBatis XML 配置

Mybatis的开发有两种方式：

（1）注解（2）XML

使用Mybatis的注解方式，主要是来完成一些简单的增删改查功能。如果需要实现复杂的SQL功能，建议使用XML来配置映射语句，也就是将SQL语句写在XML配置文件中。

在Mybatis中使用XML映射文件方式开发，需要符合一定的规范：

（1） XML映射文件的名称与Mapper接口名称一致，并且将XML映射文件和Mapper接口放置在相同包下（同包同名）

（2）XML映射文件的namespace属性为Mapper接口全限定名一致

（3）XML映射文件中sql语句的id与Mapper接口中的方法名一致，并保持返回类型一致。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mapper.EmpMapper">
    <select id="getById" resultType="Emp">
        SELECT * FROM emp WHERE id=#{id}
    </select>
</mapper>

xml映射文件中的dtd约束，直接从mybatis官网复制即可

<select>标签：就是用于编写select查询语句的。

resultType属性，指的是查询返回的单条记录所封装的类型。

MybatisX的使用：

MybatisX是一款基于IDEA的快速开发Mybatis的插件，为效率而生。可以通过MybatisX快速定位

6. MyBatis 动态 SQL

动态 SQL 是指根据输入条件动态生成 SQL 语句，适用于复杂的查询逻辑。MyBatis 提供了 <if>、<choose>、<where>、<set> 等标签来构建动态 SQL。

传递了参数，再组装这个查询条件；如果没有传递参数，就不应该组装这个查询条件。SQL语句会随着用户的输入或外部条件的变化而变化，我们称为：动态SQL。

6.1 动态SQL-if

<if> ：用于判断条件是否成立。使用test属性进行条件判断，如果条件为true，则拼接SQL。

6.1.1 条件查询

<select id="list" resultType="Emp">
    SELECT * FROM emp
    <where>
        <if test="name != null">
            AND name LIKE concat('%', #{name}, '%')
        </if>
        <if test="gender != null">
            AND gender = #{gender}
        </if>
    </where>
</select>

组装条件时，可能会多出and关键字。

以上问题的解决方案：使用 <where> 标签代替SQL语句中的where关键字

<where> 只会在子元素有内容的情况下才插入where子句，而且会自动去除子句的开头的AND或 OR。

6.1.2 动态更新

使用 <set> 标签处理更新语句中动态字段。

<!--更新操作-->
<update id="update">
 update emp
 set
<if test="username != null">
 username=#{username},
</if>
<if test="name != null">
 name=#{name},
</if>
<if test="gender != null">
 gender=#{gender},
</if>
<if test="image != null">
 image=#{image},
</if>
<if test="job != null">
 job=#{job},
</if>
<if test="entrydate != null">
 entrydate=#{entrydate},
</if>
<if test="deptId != null">
 dept_id=#{deptId},
</if>
<if test="updateTime != null">
 update_time=#{updateTime}
</if>
 where id=#{id}
</update>

组装条件时，可能会多出逗号。

以上问题的解决方案：使用 <set> 标签代替SQL语句中的set关键字

<set> ：动态的在SQL语句中插入set关键字，并会删掉额外的逗号。（用于update语句中）

6.1.3 批量删除

使用 <foreach> 实现批量操作。

<foreach collection="集合名称" item="集合遍历出来的元素/项" separator="每
一次遍历使用的分隔符"
open="遍历开始前拼接的片段" close="遍历结束后拼接的片段">
</foreach>

<delete id="deleteByIds">
    DELETE FROM emp WHERE id IN
    <foreach collection="ids" item="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</delete>

6.1.4 SQL重用

<sql id="commonSelect">
 select id, username, password, name, gender, image, job,
entrydate, dept_id, create_time, update_time from emp
</sql>

在xml映射文件中配置的SQL，有时可能会存在很多重复的片段，此时就会存在很多冗余的代码。

我们可以对重复的代码片段进行抽取，将其通过 <sql> 标签封装到一个SQL片段，然后再通过 <include> 标签进行引用。

（1）<sql> ：定义可重用的SQL片段

（2）<include> ：通过属性refid，指定包含的SQL片段

<sql id="commonSelect">
 select id, username, password, name, gender, image, job,
entrydate, dept_id, create_time, update_time from emp
</sql>

然后通过 <include> 标签在原来抽取的地方进行引用

<select id="list" resultType="com.itheima.pojo.Emp">
<include refid="commonSelect"/>
<where>
<if test="name != null">
 name like concat('%',#{name},'%')
</if>
<if test="gender != null">
 and gender = #{gender}
</if>
<if test="begin != null and end != null">
 and entrydate between #{begin} and #{end}
</if>
</where>
 order by update_time desc
</select>

7. JDBC简介

7.1 介绍

java语言操作数据库，只能通过一种方式：使用sun公司提供的 JDBC 规范。Mybatis框架，就是对原始的JDBC程序的封装。

JDBC： ( Java DataBase Connectivity )，就是使用Java语言操作关系型数据库的一套API。

本质：

sun公司官方定义的一套操作所有关系型数据库的规范，即接口。

各个数据库厂商去实现这套接口，提供数据库驱动jar包。

我们可以使用这套接口(JDBC)编程，真正执行的代码是驱动jar包中的实现类。

7.2 JDBC操作数据库的步骤

1. 注册驱动

2. 获取连接对象

3. 执行SQL语句，返回执行结果

4. 处理执行结果

5. 释放资源

基于JDBC程序来操作数据库，代码实现非常繁琐，所以在项目开发中，我们很少使用。在项目开发中，通常会使用Mybatis这类的高级技术来操作数据库，从而简化数据库操作、提高开发效率。

7.3 问题分析

原始的JDBC程序，存在以下几点问题：

1. 数据库链接的四要素(驱动、链接、用户名、密码)全部硬编码在java代码中

2. 查询结果的解析及封装非常繁琐

3. 每一次查询数据库都需要获取连接,操作完毕后释放连接, 资源浪费, 性能降低

7.4 mybatis技术

分析了JDBC的缺点之后，再来看一下在mybatis中，是如何解决这些问题的：

1. 数据库连接四要素(驱动、链接、用户名、密码)，都配置在springboot默认的配置文件 application.properties中

2. 查询结果的解析及封装，由mybatis自动完成映射封装，我们无需关注

3. 在mybatis中使用了数据库连接池技术，从而避免了频繁的创建连接、销毁连接而带来的资源浪费。

7.5 数据库连接池

7.5.1 介绍

mybatis中，使用了数据库连接池技术，避免频繁的创建连接、销毁连接而带来的资源浪费。

没有使用数据库连接池：

客户端执行SQL语句：要先创建一个新的连接对象，然后执行SQL语句，SQL语句执行后又需要关闭连接对象从而释放资源，每次执行SQL时都需要创建连接、销毁链接，这种频繁的重复创建销毁的过程是比较耗费计算机的性能。

数据库连接池：

1、数据库连接池是个容器，负责分配、管理数据库连接(Connection)

（1）程序在启动时，会在数据库连接池(容器)中，创建一定数量的Connection对象，允许应用程序重复使用一个现有的数据库连接，而不是再重新建立一个

（2）客户端在执行SQL时，先从连接池中获取一个Connection对象，然后在执行SQL语句，SQL语句执行完之后，释放Connection时就会把Connection对象归还给连接池（Connection对象可以复用）

2、释放空闲时间超过最大空闲时间的连接，来避免因为没有释放连接而引起的数据库连接遗漏

（1）客户端获取到Connection对象了，但是Connection对象并没有去访问数据库(处于空闲)，数据库连接池发现Connection对象的空闲时间 > 连接池中预设的最大空闲时间，此时数据库连接池就会自动释放掉这个连接对象

数据库连接池的好处：

1. 资源重用

2. 提升系统响应速度

3. 避免数据库连接遗漏

7.5.2 产品

官方(sun)提供了数据库连接池标准（javax.sql.DataSource接口），第三方组织必须按照DataSource接口实现。

常见的数据库连接池： C3P0 、DBCP 、Druid 、Hikari (springboot默认)

现在使用更多的是：Hikari、Druid （性能更优越）

如果想把默认的数据库连接池切换为Druid数据库连接池，只需要完成以下两步操作即可：

参考官方地址：https://github.com/alibaba/druid/tree/master/druid-spring-boot-starter

1. 在pom.xml文件中引入依赖

<dependency>
<!-- Druid连接池依赖 -->
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.2.8</version>
</dependency>

2. 在application.properties中引入数据库连接配置

方式一：

spring.datasource.druid.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.druid.url=jdbc:mysql://localhost:3306/mybatis
spring.datasource.druid.username=root
spring.datasource.druid.password=1234

方式二：

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis
spring.datasource.username=root
spring.datasource.password=1234

8. lombok

8.1 介绍

Lombok是一个实用的Java类库，可以通过简单的注解来简化和消除一些必须有但显得很臃肿的Java代码。

通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，并可以自动化生成日志变量，简化java开发、提高效率。

8.2 使用

第1步：在pom.xml文件中引入依赖

<!-- 在springboot的父工程中，已经集成了lombok并指定了版本号，故当前引入依赖
时不需要指定version -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>

第2步：在实体类上添加注解

在实体类上添加了@Data注解，那么这个类在编译时期，就会生成getter/setter、equals、 hashcode、toString等方法。

说明： @Data 注解中不包含全参构造方法，通常在实体类上，还会添加上：全参构造、无参构造