1.MyBatis概念:MyBatis是一款优秀的持久层框架,用于简化JDBC开发。
- 它支持自定义 SQL、存储过程以及高级映射
- 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作
- 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录
注:JavaEE分为三层架构:表现层、业务层和持久层,持久层是负责将数据保存到数据库的那一层代码。
2.MyBatis文档: https://mybatis.net.cn/
3.MyBatis简化了JDBC的开发,免除了JDBC 代码以及设置参数和获取结果集的工作
- 硬编码:通过配置文件简化
- 注册驱动,获取连接
- SQL语句
- 操作繁琐:MyBatis自动完成
- 设置参数
- 封装结果集
MyBatis开发步骤:
- 导入MyBatis和数据库驱动等相关依赖
- 创建数据表以及该表对应的实体类
- 编写MyBatis核心配置文件(用于替换连接信息,解决硬编码问题)
- 编写SQL映射文件(用于统一管理SQL语句,解决硬编码问题)
- 编写代码
- 加载核心配置文件,获取SqlSessionFactory对象
- 获取SqlSession对象,执行SQL语句
- 释放资源
1.New Project,创建新项目
2.填写项目名称等信息,Build System勾选Maven,创建maven项目
3.修改maven配置,修改内容和配置
注:settings.xml路径如下:
修改内容如下:
修改配置如下:
1.查找mybatis依赖配置
查看mybatis快速入门文档,得到mybatis依赖配置如下:https://mybatis.net.cn/getting-started.html
2.查找mysql驱动依赖配置
打开cmd,输入 ,查看mysql版本:此处我的版本是
官网,查找该版本对应的mysql驱动:https://mvnrepository.com/
3.复制依赖代码到中,最终代码如下
1.创建数据库
2.创建表
3.在 包下新建 包,并在 包下创建实体类 ,对应表
2.4.1 编写核心配置文件
目录下新建 ,作为核心配置文件,内容如下:
注:数据库的连接信息,根据自己本地电脑的数据库信息填写
2.4.2 编写SQL映射文件
目录下新建 ,作为用户表sql映射文件,需要与中标签中填写的文件名一致。
2.4.3 编写Java代码
在包下新建,内容如下:
执行代码,运行结果如下:
最终项目结构如下:
总结:
- :为核心配置文件,存在着数据库连接信息,以及需要加载的映射文件信息(UserMapper.xml)
- :为SQL映射文件,此处用于编写和管理SQL语句,并对每个SQL语句提供唯一的标识,由 组成,如
- :的程序执行入口代码,通过执行方法 ,执行 对应的SQL语句
使用Mapper代理开发的优势:
- 解决原生方式中的硬编码
- 简化后期执行SQL
原生方式:
Mapper代理开发方式:
使用Mapper代理开发方式完成入门案例:
- 定义与SQL映射文件同名的Mapper接口,并且将Mapper接口和SQL映射文件放置在同一目录下
- 设置SQL映射文件的namespace属性Mapper接口全限定名
- 在Mapper接口中定义方法,方法名就是SQL映射文件中sql语句的id,并保持参数类型和返回值类型一致
- 编码
- 通过SqlSession的getMapper方法获取Mapper接口的代理对象
- 调用对应方法完成sql的执行
注:如果Mapper接口名称和SQL映射文件名称相同,并在同一目录下,则可以使用包扫描的方式简化SQL映射文件的加载
1.定义与SQL映射文件同名的Mapper接口,并且将Mapper接口和SQL映射文件放置在同一目录下
- 在 包下,新建 包,并新建的接口
- 在目录下,新建目录层次结构 ,然后把 拖到该目录下
将的接口的目录结构与都放在在目录下,是为了保证在maven工程编译之后,的接口和 会打包在同一目录下
编译前的结构:
编译后的结构:
2.设置SQL映射文件 的namespace属性为Mapper接口全限定名
3.在Mapper接口中定义方法,方法名就是SQL映射文件中sql语句的id,并保持参数类型和返回值类型一致
- 方法名为,对应的是 的
- 返回类型为 对象的集合,即 类型
4.由于 路径发生了变化,所以也要相应的修改 的sql映射文件路径为
注:由于Mapper接口名称和SQL映射文件名称相同,且在同一目录下,那么也可以使用包扫描的方式简化SQL映射文件的加载
以上一般方式,可以替换为包扫描方式:
5.编码
- 通过SqlSession的getMapper方法获取Mapper接口的代理对象
- 调用对应方法完成sql的执行
执行代码,运行结果如下:
MyBatis核心配置文件说明见官网:https://mybatis.net.cn/configuration.html
注:配置各个标签时,需要遵守前后顺序,这个顺序就是以上截图的顺序
1. :环境配置,MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中, 现实情况下有多种理由需要这么做。例如,开发、测试和生产环境需要有不同的配置;或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。
例如:以下配置表示有开发和测试两个环境的数据库信息,默认使用开发环境的数据库信息。
如果想切换默认的数据库信息,则修改属性为对应的配置的即可,比如,表示默认使用测试数据库的环境信息
2.:类型别名,可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。
例如:原先 中的 属性为
使用 :
- 首先修改核心配置文件 中的配置
- 然后修改 中的 属性
:
需求:能够使用映射配置文件实现CRUD操作,此处是对商品品牌数据的增删改查操作
如上图所示产品原型,里面包含了品牌数据的 、、、、、 等功能,而这些功能其实就是对数据库表中的数据进行CRUD操作。接下来我们就使用Mybatis完成品牌数据的增删改查操作。以下是我们要完成功能列表:
- 查询
- 查询所有数据
- 查询详情
- 条件查询
- 添加
- 修改
- 修改全部字段
- 修改动态字段
- 删除
- 删除一个
- 批量删除
1.创建数据库表
2.在 包下创建 实体类
3.编写测试用例,在 目录下创建包 ,以及测试用例类
项目结构如下:
4.编写MyBatis核心配置文件,在 目录下创建 文件,内容如下:
注:数据库的连接信息,根据自己本地电脑的数据库信息填写
5.安装 插件
MybatisX 是一款基于 IDEA 的快速开发插件,为效率而生,功能如下:
- XML映射配置文件 和 接口方法 间相互跳转
- 根据接口方法生成 statement
安装方式:点击 -> -> -> 搜索 ,就能看到如下图所示界面,点击 安装。
插件效果:
红色头绳的表示映射配置文件,蓝色头绳的表示mapper接口。在mapper接口点击红色头绳的小鸟图标会自动跳转到对应的映射配置文件,在映射配置文件中点击蓝色头绳的小鸟图标会自动跳转到对应的mapper接口。
也可以在mapper接口中定义方法,自动生成映射配置文件中的 ,如图所示:
5.2.1 查询所有数据
如图所示就是页面上展示的数据,而这些数据需要从数据库进行查询:
接下来我们就来讲查询所有数据功能,而实现该功能我们分以下步骤进行实现:
- 编写接口方法
- 编写SQL语句
- 编写测试方法
1.编写接口方法:在 包写创建名为 的接口,并在该接口中定义 方法。
2.编写SQL语句:在 目录下创建 目录结构,并在该目录下创建名为 的映射配置文件
3.编写测试方法:在类中,编写如下代码
运行结果如下:
根据上述运行结果可以看到:、、 和 数据封装成功,能够正常打印数据,但是 和 数据自动封装失败。
原因:是因为实体类中的属性名和数据库表中的字段名不一致导致的,查询 实体类 和 表中的字段 发现,在实体类中属性名是 和 ,而表中的字段名为 和 ,如下图所示 。
解决方案:只需要保持这两部分的名称一致这个问题就迎刃而解,有以下两种方式可以解决
- 给字段起别名
- 使用resultMap定义字段和属性的映射关系(推荐)
1.给字段取别名
编写SQL语句时,给字段取别名,将别名定义成与属性名一致即可
上面的SQL语句中的字段列表书写麻烦,如果表中还有更多的字段,同时其他的功能也需要查询这些字段时就显得我们的代码不够精炼,Mybatis提供了 片段可以提高sql的复用性。
注:起别名 + sql片段的方式可以解决上述问题,但是它也存在问题。如果还有功能只需要查询部分字段,而不是查询所有字段,那么我们就需要再定义一个 SQL 片段,这就显得不是那么灵活。
2.使用resultMap定义字段和属性的映射关系
注意:上面只需要定义 字段名 和 属性名 不一样的映射,而一样的则不需要专门定义出来。
修改后的运行结果如下:
5.2.2 查询单条数据详情
有些数据的属性比较多,在页面表格中无法全部实现,而只会显示部分,而其他属性数据的查询可以通过 来进行查询,如下图所示:
1.编写接口方法
2.编写SQL语句
3.编写测试方法
运行结果如下:
1.参数占位符:可以看到以上SQL语句中使用了 ,也就是参数占位符。
mybatis提供了两种参数占位符:
- :执行SQL时,会将 占位符替换为 ,底层使用的是 ,可以防止SQL注入。
- :直接拼接SQL,底层使用的是 ,会存在SQL注入问题。
注:对比得出,开发都是使用 参数占位符
2.parameterType的使用:对于有参数的mapper接口方法,我们在映射配置文件中应该配置 来指定参数类型,只不过该属性都可以省略。
3.SQL语句中的特殊字符处理
以后肯定会在SQL语句中写一下特殊字符,比如某一个字段大于某个值,但是 等字符在xml中有特殊含义,所以此时我们需要将这些符号进行转义,可以使用以下两种方式进行转义:
- 使用xml的转义字符,例如: 就是 的转义字符。
- 使用,格式为 ,例如: 就是 的转义字符。
注:如果使用了大于或者小于某个值,那么返回的就是 集合,此时要修改mapper接口的返回对象为
5.2.3 条件查询
5.2.3.1 固定多条件查询
我们经常会遇到如上图所示的多条件查询,将多条件查询的结果展示在下方的数据列表中。而我们做这个功能需要分析最终的SQL语句应该是什么样,思考两个问题
- 条件表达式
- 如何连接
条件字段 和 需要进行模糊查询,所以条件应该是:
简单的分析后,我们来看功能实现的步骤:
- 编写接口方法
- 参数:所有查询条件
- 结果:
- 在映射配置文件中编写SQL语句
- 编写测试方法并执行
1.编写接口方法:该功能有三个参数,我们就需要考虑定义接口时,参数应该如何定义。
Mybatis针对多参数有多种实现:
- 散装参数:需要使用
- 实体类封装参数:只需要保证SQL中的参数名和实体类属性名对应上,即可设置成功
- map集合:只需要保证SQL中的参数名和map集合的键名对应上,即可设置成功
1.1 散装参数:使用 标记每一个参数,在映射配置文件中就需要使用 进行占位
1.2 实体类封装参数:将多个参数封装成一个 实体对象 ,将该实体对象作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 时,里面的内容必须和实体类属性名保持一致。
1.3 map集合:将多个参数封装到map集合中,将map集合作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 时,里面的内容必须和map集合中键的名称一致。
2.编写SQL语句
3.编写测试方法
3.1 对应 中使用 标记每一个参数的方式
3.2 对应 中的将多个参数封装成一个 实体对象的方式
3.3 对应 中的将多个参数封装到map集合的方式
运行结果如下:
5.2.3.2 动态多条件查询
上述使用固定多条件查询的功能实现存在很大的问题,用户在输入条件时,不一定会所有的条件都填写,这个时候我们的SQL语句就不能像上面那样写。
例如用户只输入 时,SQL语句就是:
而用户如果只输入 时,SQL语句就是:
而用户如果输入了 和 时,SQL语句又不一样:
针对上述的需要,Mybatis对动态SQL有很强大的支撑:
1.修改SQL语句
- 标签的作用:条件判断
- 属性:逻辑表达式
- 标签的作用:
- 替换where关键字
- 会动态的去掉第一个条件前的 and
- 如果所有的参数没有值则不加where关键字
注意:需要给每个条件前都加上 关键字。
2.修改测试方法:构造测试场景,运行观察是否发生报错
- 用户只输入了
- 用户如果只输入了
- 用户输入了 和
- 用户什么都没输入
此处以小节使用map集合封装参数的方式为例
5.2.3.3 动态单条件查询
如下图所示,在查询时只能选择 、、 这三个条件中的一个,但是用户到底选择哪儿一个,我们并不能确定。这种就属于单个条件的动态SQL语句,这种需求需要使用到 实现, 而 标签类似于Java 中的语句。
1.编写接口方法
2.编写SQL语句
:可以类比 Java 中的语句
- 相当于
- 相当于
- 相当于
3.编写测试方法
运行结果如下:
如下图是我们平时在添加数据时展示的页面,而我们在该页面输入想要的数据后添加 按钮,就会将这些数据添加到数据库中。接下来我们就来实现添加数据的操作。
1.编写接口方法
参数:除了id之外的所有的数据,id对应的是表中主键值,而主键我们是 自动增长 生成的。
2.编写SQL语句
3.编写测试方法
执行完上述代码后,查询 表,发现数据已更新:
在数据添加成功后,有时候需要获取插入数据库数据的主键(主键是自增长)。
例如:添加订单和订单项,如下图就是京东上的订单
订单数据存储在订单表中,订单项存储在订单项表中。
添加订单数据:
添加订单项数据,订单项中需要设置所属订单的id:
明白了什么时候 。接下来我们简单模拟一下,在添加完数据后打印id属性值,能打印出来说明已经获取到了。
我们将上面添加品牌数据的案例中映射配置文件里 进行修改,如下:
- 属性:是否获取自动增长的主键值,true表示获取
- 属性:指定将获取到的主键值封装到哪儿个属性里
修改执行方法,打印返回的主键
如下图所示是修改页面,用户在该页面书写需要修改的数据,点击 按钮,就会将数据库中对应的数据进行修改。需要注意的是,如果哪儿个输入框没有输入内容,我们是将表中数据对应字段值替换为空白还是保留字段之前的值?答案肯定是保留之前的数据。
1.编写接口方法
2.编写SQL语句
3.编写测试方法
运行结果如下:
执行代码前:
执行代码后:
5.5.1 删除单条数据
如下图所示,每行数据后面都有一个 按钮,当用户点击了该按钮,就会将改行数据删除掉。那我们就需要思考,这种删除是根据什么进行删除呢?是通过主键id删除,因为id是表中数据的唯一标识。
1.编写接口方法
2.编写SQL语句
3.编写测试方法
运行结果如下:
执行代码前:
执行代码后:
5.5.2 批量删除数据
如下图所示,用户可以选择多条数据,然后点击上面的 按钮,就会删除数据库中对应的多行数据。
1.编写接口方法
参数是一个数组,数组中存储的是多条数据的
2.编写SQL语句:编写SQL时需要遍历数组来拼接SQL语句,Mybatis 提供了 标签供我们使用。
标签:用来迭代任何可迭代的对象(如数组、集合等)。
- 属性: mybatis会将数组参数,封装为一个Map集合。
- 默认:array = 数组
- 可以使用@Param注解改变map集合的默认key的名称
- 属性:本次迭代获取到的元素。
- 属性:集合项迭代之间的分隔符。 标签不会错误地添加多余的分隔符,也就是最后一次迭代不会加分隔符。
- 属性:该属性值是在拼接SQL语句之前拼接的语句,只会拼接一次
- 属性:该属性值是在拼接SQL语句拼接后拼接的语句,只会拼接一次
假如数组中的id数据是,那么拼接后的sql语句就是:
可以使用@Param注解改变map集合的默认key的名称,例如修改默认key为 :
3.编写测试方法
运行结果如下:
执行代码前:
执行代码后:
Mybatis 接口方法中可以接收各种各样的参数,如下:
- 多个参数
- 单个参数:单个参数又可以是如下类型
- 类型
- 集合类型
- 集合类型
- 集合类型
- 类型
- 其他类型
如下面的代码,就是接收两个参数,而接收多个参数需要使用 注解,那么为什么要加该注解呢?这个问题要弄明白就必须来研究Mybatis 底层对于这些参数是如何处理的。
我们在接口方法中定义多个参数,Mybatis 会将这些参数封装成 Map 集合对象,值就是参数值,而键在没有使用 注解时有以下命名规则:
-
以 arg 开头 :第一个参数就叫 arg0,第二个参数就叫 arg1,以此类推。如:
-
以 param 开头 : 第一个参数就叫 param1,第二个参数就叫 param2,依次类推。如:
代码验证:
1.编写接口方法:在 接口中定义如下方法
2.编写SQL语句:在 映射配置文件中定义SQL,可以使用 或者
使用 开头:
使用 开头:
3.编写测试方法:在类中,编写如下代码
运行结果如下:
在映射配合文件的SQL语句中使用用 开头的和 书写,代码的可读性会变的特别差,此时可以使用 注解。在接口方法参数上使用 注解,Mybatis 会将 开头的键名替换为对应注解的属性值。
代码验证:
1.在 接口中定义如下方法,在 参数前加上 注解
Mybatis 在封装 Map 集合时,键名就会变成如下:
2.在 映射配置文件中定义SQL
正确的SQL语句:
错误的SQL语句:
运行报错如下:显示没找到参数,有效的参数为
结论:以后接口参数是多个时,在每个参数上都使用 注解。这样代码的可读性更高
单个参数的类型:
-
POJO 类型:直接使用,要求 和 一致
-
Map 集合类型:直接使用,要求 和 一致
-
Collection 集合类型:Mybatis 会将集合封装到 map 集合中,如下:
-
List 集合类型:Mybatis 会将集合封装到 map 集合中,如下:
-
Array 类型:Mybatis 会将集合封装到 map 集合中,如下:
-
其他类型: 比如int类型, 叫什么都可以,尽量做到见名知意。
注:以上都可以使用 注解替换map集合中默认的 arg 键名
使用注解开发会比配置文件开发更加方便,但是注解只能完成简单功能,而配置文件可以完成复杂功能
Mybatis 针对 CURD 操作都提供了对应的注解,已经做到见名知意。如下:
- 查询 :
- 添加 :
- 修改 :
- 删除 :
注解是用来替换映射配置文件方式配置的,所以使用了注解,就不需要再映射配置文件中书写对应的
1.查询数据
编写接口方法:
编写测试方法:
2.添加数据
编写接口方法:
编写测试方法:
3.修改数据
编写接口方法:
编写测试方法:
4.删除数据
编写接口方法:
编写测试方法: