mybatis
- 原生的API&注解的方式
- MyBatis-原生的API调用
- 快速入门需求
- 快速入门代码实现
- MyBatis-注解的方式操作
- 快速入门需求
- 快速入门代码实现
- 注意事项和说明
- mybatis-config.xml配置文件详解
- 说明
- properties属性
- settings全局参数定义
- typeAliases别名处理器
- typeHandlers类型处理器
- environments环境
- XxxMapper.xml-SQL映射文件
- 官方文档
- 基本介绍
- 详细说明
- 基本使用
- parameterType(输入参数类型)
- 传入HashMap
- resultMap(结果集映射)
- 动态SQL语句-更复杂的查询业务需求
- 官方文档
- 基本介绍
- 案例演示
- if标签应用实例
- where标签应用实例
- choose/when/otherwise应用实例
- foreach标签应用实例
- trim标签应用实例[使用较少]
- set标签应用实例[重点]
- 课后练习
上一篇, 我们学习到了 mabatis 中
接下来我们学习, mabatis 下
原生的API&注解的方式
MyBatis-原生的API调用
快速入门需求
●在前面项目的基础上, 将增删改查, 使用MyBatis
原生的API
完成, 就是直接通过SqlSession
接口的方法来完成
1.增加
2.删除
3.修改
4.查询
快速入门代码实现
打开mybatis项目
1.创建com.zzw.mapper.MyBatisNativeTest
, 完成 删除 / 修改 / 查询
数据
/**
* @author 赵志伟
* @version 1.0
* MyBatisNativeTest: 演示使用MyBatis原生API操作
*/
@SuppressWarnings({"all"})
public class MyBatisNativeTest {
//属性
private SqlSession sqlSession;
//编写方法完成初始化
@Before
public void init() {
//获取到sqlSession
sqlSession = MyBatisUtils.getSqlSession();
//sqlSession 返回的对象是 DefaultSqlSession
System.out.println("sqlSession=" + sqlSession.getClass());//sqlSessionFactory=org.apache.ibatis.session.defaults.DefaultSqlSessionFactory@610f7aa
}
//测试初始化方法, 测试完后删掉
@Test
public void t1() {
System.out.println("t1");
}
//使用selSession原生的API调用我们编写的方法[了解]
@Test
public void myBatisNativeCrud() {
//添加
/*
@Override
public int insert(String statement, Object parameter) {
return update(statement, parameter);
}
statement: 是要执行的接口方法-完整声明
parameter: 入参
*/
Monster monster = new Monster();
monster.setAge(25);
monster.setBirthday(new Date());
monster.setEmail("978964140@qq.com");
monster.setGender(1);
monster.setName("狐狸精");
monster.setSalary(1000);
int insert =
sqlSession.insert("com.zzw.mapper.MonsterMapper.addMonster", monster);
System.out.println("insert--" + insert);
//删除
int delete = sqlSession.delete("com.zzw.mapper.MonsterMapper.delMonster", 3);
System.out.println("delete--" + delete);
//修改
monster = new Monster();
monster.setAge(23);
monster.setBirthday(new Date());
monster.setEmail("978964140@qq.com");
monster.setGender(0);
monster.setName("扑克牌");
monster.setSalary(2000);
monster.setId(4);//这个一定要有, 如果们没有就不知道修改哪个对象
int update = sqlSession.update("com.zzw.mapper.MonsterMapper.updateMonster", monster);
System.out.println("update--" + update);
//查询 - 查询可以不提交事务 - 最终还时调用的MonsterMapper.xml里的findAllMonster方法
List<Monster> monsters = sqlSession.selectList("com.zzw.mapper.MonsterMapper.findAllMonster", 4);
for (Monster monster1 : monsters) {
System.out.println("monster1--" + monster1);
}
//如果是增删改, 需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("操作成功..");
}
}
MyBatis-注解的方式操作
快速入门需求
●在前面项目的基础上, 将增删改查, 使用MyBatis
注解的方式完成
1.增加
2.删除
3.修改
4.查询
快速入门代码实现
1.新建com.zzw.mapper.MonsterAnnotation
public interface MonsterAnnotation {
//添加monster
/*
解读
1.使用注解方式来配置接口方法addMonster
2.回顾xml如何配置
<insert id="addMonster" parameterType="Monster" useGeneratedKeys="true" keyProperty="id">
INSERT INTO `monster`
(`age`, `birthday`, `email`, `gender`, `name`, `salary`)
VALUES (#{age}, #{birthday}, #{email}, #{gender}, #{name}, #{salary})
</insert>
*/
@Insert("INSERT INTO `monster` (`age`, `birthday`, `email`, `gender`, `name`, `salary`) " +
"VALUES (#{age}, #{birthday}, #{email}, #{gender}, #{name}, #{salary})")
public void addMonster(Monster monster);
//根据id删除一个Monster
/*
xml文件中的配置
<delete id="delMonster" parameterType="java.lang.Integer">
DELETE FROM `monster` WHERE id = #{id}
</delete>
*/
@Delete("DELETE FROM `monster` WHERE id = #{id}")
public void delMonster(Integer id);
//修改Monster
/*
<update id="updateMonster" parameterType="Monster">
UPDATE `monster` SET `age` = #{age}, `birthday` = #{birthday}, `email` = #{email},
`gender` = #{gender}, `name` = #{name}, `salary` = #{salary} WHERE id = #{id}
</update>
*/
@Update("UPDATE `monster` SET `age` = #{age}, `birthday` = #{birthday}, " +
"`email` = #{email}, `gender` = #{gender}, `name` = #{name}, " +
"`salary` = #{salary} WHERE id = #{id}")
public void updateMonster(Monster monster);
//查询-根据id
/*
xml配置
<select id="getMonsterById" resultType="Monster">
SELECT * FROM `monster` WHERE id = #{id}
</select>
*/
@Select("SELECT * FROM `monster` WHERE id = #{id}")
public Monster getMonsterById(Integer id);
//查询所有的Monster
/*
xml配置
<select id="findAllMonster" resultType="Monster">
SELECT * FROM `monster`
</select>
*/
@Select("SELECT * FROM `monster`")
public List<Monster> findAllMonster();
}
2.修改mybatis-config.xml
, 对MonsterAnnotation
进行注册
<mappers>
<mapper resource="com/zzw/mapper/MonsterMapper.xml"/>
<!--注解
1. 如果是通过注解的方式, 可不再使用 MonsterMapper.xml
2. 但是需要在mybatis-config.xml注册/引入含注解的类
3. 如果没有引入, 不能使用
-->
<mapper class="com.zzw.mapper.MonsterAnnotation"/>
</mappers>
3.测试com.zzw.mapper.MonsterAnnotationTest
public class MonsterAnnotationTest {
//属性
private SqlSession sqlSession;
private MonsterAnnotation monsterAnnotation;
@Before
public void init() {
//获取到sqlSession
sqlSession = MyBatisUtils.getSqlSession();
monsterAnnotation = sqlSession.getMapper(MonsterAnnotation.class);
//返回的依然是有个接口的代理对象
System.out.println("monsterAnnotation--" + monsterAnnotation.getClass());
}
@Test
public void addMonster() {
Monster monster = new Monster();
monster.setAge(25);
monster.setBirthday(new Date());
monster.setEmail("978964140@qq.com");
monster.setGender(1);
monster.setName("赵志伟");
monster.setSalary(6000);
//使用在接口方法配置注解方式完成对DB操作
monsterAnnotation.addMonster(monster);
//如果是增删改, 需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("保存成功");
}
@Test
public void findAllMonster() {
//使用接口配置注解的方法操作
List<Monster> allMonster = monsterAnnotation.findAllMonster();
for (Monster monster : allMonster) {
System.out.println("monster--" + monster);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
}
注意事项和说明
1.如果是通过注解的方式, 就不再使用MonsterMapper.xml
文件, 但是需要在mybatis-config.xml
文件中注册含注解的类/接口
org.apache.ibatis.binding.BindingException: Type interface com.zzw.mapper.MonsterAnnotation is not known to the MapperRegistry.
2.使用注解方式添加时, 如果要返回自增长id
值, 可以使用@Option
注解, 组合使用
/*
解读
1.useGeneratedKeys = true, 返回自增的值
2.keyProperties = "id" 自增值对应的对象属性
3.keyColumn = "id" 自增值对应的表的字段
*/
@Insert("INSERT INTO `monster` (`age`, `birthday`, `email`, `gender`, `name`, `salary`) " +
"VALUES (#{age}, #{birthday}, #{email}, #{gender}, #{name}, #{salary})")
@Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
public void addMonster(Monster monster);
2.2测试MonsterAnnotationTest
//使用在接口方法配置注解方式完成对DB操作
monsterAnnotation.addMonster(monster);
System.out.println("添加后monster-id-" + monster.getId());
3.在Junit
演示添加/查询即可 [课堂练习] - 即MonsterAnnotationTest
@Test
public void delMonster() {
//使用接口配置注解的方式操作
monsterAnnotation.delMonster(4);
//如果是增删改, 需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("删除成功...");
}
@Test
public void updateMonster() {
Monster monster = new Monster();
monster.setAge(23);
monster.setBirthday(new Date());
monster.setEmail("978964140@qq.com");
monster.setGender(0);
monster.setName("zzw");
monster.setSalary(2000);
monster.setId(5);
monsterAnnotation.updateMonster(monster);
//如果是增删改, 需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("修改成功...");
}
@Test
public void getMonsterById() {
Monster monster = monsterAnnotation.getMonsterById(5);
System.out.println("monster--" + monster);
//查询语句, 释放连接还是有必要的
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
mybatis-config.xml配置文件详解
说明
mybatis的核心配置文件(mybatis-config.xml), 比如配置jdbc连接信息, 注册mapper等等, 我们需要对这个配置文件有详细的了解
文档地址: https://mybatis.org/mybatis-3/zh_CN/configuration.html
properties属性
1.新建src/main/resources/jdbc.properties
, properties对键值不做限制
注意: 在XML文件中表示一个实际的&
字符时,你应该使用&
在properties文件中使用&
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
jdbc.user=root
jdbc.pwd=zzw
2.修改mybatis-config.xml
<configuration>
<!--引入外部的jdbc.properties-->
<properties resource="jdbc.properties"/>
<environments default="development">
<environment id="development">
<!--配置事务管理器-->
<transactionManager type="JDBC"/>
<!--配置数据源
解读
1.我们使用外部的properties文件来设置相关的值
2.这个属性文件, 需要统一地放在 resources目录/类加载路径
3.关于属性文件, 我们在java基础集合部分讲过
-->
<dataSource type="POOLED">
<!--配置驱动-->
<!--<property name="driver" value="com.mysql.jdbc.Driver"/>-->
<property name="driver" value="${jdbc.driver}"/>
<!--配置连接mysql的url -->
<!--<property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8"/>-->
<property name="url" value="${jdbc.url}"/>
<!--<property name="username" value="root"/>-->
<property name="username" value="${jdbc.user}"/>
<!--<property name="password" value="zzw"/>-->
<property name="password" value="${jdbc.pwd}"/>
</dataSource>
</environment>
</environments>
</configuration>
3.修改父项目的pom.xml
(如果已经配置了*.properties
就不用再配置), 并完成测试
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.xml</include>
<include>**/*.properties</include>
</includes>
</resource>
settings全局参数定义
详见手册
typeAliases别名处理器
1.别名是为Java
类型命名一个短名字. 它只和XML
配置有关, 用来减少类名重复的部分
2.如果指定了别名, 我们的MapperXxx.xml
文件就可以做相应的简化处理
3.注意指定别名后, 还是可以使用全名的
4.举例说明
1)修改mybatis-config.xml
<!--配置别名-->
<typeAliases>
<!--<typeAlias type="com.zzw.entity.Monster" alias="Monster"/>-->
<!--
如果一个包下有很多的类, 我们可以直接引入包
, 这样该包下面的所有类名, 可以直接使用
-->
<package name="com.zzw.entity"/>
</typeAliases>
2)完成测试
@Test
public void findAllMonster() {
List<Monster> monsters = monsterMapper.findAllMonster();
for (Monster monster : monsters) {
System.out.println("monster="+ monster);
}
//查询语句, 释放连接还是有必要的
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
typeHandlers类型处理器
1.用于java
类型和jdbc
类型映射
2.Mybatis
的映射基本已经满足, 不太需要重新定义
3.这个我们使用默认即可, 也就是mybatis
会自动地将java
和jdbc
类型进行转换
4.java
类型和jdbc
类型映射关系一览 [手册]
environments环境
1.resource
注册Mapper
文件: XXXMapper.xml
文件 (常用, 使用过)
<mappers>
<mapper resource="com/zzw/mapper/MonsterMapper.xml"/>
</mappers>
2.class:
接口注解实现(使用过)
<mappers>
<!--<mapper resource="com/zzw/mapper/MonsterMapper.xml"/>-->
<!--注解
1. 如果是通过注解的方式, 可不再使用 MonsterMapper.xml
2. 但是需要在mybatis-config.xml注册/引入含注解的类
3. 如果没有引入, 不能使用
-->
<mapper class="com.zzw.mapper.MonsterAnnotation"/>
</mappers>
3.url:
外部路径, 使用很少, 不推荐, <mapper url="file://D:\yy\kk\yy\MonsterMapper.xml">
4.package
方式注册: <package name="com.zzw.mapper"/>
<mappers>
<!--<mapper resource="com/zzw/mapper/MonsterMapper.xml"/>-->
<!--注解
1. 如果是通过注解的方式, 可不再使用 MonsterMapper.xml
2. 但是需要在mybatis-config.xml注册/引入含注解的类
3. 如果没有引入, 不能使用
-->
<!--<mapper class="com.zzw.mapper.MonsterAnnotation"/>-->
<!--
解读
1.当一个包下有很多的Mapper.xml文件和基于注解实现的接口时
, 为了方便, 我们可以以包的方式进行注册
2.将下面的所有xml文件和注解接口, 都进行注册
-->
<package name="com.zzw.mapper"/>
</mappers>
5.测试… MonsterAnnotationTest--MonsterMapperTest--findAllMonster
XxxMapper.xml-SQL映射文件
官方文档
文档地址: https://mybatis.org/mybatis-3/zh_CN/sqlmap-xml.html
基本介绍
1.MyBatis
的真正强大在于它的语句映射(在XxxMapper.xml
配置), 由于它的异常强大, 如果拿它跟具有相同功能的JDBC
代码进行对比, 你会立即发现省掉了将近95%
的代码. MyBatis
致力于减少使用成本, 让用户能更专注于SQL
代码.
2.SQL
映射文件常用的几个顶级元素 (按照应被定义的顺序列出) :
cache
- 该命名空间的缓存配置
cache-ref
- 引用其它命名空间的缓存配置
resultMap
- 描述如何从数据集结果集中加载对象, 是最复杂也是最强大的元素
parameterType
- 将会传入这条语句的参数的类全限定名或别名
sql
- 可被其它语句引用的可重复的语句块.
insert
- 映射插入语句
update
- 映射更新语句
delete
- 映射删除语句
select
- 映射查询语句
详细说明
1.在原来的mybatis
项目中, 新建xml-mapper
子项目 [参考], 演示xml
映射器的使用
2.新建Module
后, 先创建需要的包, 再将需要的文件 / 资源拷贝过来(这里我们拷贝Monster.java
, resources/jdbc.properties
和 mybatis-config.xml
)
3.拷贝MonsterMapper.java
, MonsterMapper.xml
和 MonsterMapperTest.java
, 做一个比较 干净的讲解环境
基本使用
1.insert
, delete
, update
, select
这个我们在前面学习过, 分别对应增删改查的方法和SQL
语句的映射
2.如何获取到刚刚添加的Monster
对象的id
主键 [前面讲解过了]
<insert id="addMonster" parameterType="Monster" useGeneratedKeys="true" keyProperty="id">
INSERT INTO `monster` (`age`, `birthday`, `email`, `gender`, `name`, `salary`)
VALUES (#{age}, #{birthday}, #{email}, #{gender}, #{name}, #{salary})
</insert>
parameterType(输入参数类型)
●parameterType(输入参数类型)
1.传入简单类型, 比如按照id
查Monster
(前面学过)
2.传入POJO
类型, 查询时需要有多个筛选条件
3.当有多个条件时, 传入的参数就是Pojo
类型的Java
对象, 比如这里的Monster
对象
4.当传入的参数类是String
时, 也可以使用 ${}
来接收参数
●parameterType-应用案例
案例1: 请查询 id = 1
或者 name
= 大象精
的妖怪
案例2: 请查询 name
中包含 “牛魔王” 的妖怪
●代码实现
1.修改MonsterMapper.java
, 增加方法接口
public interface MonsterMapper {
//通过id 或者 名字查询
public List<Monster> findMonsterByNameOrId(Monster monster);
//查询名字中含有牛魔王的妖怪
public List<Monster> findMonsterByName(String name);
}
2.修改MonsterMapper.xml
<mapper namespace="com.zzw.mapper.MonsterMapper">
<!--
1. 配置/实现public List<Monster> findMonsterByNameOrId(Monster monster);
2. 通过id 或者 名字查询
3. `id` = #{id} `id`表示表的字段名 #{id}中的id表示你传入的Monster对象的属性名
-->
<select id="findMonsterByNameOrId" parameterType="Monster" resultType="Monster">
SELECT * FROM `monster` WHERE `id` = #{id} OR `name` = #{name}
</select>
<!--
1. 配置/实现public List<Monster> findMonsterByName(Monster monster);
2. 查询名字中 含有 "牛魔王" 的妖怪 - 模糊查询`
3. 模糊查询的使用 取值需要 ${value} 取值
-->
<select id="findMonsterByName" parameterType="String" resultType="Monster">
SELECT * FROM `monster` WHERE `name` LIKE '%${name}%'
</select>
</mapper>
3.修改MonsterMapperTest.java
, 进行测试
public class MonsterMapperTest {
//属性
private SqlSession sqlSession;
private MonsterMapper monsterMapper;
//编写方法完成初始化
@Before
public void init() {
//获取到sqlSession
sqlSession = MyBatisUtils.getSqlSession();
//获取到MonsterMapper对象 monsterMapper=class com.sun.proxy.$Proxy7 代理对象
//, 底层是使用了动态代理机制, 后面我们自己实现mybatis底层机制时, 会讲到
monsterMapper = sqlSession.getMapper(MonsterMapper.class);
System.out.println("monsterMapper=" + monsterMapper.getClass());
}
@Test
public void findMonsterByNameOrId(){
Monster monster = new Monster();
monster.setId(1);
monster.setName("大象精");
List<Monster> monsters =
monsterMapper.findMonsterByNameOrId(monster);
for (Monster m : monsters) {
System.out.println("m--" + m);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
@Test
public void findMonsterByName() {
List<Monster> monsters = monsterMapper.findMonsterByName("牛魔王");
for (Monster monster : monsters) {
System.out.println("monster--" + monster);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
}
传入HashMap
●传入HashMap
(重点)
1.HashMap
传入参数更加灵活, 比如可以灵活地增加查询的属性, 而不受限于Monster
这个Pojo
属性本身
2.演示如何遍历一个List<Map<String, Object>>
的数据类型
●传入HashMap
- 应用实例1
要求: 声明一个方法, 按传入参数是HashMap
的方式, 查询 id > 10
并且 salary > 40
的所有妖怪
1.修改MonsterMapper.java
, 增加方法接口
//查询 id > 10 并且 salary > 40的所有妖怪
public List<Monster> findMonsterByIdAndSalary_ParameterHashMap(Map<String, Object> map);
2.修改MonsterMapper.xml
<!--
1. 配置/实现public List<Monster> findMonsterByIdAndSalary_ParameterHashMap(Map<String, Objects> map);
2. 查询 id > 10 并且 salary > 40的所有妖怪
3. 如果是以map形式传入参数, 当你这样写条件 `id` > #{id} 表示你的map 中有一个k-v 中 key为id
-->
<select id="findMonsterByIdAndSalary_ParameterHashMap" parameterType="map" resultType="Monster">
SELECT * FROM `monster` WHERE `id` > #{id} AND `salary` > #{salary}
</select>
3.修改MonsterMapperTest.java
, 进行测试
@Test
public void findMonsterByIdAndSalary_ParameterHashMap() {
Map<String, Object> map = new HashMap<>();
map.put("id", 10);
map.put("salary", 40);
List<Monster> monsters =
monsterMapper.findMonsterByIdAndSalary_ParameterHashMap(map);
for (Monster monster : monsters) {
System.out.println("monster--" + monster);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
●传入和返回HashMap
- 应用实例2
要求: 将上面的方法改成返回参数也是HashMap
的类型
1.修改MonsterMapper.java
, 增加方法接口
//查询 id > 10 并且 salary > 40, 要求传入的参数是HashMap
public List<Map<String, Object>>
findMonsterByIdAndSalary_ParameterHashMap_ReturnHashMap(Map<String, Object> map);
2.修改MonsterMapper.xml
<!--
1. 配置/实现public List<Map<String, Object>>
findMonsterByIdAndSalary_ParameterHashMap_ReturnHashMap
2. 查询 id > 10 并且 salary > 40, 要求传入的参数是HashMap
-->
<select id="findMonsterByIdAndSalary_ParameterHashMap_ReturnHashMap" parameterType="map"
resultType="map">
SELECT * FROM `monster` WHERE `id` > #{id} AND `salary` > #{salary}
</select>
3.修改MonsterMapperTest.java
, 进行测试
@Test
public void findMonsterByIdAndSalary_ParameterHashMap_ReturnHashMap() {
Map<String, Object> map = new HashMap<>();
map.put("id", 10);
map.put("salary", 40);
List<Map<String, Object>> maps =
monsterMapper.findMonsterByIdAndSalary_ParameterHashMap_ReturnHashMap(map);
//取出返回的结果-以map的形式取出
//回顾java基础, map遍历
for (Map<String, Object> monsterMap : maps) {
//System.out.println("monsterMap--" + monsterMap);
//遍历monsterMap(方式1), 取出属性和对应值
//Set<String> keySet = monsterMap.keySet();
//for (String key : keySet) {
// Object value = monsterMap.get(key);
// System.out.println(key + "=>" + value);
//}
//遍历monsterMap(方式2), 取出属性和对应值
Set<Map.Entry<String, Object>> entries = monsterMap.entrySet();
for(Map.Entry<String, Object> entry : entries) {
System.out.println(entry.getKey() + "=>" + entry.getValue());
}
System.out.println("==================================");
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
resultMap(结果集映射)
●基本介绍
当实体类的属性和表的字段不一致时, 我们可以通过resultMap
进行映射, 从而屏蔽实体类属性名和表的字段名的不同.
●案例演示
1.创建表user
-- 创建表 user
CREATE TABLE `user` (
`user_id` INT NOT NULL AUTO_INCREMENT,
`user_email` VARCHAR(255) DEFAULT '',
`user_name` VARCHAR(255) DEFAULT '',
PRIMARY KEY (`user_id`)
)CHARSET=utf8
2.创建实体类com.zzw.entity.User
public class User {
private Integer user_id;
private String username;
private String useremail;
//setter, getter, toString方法
}
3.创建com.zzw.mapper.UserMapper.java
public interface UserMapper {
//添加方法
public void addUser(User user);
//查询所有User
public List<User> findAllUser();
}
4.创建com.zzw.mapper.UserMapper.xml
<?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">
<!--解读
1. 这是一个mapper xml 文件
2. 该文件可以去实现对应的接口的方法
3. namespace 指定该xml文件和哪个接口对应!!!
-->
<mapper namespace="com.zzw.mapper.UserMapper">
<!--
1. 配置/实现public void addUser(User user);
2. 完成添加用户的任务,注意这里
-->
<select id="addUser" parameterType="User">
INSERT INTO `user` (`user_email`, `user_name`)
VALUES (#{useremail}, #{username})
</select>
<!--
1.配置/实现public List<User> findAllUser();
2.返回所有User信息
3.按照传统的方式完成, 会出现什么问题?
=> 如果对象属性和表字段相同时, 就会设置值; 如果不同, 就会是默认值
4.我们可以使用resultMap来解决
5.resultMap: 表示我们要定义一个resultMap
6.id="findAllUserMap" type="User" => id 就是程序员指定的resultMap id, 后面通过id可以使用它
7.type="User", 就是你需要返回的对象类型
8.result column="user_name" property="username": column="user_name" 表的字段名, property="username" 对象属性名
9.resultMap="findAllUserMap" 表示使用我们定义的 resultMap, 通过id关联
-->
<resultMap id="findAllUserMap" type="com.zzw.entity.User">
<result column="user_name" property="username"/>
<result column="user_email" property="useremail"/>
</resultMap>
<select id="findAllUser" resultMap="findAllUserMap">
SELECT * FROM `user`
</select>
</mapper>
5.测试com.zzw.mapper.UserMapperTest
public class UserMapperTest {
//属性
private SqlSession sqlSession;
private UserMapper userMapper;
//初始化
@Before
public void init() {
sqlSession = MyBatisUtils.getSqlSession();
userMapper = sqlSession.getMapper(UserMapper.class);
}
@Test
public void addUser() {
User user = new User();
user.setUsername("jack");
user.setUseremail("jack@163.com");
userMapper.addUser(user);
//如果是增删改, 需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("增加成功");
}
@Test
public void findAllUser() {
List<User> users = userMapper.findAllUser();
for (User user : users) {
System.out.println("user--" + user);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
}
●注意事项和细节
1.解析表字段和对象属性名不一致, 也支持使用字段别名
<!--使用表字段别名, 来解决表的字段名和对象属性名, 不一致问题, 可以用, 但是我们仍然推荐使用resultMap-->
<select id="findAllUser" resultType="User">
SELECT user_id, user_name as username, user_email as useremail FROM `user`
</select>
2.说明: 如果是MyBatis-Plus
处理就比较简单, 可以使用 注解TableField
来解决实体字段名和表字段名不一致的问题, 还可以使用@TableName
来解决 实体类名和表名不一致的问题
动态SQL语句-更复杂的查询业务需求
官方文档
文档地址:
https://mybatis.org/mybatis-3/zh_CN/dynamic-sql.html
为什么需要动态SQL
1.动态 SQL
是 MyBatis
的强大特性之一
2.使用 JDBC
或其它类似的框架, 根据不同条件拼接 SQL
语句非常麻烦, 例如拼接时要确保不能忘记添加必要的空格, 还要注意去掉列表最后一个列名的逗号等.
3.SQL
映射语句中的强大的动态 SQL
语句, 可以很好地解决这个问题.
基本介绍
●基本介绍
1.在一个实际的项目中, sql
语句往往是比较复杂的
2.为了满足更加复杂的业务需求, MyBatis
的设计者, 提供了动态生成SQL
的功能
●动态SQL
必要性
1.比如我们查询Monster
时, 如果程序员输入的age
不大于0
, 我们的sql
语句就不带age
2.更新Monster
对象时, 没有设置新的属性值, 就保持原来的值, 设置了新的值, 才更新.
●解决方案
1.从上面的需求我们可以看出, 有时我们在生成sql
语句时, 在同一个方法中, 还要根据不同的情况生成不同的sql
语句.
2.解决方案: MyBatis
提供的动态SQL
机制.
●动态SQL
常用标签
动态SQL
提供了如下几种常用的标签, 类似我们Java
的控制语句:
1.if
[判断]
2.where
[拼接 where
语句]
3.choose / when / otherwise
[类似java
的 switch
语句, 注意是单分支]
4.foreach
[类似 in
]
5.trim
[替换关键字 / 定制元素的功能]
6.set
[在update
的 set
中, 可以保证进入 set
标签的属性被修改, 而没有进入set
的, 保持原来的值]
案例演示
1.在原来的mybatis
项目中, 新建dynamic-sql
子项目 [参考], 演示动态SQL
的使用
2.新建Module
后, 先创建需要的包, 再将需要的文件 / 资源拷贝过来(这里我们拷贝Monster.java
, resources/jdbc.properties
和 mybatis-config.xml
)
3.拷贝MonsterMapper.java
, MonsterMapper.xml
和 MonsterMapperTest.java
, 做一个比较 干净的讲解环境
if标签应用实例
●需求: 请查询age
大于 10
的所有妖怪, 如果程序员输入的age
不大于 0
, 则输出所有的妖怪!
1.修改MonsterMapper.java
, 增加方法接口
public interface MonsterMapper {
//根据age查询结果
public List<Monster> findMonsterByAge(@Param(value = "age") Integer age);
}
2.修改MonsterMapper.xml
<mapper namespace="com.zzw.mapper.MonsterMapper">
<!--
1.配置/实现public List<Monster> findMonsterByAge(@Param(value = "age")Integer age);
2.请查询`age` 大于 `10` 的所有妖怪, 如果程序员输入的`age` 不大于 `0`, 则输出所有的妖怪!
3.如果我们按照以前方式来配置->问题? 如果使用原来的#{age} 在test表达式是取不出入参值
4.解决方案是使用@Param
-->
<select id="findMonsterByAge" parameterType="Integer" resultType="Monster"><!--这里能用简写是因为mybatis-config.xml文件里配置了别名-typeAliases-->
SELECT * FROM `monster` where 1 = 1
<if test="age > 0">
AND `age` > #{age}
</if>
</select>
</mapper>
3.测试MonsterAnnotationTest
@Test
public void findMonsterByAge() {
List<Monster> monsters
= monsterMapper.findMonsterByAge(-1);
for (Monster monster : monsters) {
System.out.println("monster--" + monster);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("操作成功");
}
where标签应用实例
●需求: 请查询id
大于 20
的, 并且名字是 “牛魔王” 的所有妖怪. 注意, 如果名字为空, 或者输入的id
小于 0
, 则不拼接 sql
语句(梳理: 如果名字为空, 就不带名字条件; 如果输入的id
小于 0
, 就不带id
的条件)
1.修改MonsterMapper.java
, 增加方法接口
public interface MonsterMapper {
//根据id和名字来查询结果
public List<Monster> findMonsterByIdAndName(Monster monster);
}
2.修改MonsterMapper.xml
<!--
1.配置/实现public List<Monster> findMonsterByIdAndName(Monster monster);
2.请查询`id` 大于 `20` 的, 并且名字是 "牛魔王" 的所有妖怪.
注意, 如果名字为空, 或者输入的`id`小于 `0`, 则不拼接 `sql`语句
(梳理: 如果名字为空, 就不带名字条件; 如果输入的`id`小于 `0`, 就不带`id`的条件)
3.where + if : WHERE `id` > #{id} AND `name` = #{name};
4.如果我们入参是对象, test表达式中, 直接使用对象的属性名即可
5.where标签, 会在组织动态sql时, 加上where
6.mybatis底层自动地去掉多余的AND
-->
<select id="findMonsterByIdAndName" parameterType="Monster" resultType="Monster">
SELECT * FROM `monster`
<where>
<if test="id >= 0">
AND `id` > #{id}
</if>
<if test="name != null and name != ''">
AND `name` = #{name}
</if>
</where>
</select>
3.测试MonsterAnnotationTest
@Test
public void findMonsterByIdAndName() {
Monster monster = new Monster();
monster.setId(20);
monster.setName("牛魔王");
List<Monster> monsters = monsterMapper.findMonsterByIdAndName(monster);
for (Monster m : monsters) {
System.out.println("m=" + m);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("操作成功");
}
choose/when/otherwise应用实例
●需求:
1) 如果给的name
不为空, 就按名字查询妖怪.
2) 如果指定的id>0
, 就按id
来查询妖怪.
3) 如果前面两个条件都不满足, 就默认查询 salary > 100
的
4) 要求使用 choose/when/otherwise 标签实现, 传入参数要求使用Map
1.修改MonsterMapper.java
, 增加方法接口
public interface MonsterMapper {
//测试choose标签的使用
public List<Monster> findMonsterByIdOrName_choose(Map<String, Object> map);
}
2.修改MonsterMapper.xml
<!--
1.配置/使用public List<Monster> findMonsterByIdOrName_choose(Map<String, Object> map);
2. 1) 如果给的`name`不为空, 就按名字查询妖怪.
2) 如果指定的`id>0`, 就按`id`来查询妖怪.
3) 如果前面两个条件都不满足, 就默认查询 `salary > 100`的
4) 使用mybatis 提供choose-when-otherwise
-->
<select id="findMonsterByIdOrName_choose" parameterType="map" resultType="Monster">
SELECT * FROM `monster`
<choose>
<when test="name != null and name != ''">
WHERE `name` = #{name}
</when>
<when test="id > 0">
WHERE `id` > #{id}
</when>
<otherwise>
WHERE `salary` > 100
</otherwise>
</choose>
</select>
3.测试MonsterAnnotationTest
@Test
public void findMonsterByIdOrName_choose() {
Map<String, Object> map = new HashMap<>();
map.put("id", -1);
//map.put("name", "牛魔王");
List<Monster> monsters = monsterMapper.findMonsterByIdOrName_choose(map);
for (Monster monster : monsters) {
System.out.println("monster--" + monster);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
foreach标签应用实例
●需求: 查询id
为 20, 22, 34
的妖怪
1.修改MonsterMapper.java
, 增加方法接口
public interface MonsterMapper {
//测试foreach标签的使用
public List<Monster> findMonsterById_forEach(Map<String, Object> map);
}
2.修改MonsterMapper.xml
<!--
1.配置/实现public List<Monster> findMonsterById_forEach(Map<String, Object> map);
2.查询`id` 为 `20, 22, 34`的妖怪
3.使用foreach标签
4.入参map 中 会如何传入id值 k-v, ids - [集合, 比如List 10,12,14]
, 即map 入参中应当有 ids-[10,12,14]
-->
<select id="findMonsterById_forEach" resultType="Monster" parameterType="map">
SELECT * FROM `monster`
<!--解读
1. where标签
2. 再写入相应的处理代码, 比如判断ids 是否为空.. if
3. 如果ids不为空, 则使用foreach标签进行遍历
4. collection="ids" 对应你的入参map的 key - ids
5. item="id" 在遍历ids集合时, 每次取出的值, 对应的变量id
6. open="(" 对应的就是sql (10,12,14) 的第一 (
7. separator="," 遍历出来的多个值的 分隔符号
8. close=")" 对应的就是sql (10,12,14) 的最后 )
9. #{id} 对应的就是 item="id"
-->
<if test="ids != null and ids != ''">
<where>
`id` IN
<foreach collection="ids" item="id" open="(" separator="," close=")">
#{id}
</foreach>
</where>
</if>
</select>
3.测试MonsterAnnotationTest
@Test
public void findMonsterById_forEach() {
Map<String, Object> map = new HashMap<>();
//map.put("ids", Arrays.asList(10, 12));
List<Monster> monsters = monsterMapper.findMonsterById_forEach(map);
for (Monster monster : monsters) {
System.out.println("monster--" + monster);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
trim标签应用实例[使用较少]
●trim
可以替换一些关键字. 要求: 按名字和年龄查询妖怪, 如果sql
语句开头有 and | or
就替换成 where
1.修改MonsterMapper.java
, 增加方法接口
public interface MonsterMapper {
//trim标签的使用
public List<Monster> findMonsterByName_Trim(Map<String, Object> map);
}
2.修改MonsterMapper.xml
<!--
1.配置/实现public List<Monster> findMonsterByName_Trim(Map<String, Object> map);
2.按名字和年龄查询妖怪, 如果sql语句开头有 and | or 就替换成 where
3.分析: 如果要实现这个功能, 其实使用where标签 [加入where 同时会去掉多余的and]
4.trim prefix="WHERE" prefixOverrides="and|or|zzw" 如果子句的开头为 "AND" 或 "OR" 或 "zzw"
, 就去除
-->
<select id="findMonsterByName_Trim" parameterType="map" resultType="Monster">
SELECT * FROM `monster`
<trim prefix="WHERE" prefixOverrides="and|or|zzw">
<if test="name != null and name != ''">
and `name` = #{name}
</if>
<if test="age != null and age != ''">
AND `age` > #{age}
</if>
</trim>
</select>
3.测试MonsterAnnotationTest
@Test
public void findMonsterByName_Trim() {
Map<String, Object> map = new HashMap<>();
map.put("age", 30);
map.put("name", "牛魔王");
List<Monster> monsters = monsterMapper.findMonsterByName_Trim(map);
for (Monster monster : monsters) {
System.out.println("monster--" + monster);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("操作成功");
}
set标签应用实例[重点]
●需求: 请对指定id
的妖怪进行 修改, 如果没有设置新的属性, 则保存原来的值
- 先回顾传统的方式是如何处理的? -> 麻烦
- 使用set
标签搞定
1.修改MonsterMapper.java
, 增加方法接口
public interface MonsterMapper {
//测试set标签
public void updateMonster_set(Map<String, Object> map);
}
2.修改MonsterMapper.xml
<!--
1.配置/实现public void updateMonster_set(Map<String, Object> map);
2.请对指定id的妖怪进行 修改, 如果没有设置新的属性, 则保存原来的值
3.入参要根据sql语句来配合 map [age-10, email-'9789@qq.com'...]
4.set标签会处理多余的 ,
-->
<update id="updateMonster_set" parameterType="map">
UPDATE `monster`
<set>
<if test="age != null and age != ''">
`age` = #{age},
</if>
<if test="birthday != null and birthday != ''">
`birthday` = #{birthday},
</if>
<if test="email != null and email != ''">
`email` = #{email},
</if>
<if test="name != null and name != ''">
`name` = #{name},
</if>
<if test="gender != null and gender != ''">
`gender` = #{gender},
</if>
<if test="salary != null and salary != ''">
`salary` = #{salary},
</if>
</set>
WHERE `id` = #{id}
</update>
3.测试MonsterAnnotationTest
@Test
public void updateMonster_set() {
Map<String, Object> map = new HashMap<>();
map.put("id", 5);
//map.put("name", "牛魔王6");
//map.put("age", 18);
//map.put("birthday", "2000-10-15 12:12:12");
monsterMapper.updateMonster_set(map);
//增删改需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("修改成功");
}
课后练习
自己创建个新的项目完成.
● 要求属性
1. 编号- id
2. 外号 -nickname
3. 本领 - skill
4. 排行 - rank
5. 薪水 - salary
6. 入伙日期 - days (要求可以保存 年-月-日 时:分:秒)
● 完成功能
1. 创建表hero
2. 编写方法, 添加hero
记录 [方法就在HeroMapper.xml
配置]
3. 编写方法: 查询rank
大于 10
的所有hero
, 如果输入的rank
不大于 0
, 则输出所有hero
4. 编写方法: 查询rank
为 3, 6, 8
[rank
可变] 的hero
5. 编写方法: 修改hero
信息, 如果没有设置新的属性值, 则保持原来的值
6. 编写方法: 可以根据id
查询hero
, 如果没有传入id
, 就返回所有hero
7. 自己完成, 会有新的体会.
● 环境准备
1.新建hero
表
USE mybatis;
CREATE TABLE `hero` (
`id` INT NOT NULL AUTO_INCREMENT,
`nickname` VARCHAR(255) NOT NULL,
`skill` VARCHAR(255) NOT NULL,
`rank` TINYINT NOT NULL,
`salary` DOUBLE NOT NULL,
`days` TIMESTAMP NOT NULL,
PRIMARY KEY(id)
)CHARSET=utf8
2.在原来的mybatis
项目中, 新建homework-hero
子项目 [参考]
3.新建Module
后, 先创建需要的包, 再将需要的文件 / 资源拷贝过来(这里我们拷贝Hero.java
, resources/jdbc.properties
和 mybatis-config.xml
)
3.拷贝HeroMapper.java
, HeroMapper.xml
和 HeroMapperTest.java
, 做一个比较 干净的讲解环境
● 代码实现
1.com.zzw.entity.Hero.java
@Getter
@Setter
@ToString
public class Hero {
private Integer id;
private String nickname;
private String skill;
private Integer rank;
private Double salary;
private Date days;
}
2.新建com.zzw.mapper.HeroMapper
接口
public interface HeroMapper {
//添加hero记录
public void addHero(Hero hero);
//查询rank大于 10 的所有hero, 如果输入的rank 不大于 0, 则输出所有hero
public List<Hero> findHeroByRank(Map<String, Object> map);
//查询rank 为 3, 6, 8[rank可变] 的hero
public List<Hero> findHeroByRank_choose(Map<String, Object> map);
//修改hero信息, 如果没有设置新的属性值, 则保持原来的值
public void updateHeroById_set(Hero hero);
//可以根据id查询hero, 如果没有传入id, 就返回所有hero
public List<Hero> findHeroById(@Param(value = "id") Integer id);
}
3.新建com.zzw.mapper.HeroMapper.xml
<mapper namespace="com.zzw.mapper.HeroMapper">
<!--
1.配置/实现public void addHero(Hero hero)
2.添加hero记录
-->
<insert id="addHero" parameterType="Hero">
INSERT INTO `hero` (`nickname`, `skill`, `rank`, `salary`, `days`)
VALUES (#{nickname}, #{skill}, #{rank}, #{salary}, #{days});
</insert>
<!--
1.配置/实现public void findHeroByRank(HashMap<String, Object> map);
2.查询rank大于 10 的所有hero, 如果输入的rank 不大于 0, 则输出所有hero
-->
<select id="findHeroByRank" parameterType="map" resultType="Hero">
SELECT * FROM `hero` WHERE 1 = 1
<if test="rank > 0">
AND `rank` > #{rank}
</if>
</select>
<!--
1.配置/实现public List<Hero> findHeroByRank_choose(Map<String, Object> map);
2.查询rank 为 3, 6, 8[rank可变] 的hero
3.入参map k-v key-ranks 值 List - [4, 12, 13]
-->
<select id="findHeroByRank_choose" parameterType="map" resultType="Hero">
SELECT * FROM `hero`
<!--
解读
1.where标签
2.对ranks是否为空做判断
3.如果ranks不为空, 则使用foreach做判断
4.collection="ranks" 对应入参map 的key
5.item="rank" 在遍历ranks集合时, 每次取出的值, 叫做变量rank
6.open="(" 对应的就是sql (4, 12, 13) 第一(
7.separator="," 遍历出来的多个值的 分隔符号
8.close=")" 对应的就是sql (4, 12, 13) 最后)
9.#{rank} 对应的就是 item="rank"
-->
<where>
<if test="ranks != null and ranks != ''">
`rank` IN
<foreach collection="ranks" item="rank" open="(" separator="," close=")">
#{rank}
</foreach>
</if>
</where>
</select>
<!--
1.配置/实现public void updateHeroById_set(Hero hero);
2.修改hero信息, 如果没有设置新的属性值, 则保持原来的值
-->
<update id="updateHeroById_set" parameterType="hero">
UPDATE `hero`
<set>
<if test="nickname != null and nickname != ''">
`nickname` = #{nickname},
</if>
<if test="rank != null and rank != ''">
`rank` = #{rank},
</if>
<if test="skill != null and skill != ''">
`skill` = #{skill},
</if>
<if test="salary != null and salary != ''">
`salary` = #{salary},
</if>
<if test="days != null and days != ''">
`days` = #{days},
</if>
</set>
WHERE id = #{id}
</update>
<!--
1.配置/实现public List<Hero> findHeroById(@Param(value = "id") Integer id);
2.可以根据id查询hero, 如果没有传入id, 就返回所有hero
-->
<select id="findHeroById" parameterType="Integer" resultType="Hero">
SELECT * FROM `hero`
<choose>
<when test="id != null and id != ''">
WHERE `id` = #{id}
</when>
</choose>
</select>
</mapper>
4.测试com.zzw.mapper.HeroMapperTest
public class HeroMapperTest {
//属性
private SqlSession sqlSession;
private HeroMapper heroMapper;
//编写方法完成初始化
@Before
public void init() {
sqlSession = MyBatisUtils.getSqlSession();
heroMapper = sqlSession.getMapper(HeroMapper.class);
System.out.println("heroMapper=" + heroMapper.getClass());
}
@Test
public void addHero() {
Hero hero = new Hero();
hero.setNickname("花和尚");
hero.setSkill("倒拔垂杨柳");
hero.setRank(13);
hero.setSalary(7500.0);
hero.setDays(new Date());
heroMapper.addHero(hero);
//增删改需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("操作成功");
}
@Test
public void findHeroByRank() {
Map<String, Object> map = new HashMap<>();
map.put("rank", 10);
List<Hero> heroes = heroMapper.findHeroByRank(map);
for (Hero hero : heroes) {
System.out.println("hero--" + hero);
}
//关闭连接
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
@Test
public void findHeroByRank_choose() {
Map<String, Object> map = new HashMap<>();
map.put("ranks", Arrays.asList(4, 12, 13));
List<Hero> heroes = heroMapper.findHeroByRank_choose(map);
for (Hero hero : heroes) {
System.out.println("hero--" + hero);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
@Test
public void updateHeroById_set() {
Hero hero = new Hero();
hero.setNickname("豹子头");
hero.setRank(5);
hero.setSalary(120000.0);
hero.setId(4);
heroMapper.updateHeroById_set(hero);
//增删改需要提交事务
if (sqlSession != null) {
sqlSession.commit();
sqlSession.close();
}
System.out.println("操作成功");
}
@Test
public void findHeroById() {
List<Hero> heroes = heroMapper.findHeroById(1);
for (Hero hero : heroes) {
System.out.println("hero--" + hero);
}
if (sqlSession != null) {
sqlSession.close();
}
System.out.println("查询成功");
}
}