MyBatis

• 前置铺垫
• • 创建数据库
  • MyBatis 的执行流程
  • 创建对应流程
• MyBatis—查询
• • 查询用户信息
  • • 执行流程
    • 创建实体类
    • 创建 Interface 与 xml
    • 在 xml 中编写 SQL 语句
    • 模拟执行流程
• 单元测试
• • 定义
  • 优点
  • 执行单元测试
  • • 引入依赖
    • 生成单元测试
    • 编写代码
    • Assertions—断言
• MyBatis—新增
• • 新增用户信息(不返回用户 Id)
  • • 在 Interface 中定义方法
    • 在 xml 中实现方法
    • 单元测试验证效果
  • 新增用户信息(返回用户 Id)
  • • 在 Interface 中定义方法
    • 在 xml 中实现方法
    • 单元测试验证效果
• MyBatis—修改
• • 修改用户信息
  • • 在 Interface 中定义方法
    • 在 xml 中实现方法
    • 单元测试验证效果
• MyBatis—配置打印执行的 SQL
• MyBatis—删除
• • 删除用户信息
  • • 在 Interface 中定义方法
    • 在 xml 中实现方法
    • 单元测试验证效果
    • • 不污染数据库进行单元测试
• 对比 # 与 $
• • 根据 id 查询用户信息
  • 根据 username 查询用户信息
  • 根据 id 进行排序
  • 总结
  • SQL 注入
• like 查询
• • 根据 username 查询用户信息
  • 使用 # 时的解决办法
• 类中的属性与数据库的字段名不一致
• • resultMap
  • 重命名
• 多表查询
• 动态 SQL 的使用
• • if 标签
  • trim 标签
  • where 标签
  • set 标签
  • foreach 标签
• 完结撒花

对于 MyBatis 的介绍及创建可以参考这篇文章

前置铺垫

创建数据库

MyBatis 是实现程序和数据库交互的工具

因此在操作 MyBatis 时需要先创建数据库

复制如下代码至 MySQL 中

后续操作将针对该数据库进行演示

-- 创建数据库drop database if exists excnblog;create database excnblog DEFAULT CHARACTER SET utf8mb4;-- 使用数据数据use excnblog;-- 创建表[用户表]drop table if existsuserinfo;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 existsarticleinfo;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 `excnblog`.`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);

MyBatis 的执行流程

创建对应流程

• 创建 controller 包 → 控制器层
• 创建 service 包 → 服务层
• 创建 mapper 包 → 数据持久层
• 创建 entity 包 → 实体类

MyBatis—查询

查询用户信息

查询用户信息 → 此处使用的数据表为 userinfo(用户) 表

执行流程

创建实体类

实体类中的属性对应数据表的字段
(属性名与字段名可以不一一对应, 但建议保持一致)

创建 Interface 与 xml

• Interface → 定义所需的方法
• xml → 实现定义的方法

创建 Interface

创建 Interface, 需添加@Mapper注解, 目的是为了随着 Spring 项目的启动加载 UserMapper

Interface 中定义的方法的参数建议添加@Param注解

创建 xml

xml 的配置模板

namespace="", 标识当前的 xml 文件实现的哪个 Interface

<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace=""></mapper>

注意对应关系

namespace="com.example.demo.mapper.UserMapper"

表示当前的 xml 文件实现的是 com → example → demo → mapper → UserMapper(Interface)

在 xml 中编写 SQL 语句

写法1

select * from userinfo where id = ${id}

写法2

select * from userinfo where id = #{id}

大多数情况下使用 #

后面会介绍 $ 与 # 的区别

注意对应关系

使用标签时通常需搭配 2 个属性

• id, 对应方法名
• resultType, 对应方法的返回值

模拟执行流程

服务层(Sevice) → 数据持久层(Mapper)

控制层(Controller) → 服务层(Service)

设置 URL 时不要大小写组合, 建议全部小写, 利用-或_分割

运行查看结果

单元测试

定义

单元测试(Unit Testing), 指对软件中的最⼩可测试单元进⾏检查和验证的过程

在 Java 中, 最小可测试单元通常指方法

优点

• 简单, 直观, 快速的测试某个功能是否正确
• 可在打包时发现错误(因为打包之前所有单元测试必须通过, 否则无法打包成功)
• 使用单元测试测试功能时, 可以不污染连接的数据库(即不对数据库进行修改)

执行单元测试

引入依赖

SpringBoot 默认内置了该依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency>

生成单元测试

在 UserMapper(Interface) 中右击 → Generate

Generate → Test

点击 Test 弹出如下界面

• Testing library, 单元测试的框架
• Class name, 生成的类名
• Superclass, 测试类继承的父类
• Destination package, 文件生成的目录名
• Generate, 生成选项
• setUp / @Before, 前置选项
• tearDown / @After, 后置选项
• Show inherited methods, 显示内置方法

勾选 getUserById() 方法, 点击 OK

弹出如下界面

编写代码

1. 添加注解@SpringBootTest
2. 在对应的单元测试方法中编写代码

Assertions—断言

如果断言失败, 后续代码将不会执行

MyBatis—新增

使用show create table userinfo查看哪些字段为非空(NOT NULL)

• username → NOT NULL
• password → NOT NULL
• createtime → NOT NULL(但含有默认值)
• updatetime → NOT NULL(但含有默认值)

新增用户信息(不返回用户 Id)

新增用户信息 → 此处使用的数据表为 userinfo(用户) 表

新增操作默认返回值为 Int 类型

新增操作的标签为
使用标签时需搭配 id 属性

在 Interface 中定义方法

/*** 新增用户信息* @author bibubibu* @date 2023/7/2*/int add(Userinfo userinfo);

在 xml 中实现方法

<insert id="add">insert into userinfo(username, password) values(#{username}, #{password})</insert>

注意

对于values(#{username}, #{password})

username 对应的是实体类中的属性(不是字段名)
password 对应的是实体类中的属性(不是字段名)

单元测试验证效果

非第一次添加单元测试时, 可能会出现 Error

点击 OK 即可

测试查看效果

针对当前代码, 无法得到添加对象成功后对象的 id

userinfo 表中的 id 是自增的

对于当前运行结果, 表示已添加成功, 但无法得到添加对象的 id

新增用户信息(返回用户 Id)

返回用户 Id, 需在标签添加useGeneratedKeys与keyProperty

• useGeneratedKeys, 是否使用生成的主键
• keyProperty, 将生成的主键赋值给哪个属性

在 Interface 中定义方法

/*** 新增用户信息(返回用户 Id)* @author bibubibu* @date 2023/7/2*/int addAndRetId(UserInfo userInfo);

在 xml 中实现方法

<insert id="addAndRetId" useGeneratedKeys="true" keyProperty="id">insert into userinfo(username, password) values(#{username}, #{password})</insert>

注意

keyProperty="id"对应的是类中的属性, 而非数据库中的字段

• Property, 属性
• Column, 字段

单元测试验证效果

MyBatis—修改

修改用户信息

修改用户信息 → 此处使用的数据表为 userinfo(用户) 表

修改操作默认返回值为 Int 类型

修改操作的标签为
使用标签时需搭配 id 属性

在 Interface 中定义方法

/*** 修改用户信息* @author bibubibu* @date 2023/7/3*/int updateUserInfo(UserInfo userInfo);

在 xml 中实现方法

<update id="updateUserInfo">update userinfo set username = #{username}, password = #{password} where id = #{id}</update>

单元测试验证效果

MyBatis—配置打印执行的 SQL

# 设置 Mybatis 的 xml 保存路径mybatis:mapper-locations: classpath:mapper/*Mapper.xmlconfiguration: # 配置打印 MyBatis 执行的 SQLlog-impl: org.apache.ibatis.logging.stdout.StdOutImpl# 设置日志级别logging:level:com:example:demo: debug

效果测试

MyBatis—删除

删除用户信息

删除用户信息 → 此处使用的数据表为 userinfo(用户) 表

删除操作默认返回值为 Int 类型

删除操作的标签为
使用标签时需搭配 id 属性

在 Interface 中定义方法

/*** 删除用户信息* @author bibubibu* @date 2023/7/3*/int delUserInfo(@Param("id") Integer id);

在 xml 中实现方法

<delete id="delUserInfo">delete from userinfo where id = #{id};</delete>

单元测试验证效果

不污染数据库进行单元测试

利用注解@Transactional

注解@Transactional既可以修饰类, 也可以修饰方法

举个栗子

要求

测试删除功能是否正常 + 数据库中的数据不会被删除
(即不污染数据库进行单元测试)

此时可以利用注解@Transactional

删除功能正常

数据库中的数据不会被删除

对比 # 与 $

根据 id 查询用户信息

/*** 根据 Id 查询用户信息* @author bibubibu* @date 2023/7/2*/UserInfo getUserById(@Param("id") Integer id);

使用 #

<select id="getUserById" resultType="com.example.demo.entity.UserInfo">select * from userinfo where id = #{id}</select>

使用 $

<select id="getUserById" resultType="com.example.demo.entity.UserInfo">select * from userinfo where id = ${id}</select>

运行结果

均可正常运行

根据 username 查询用户信息

/*** 根据 username 查询用户信息* @author bibubibu* @date 2023/7/3*/List<UserInfo> getUserByName(@Param("username") String username);

使用 #

<select id="getUserByName" resultType="com.example.demo.entity.UserInfo">select * from userinfo where username = #{username}</select>

使用 $

<select id="getUserByName" resultType="com.example.demo.entity.UserInfo">select * from userinfo where username = ${username}</select>

运行结果

使用 # 正常运行
使用 $ 无法正常运行

根据 id 进行排序

排序有 2 种类型

• 升序 → asc
• 降序 → desc

此处以降序举例

/*** 根据 Id 进行排序* @author bibubibu* @date 2023/7/3*/List<UserInfo> getUserOrderById(@Param("order") String order);

使用 #

<select id="getUserOrderById" resultType="com.example.demo.entity.UserInfo">select * from userinfo order by id #{order}</select>

使用 $

<select id="getUserOrderById" resultType="com.example.demo.entity.UserInfo">select * from userinfo order by id ${order}</select>

运行结果

使用 # 无法正常运行
使用 $ 正常运行

总结

• #{} → 编译预处理, 不存在 SQL 注入问题
• ${} → 直接替换, 存在 SQL 注入问题

使用 $ 的注意事项

一定是可穷举的值(例如关键字…), 在使用之前要对传递的值进行安全性验证

编译预处理是指 MyBatis 在处理 #{ } 时, 将 SQL 中的 #{ } 替换为 ” />即针对数值形数据, #{}无需添加''(也可理解为直接替换的一种方式), 因此利用#可以运行成功

简单来说就是针对不同的内容

#{}可能会对参数添加''(字符串型), 也可能是直接替换(数值型)

${}直接替换为对应参数的内容

SQL 注入

既然 # 对于字符串型数据会添加'', 那使用 $ 时对于字符串型手动添加''不可以么

答
使用 $ 是不安全的, 可能会引起 SQL 注入问题

什么是 SQL 注入?

举个栗子

userinfo 表中的内容

定义一个 login 方法

UserInfo login(@Param("username") String username, @Param("password") String password);

实现该方法

(对于字符串型手动添加'')

<select id="login" resultType="com.example.demo.entity.UserInfo">select * from userinfo where username = '${username}' and password = '${password}'</select>

单元测试查看结果

登录成功

修改密码后查看结果

登录失败

利用 SQL 注入登录(使用错误的密码)

登录成功

注意此时的密码

String password = "' or 1 = '1";

最终生成的 SQL 语句

select * from userinfo where username = 'admin' and password = '' or 1 = '1'

划分为 2 部分(优先级 → and > or)

username = 'admin' and password = '' / 1 = '1'

因此可以成功登录

上述即为 SQL 注入, 因此推荐使用 # 而不是 $

like 查询

like 查询 → 此处使用的数据表为 userinfo(用户) 表

数据表中的数据

根据 username 查询用户信息

在 Interface 中定义方法

/*** Like 查询* @author bibubibu* @date 2023/7/3*/List<UserInfo> getListByName(@Param("username") String username);

在 xml 中实现方法

<select id="getListByName" resultType="com.example.demo.entity.UserInfo">select * from userinfo where username like '%#{username}%'</select>

单元测试验证效果

Error → 这是因为使用 # 处理字符串类型时, SQL 语句会添加''

即上述 SQL 语句变为select * from userinfo where username like '%'a'%'

期望的效果是select * from userinfo where username like '%a%'

可能有的小伙伴会说, 那可以用 $ 处理呀

答
不可以, 还记得上面说的使用 $ 时的注意事项么
使用 $ 时的注意事项 → 一定是可穷举的值(例如关键字…), 而 username 无法穷举, 因此应避免使用 $

使用 # 时的解决办法

解决办法 → 利用 concat() 进行拼接

<select id="getListByName" resultType="com.example.demo.entity.UserInfo">select * from userinfo where username like concat('%', #{username}, '%')</select>

对比

select * from userinfo where username like '%#{username}%'

select * from userinfo where username like concat('%', #{username}, '%')

单元测试验证效果

类中的属性与数据库的字段名不一致

数据表中的数据

查询数据

/*** 查询全部信息* @author bibubibu* @date 2023/7/2*/List<UserInfo> getAll();

<select id="getAll" resultType="com.example.demo.entity.UserInfo">select * from userinfo</select>

分析结果发现类中的属性名与数据库的字段名不一致的均未被赋值

解决方法

1. resultMap
2. 重命名

使用较多的是重命名

resultMap

使用resultMap将数据库中的字段与类中的属性映射

使用resultMap

<select id="getAll" resultMap="bibubibu">select * from userinfo</select>

问题

并非所有的属性与字段名称都不一致, 需要全部进行映射么” />

重命名

重命名, 更为简便的映射属性与字段

<select id="getAll" resultType="com.example.demo.entity.UserInfo">select id, username as name, password as pwd, photo, createtime, updatetime, state from userinfo;</select>

测试结果

多表查询

多表查询的实现 → 联表查询(left join / right join / inner join) + xxxVO

举个栗子

查询文章的作者(username)

此处查询的数据表为 userinfo(用户) 表,articleinfo(文章) 表

由于 articleinfo(文章) 表只有 uid(用户 id), 因此需要进行多表联查

下面为具体步骤

articleinfo 表与 userinfo 表

articleinfo 表中的 uid 对应 userinfo 表中的 id

根据 articleinfo 表创建 ArticleInfo 实体类

多表联查时返回数据需要包含文章作者(username)
因此扩展 articleinfo(文章) 表的实体类

扩展的实体类放入 objectview 包下, 继承 Articleinfo 类

在 Interface 中定义方法

ArticleInfoVO getById(@Param("id") Integer id);

在 xml 中实现方法

<select id="getById" resultType="com.example.demo.entity.viewobject.ArticleInfoVO">select a.*, u.username from articleinfo as aleft join userinfo as uon a.uid = u.idwhere a.id = #{id}</select>

单元测试验证效果

发现只有 username 字段, 其他字段消失了

Debug 分析错误

发现查询的结果是包含 username + 其他字段的

排查错误

发现是 Lombok 重写 toString() 方法时的 BUG

重写 toString()

单元测试验证效果

另一种解决方法

取消继承, 重写全部属性

注意事项

实体类建议实现 Serializable 接口

目的是为了完成该类的序列化与反序列化操作

动态 SQL 的使用

动态 SQL 是 MyBatis 的强⼤特性之⼀，能够完成不同条件下不同的 SQL 拼接

官方对于动态 SQL 的介绍

if 标签

在数据表中
一些字段必须填写(必填字段)
一些字段可以填写, 也可以不填写(非必填字段)

如果在编写 SQL 语句中有不确定的字段(非必填字段), 就需要使用 if 标签进行判断

语法

<if test=""></if>

举个栗子

SQL 语句

insert into userinfo(username, password, photo) values('Lily', '6666', 'Lily.png');

xml 中实现

<insert id="add2">insert into userinfo(username, password<if test="photo != null">, photo</if>) values(#{username}, #{password}<if test="photo != null">, #{photo}</if>)</insert>

trim 标签

如果所有字段都是非必填字段, 通常使用 trim 标签 + if 标签

trim 标签的属性

• prefix, 表示整个代码块以 prefix 的值作为前缀
• suffix, 表示整个代码块以 suffix 的值作为后缀
• prefixOverrides, 表示整个代码块要去除的前缀
• suffixOverrides, 表示整个代码块要去除的后缀

语法

<trim prefix="" suffix="" prefixOverrides="" suffixOverrides=""></trim>

举个栗子

SQL 语句

insert into userinfo(username, password, photo) values('Judy', 'Judy_pwd', 'Judy.png');

xml 中实现

<insert id="add3">insert into userinfo<trim prefix="(" suffix=")" suffixOverrides=","><if test="username != null">username,</if><if test="password != null">password,</if><if test="photo != null">photo</if></trim>values<trim prefix="(" suffix=")" suffixOverrides=","><if test="username != null">#{username},</if><if test="password != null">#{password},</if><if test="photo != null">#{photo}</if></trim></insert>

where 标签

where 标签通常搭配 if 标签一起使用

where 标签的特点

• where 标签会删除最前面的 and 关键字
• 如果 where 标签中没有内容(即 if 属性中的参数全部为 null), 就不会生成相对应的 where 语句

语法

<where></where>

举个栗子

SQL 语句

select * from userinfo where username = 'Tom' and password = 'Tom_pwd';

xml 中实现

<select id="getByCondition" resultType="com.example.demo.entity.UserInfo">select * from userinfo<where><if test="username != null">username = #{username}</if><if test="password != null">and password = #{password}</if></where></select>

利用 trim 标签实现 where 标签

<select id="getByCondition" resultType="com.example.demo.entity.UserInfo">select * from userinfo<trim prefix="where" prefixOverrides="and"> <if test="username != null"> username = #{username} </if> <if test="password != null"> and password = #{password} </if> </trim></select>

set 标签

set 标签通常搭配 if 标签一起使用

set 标签的特点

• set 标签会删除最后面的,

语法

<set></set>

举个栗子

SQL 语句

update userinfo set username = 'Jackson', password = 'Jackson_pwd', photo = 'Jackson.png' where id = 9;

xml 中实现

<update id="update">update userinfo<set><if test="username != null">username = #{username},</if><if test="password != null">password = #{password},</if><if test="photo != null">photo = #{photo},</if></set>where id = #{id}</update>

利用 trim 标签实现 where 标签

<update id="update">update userinfo<trim prefix="set" suffixOverrides=","> <if test="username != null"> username = #{username}, </if> <if test="password != null"> password = #{password}, </if> <if test="photo != null"> photo = #{photo}, </if> </trim>where id = #{id}</update>

foreach 标签

foreach 标签通常用于遍历集合

foreach 标签常用属性

• collection, 绑定方法中的参数, 如 List, Set, Map 或数组对象
• item, 遍历时的每一个对象
• open, 代码块开头的字符串
• close, 代码块结束的字符串
• separator, 每次遍历之间间隔的字符串

语法

<foreach collection="" open="" close="" item="" separator=""></foreach>

举个栗子

SQL 语句

delete from userinfo where id in(1, 2, 3);

xml 中实现

<delete id="dels">delete from userinfo where id in<foreach collection="ids" open="(" close=")" item="val" separator=",">#{val}</foreach></delete>

对应关系

完结撒花