二八佳人体似酥,腰间仗剑斩愚夫。虽然不见人头落,暗里教君骨髓枯。
上一章简单介绍了SpringBoot整合JPA(六),如果没有看过,请观看上一章
除了JPA之外,实际开发中,也常常使用 MyBatis. 这一章节,讲解一下整合Mybatis的使用。
关于 MyBatis的相关知识,可以看老蝴蝶以前写的MyBatis系列文章
一. SpringBoot 整合 MyBatis 前期准备
按照老蝴蝶以前讲解的方式,采用Maven 构建SpringBoot项目。
一.一 pom.xml 添加依赖
<!--引入MySql的驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--引入springboot与mybatis整合的依赖-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
</dependency>
<!-- 引入pagehelper分页插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.5</version>
</dependency>
一.二 application.yml 添加JPA的配置
# 引入 数据库的相关配置
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/springboot?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowMultiQueries=true
username: root
password: abc123
#整合mybatis时使用的
mybatis:
#包别名
type-aliases-package: top.yueshushu.learn.pojo
#映射文件路径
mapper-locations: classpath:mybatis/mapper/**/*.xml
configuration:
#日志信息
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
注意,
- 数据库的连接信息 url 后面添加了一个 allowMultiQueries=true (允许多条语句执行)
- 在 resources 目录下,需要创建 mybatis/mapper 目录,放置相关的 XxxMapper.xml 文件。
一.三 创建 User 表
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(15) DEFAULT NULL,
`sex` varchar(20) DEFAULT NULL,
`age` int(6) DEFAULT NULL,
`description` varchar(50) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=18 DEFAULT CHARSET=utf8;
不采用Mybatis自动生成代码,只演示一些基本的操作。
二. 代码准备
二.一 pojo包下创建 User.java 类
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User implements Serializable {
/**
* @param id id编号
* @param name 姓名
* @param sex 性别
* @param age 年龄
* @param description 描述
*/
private Integer id;
private String name;
private String sex;
private Integer age;
private String description;
}
二.二 mapper包下创建 UserMapper 接口
resources/mybatis/mapper目录下创建相应的XML映射文件
@Mapper
public interface UserMapper {
}
注意,需要添加 @Mapper的注解(SpringBoot启动类,就不用加@MapperScan 扫描了)。
<?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="top.yueshushu.learn.mapper.UserMapper">
</mapper>
二.三 service包下创建相应的接口和实现类
二.三.一 UserService 接口
public interface UserService {
}
二.三.二 UserServiceImpl 实现类
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserMapper userMapper;
}
二.四 测试类 MyBatisTests
放置在 test目录下的 top.yueshushu.learn 包下
@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
@Log4j2
public class MyBatisTests {
@Autowired
private UserService userService;
}
三. 整合MyBatis方法
ServiceImpl 层,除分页之外,均是一层调用,老蝴蝶为了减少篇幅,故省略 UserServiceImpl 层的代码,具体可看最后的Github链接.
所用的例子,也与 JPA时基本一样。
三.一 添加方法
三.一.一 测试类
@Test
public void insertTest(){
//1. 构建对象
User user=new User();
user.setName("欢欢");
user.setAge(22);
user.setSex("女");
user.setDescription("一个非常可爱的女孩纸");
//2. 添加方法
userService.addUser(user);
log.info("添加成功,{}",user);
}
三.一.二 Mapper接口及其相关XML文件实现
UserMapper接口
void addUser(@Param("user") User user);
UserMapper.xml 实现
<insert id="addUser">
insert into user(name,sex,age,description) values(
#{user.name},#{user.sex},#{user.age},#{user.description}
)
</insert>
三.一.三 验证
数据库中也正常的插入了数据。(后面,数据库的结果数据,除特别案例之外,老蝴蝶均不再贴出。)
三.二 修改方法
三.二.一 测试类
@Test
public void updateTest(){
//1. 构建对象
User user=new User();
user.setId(1); //id不存在,会添加
user.setName("欢欢");
user.setDescription("岳泽霖最好的朋友");
//2. 修改方法
userService.updateUser(user);
log.info("修改成功,{}",user);
}
三.二.二 Mapper接口及其相关XML文件实现
UserMapper接口
void updateUser(@Param("user") User user);
UserMapper.xml 实现
<update id="updateUser">
update user set name=#{user.name},sex=#{user.sex},
age=#{user.age},description=#{user.description}
where id=#{user.id}
</update>
三.二.三 验证
三.三 删除方法
三.三.一 测试类
@Test
public void deleteTest(){
userService.deleteUser(1);
}
三.三.二 Mapper接口及其相关XML文件实现
UserMapper接口
void deleteById(@Param("id") int id);
UserMapper.xml 实现
<delete id="deleteById">
delete from user where id=#{id}
</delete>
三.三.三 验证
三.四 有则修改,没有则添加
三.四.一 测试类
@Test
public void saveTest(){
//1. 构建对象
User user=new User();
user.setId(2);
user.setName("欢欢A");
user.setDescription("岳泽霖最好的朋友");
//2. 修改方法
userService.saveUser(user);
log.info("添加或者修改成功,{}",user);
}
三.四.二 Mapper接口及其相关XML文件实现
UserMapper接口
void saveUser(@Param("user") User user);
UserMapper.xml 实现
<update id="saveUser">
insert into user(
<if test="user.id!=null">
id,
</if>
name,sex,age,description)
values(
<if test="user.id!=null">
#{user.id},
</if>
#{user.name},#{user.sex},#{user.age},#{user.description}
)
on duplicate key update
name=#{user.name},sex=#{user.sex},
age=#{user.age},description=#{user.description}
</update>
使用 on duplicate key update 进行修改。
插入时,要将 id字段也放置进去。
三.四.三 验证
当没有id属性时,或者id属性不存在时,就添加 Updates为1
数据库里面,会有此 id=2的数据。 手动修改数据库,填充 sex=男,age=25,name改成 ZH
再次运行,就变成了修改。 Updates为2
三.五 批量添加测试
三.五.一 测试类
@Test
public void batchAddTest(){
//1. 构建对象
User user=new User();
user.setName("小欢欢");
user.setAge(22);
user.setSex("女");
user.setDescription("一个小坏蛋");
User user1=new User();
user1.setName("小泽霖");
user1.setAge(25);
user1.setSex("男");
user1.setDescription("一个大坏蛋");
//这是修改的操作,id=2已经存在这条记录了。
User user2=new User();
user2.setName("岳泽霖");
user2.setAge(25);
user2.setSex("男性");
user2.setDescription("一个快乐的程序员");
//2. 放置到集合里面
List<User> userList=new ArrayList<>();
userList.add(user);
userList.add(user1);
userList.add(user2);
userService.batchAddUser(userList);
}
三.五.二 Mapper接口及其相关XML文件实现
UserMapper接口
void batchAdd(@Param("userList") List<User> userList);
UserMapper.xml 实现
<insert id="batchAdd">
insert into user(name,sex,age,description) values
<foreach collection="userList" item="user" open="" close="" separator=",">
(#{user.name},#{user.sex},#{user.age},#{user.description})
</foreach>
</insert>
三.五.三 验证
三.六 批量修改测试
三.六.一 测试类
@Test
public void batchUpdateTest(){
//1. 构建对象
User user=new User();
user.setId(2);
user.setName("小欢欢A");
user.setAge(22);
user.setSex("女");
user.setDescription("一个小坏蛋");
User user1=new User();
user1.setId(3);
user1.setName("小泽霖A");
user1.setAge(25);
user1.setSex("男");
user1.setDescription("一个大坏蛋");
//
User user2=new User();
user2.setId(4);
user2.setName("岳泽霖A");
user2.setAge(25);
user2.setSex("男性");
user2.setDescription("一个快乐的程序员");
//2. 放置到集合里面
List<User> userList=new ArrayList<>();
userList.add(user);
userList.add(user1);
userList.add(user2);
userService.batchUpdateUser(userList);
}
三.六.二 Mapper接口及其相关XML文件实现
UserMapper接口
void batchUpdate(@Param("userList") List<User> userList);
UserMapper.xml 实现
<update id="batchUpdate">
<foreach collection="userList" item="user" open="" close="" separator=";">
update user set name=#{user.name},sex=#{user.sex},
age=#{user.age},description=#{user.description}
where id=#{user.id}
</foreach>
</update>
三.六.三 验证
如果执行失败,看 application.yml 配置文件里面 datasource的url部分,是否添加了参数 allowMultiQueries=true ,如果没有,需要添加上.
三.七 批量删除测试
三.七.一 测试类
@Test
public void batchDeleteTest(){
List<Integer> ids= Arrays.asList(3,4,6);
userService.batchDeleteByIds(ids);
}
三.七.二 Mapper接口及其相关XML文件实现
UserMapper接口
void batchDeleteByIds(@Param("ids") List<Integer> ids);
UserMapper.xml 实现
<delete id="batchDeleteByIds">
delete from user where id in
<foreach collection="ids" item="id" open="(" close=")" separator=",">
#{id}
</foreach>
</delete>
三.七.三 验证
三.八 根据id查询测试
三.八.一 测试类
@Test
public void findByIdTest(){
User user=userService.findById(2);
log.info(user);
}
三.八.二 Mapper接口及其相关XML文件实现
UserMapper接口
User findById(@Param("id") int id);
UserMapper.xml 实现
<select id="findById" resultType="top.yueshushu.learn.pojo.User">
select * from user where id=#{id}
</select>
三.八.三 验证
三.九 查询全部测试
三.九.一 测试类
@Test
public void findAllTest(){
List<User> userList=userService.findAll();
userList.forEach(n->log.info(n));
}
三.九.二 Mapper接口及其相关XML文件实现
UserMapper接口
List<User> findAll();
UserMapper.xml 实现
<select id="findAll" resultType="top.yueshushu.learn.pojo.User">
select * from user
</select>
三.九.三 验证
三.十 根据id集合部分查询测试
三.十.一 测试类
@Test
public void findByIdsTest(){
List<Integer> ids= Arrays.asList(2,4,6);
List<User> userList=userService.findAllByIds(ids);
userList.forEach(n->log.info(n));
}
三.十.二 Mapper接口及其相关XML文件实现
UserMapper接口
List<User> findAllByIds(@Param("ids") List<Integer> ids);
UserMapper.xml 实现
<select id="findAllByIds" resultType="top.yueshushu.learn.pojo.User">
select * from user where id in
<foreach collection="ids" item="id" open="(" close=")" separator=",">
#{id}
</foreach>
</select>
三.十.三 验证
三.十一 查询总条数,返回单个值测试
三.十一.一 测试类
@Test
public void countTest(){
Long count=userService.count();
log.info("总数目{}",count);
}
三.十一.二 Mapper接口及其相关XML文件实现
UserMapper接口
Long count();
UserMapper.xml 实现
<select id="count" resultType="java.lang.Long">
select count(*) from user
</select>
三.十一.三 验证
三.十二 条件动态查询测试
三.十二.一 测试类
@Test
public void nameAndSexAndDescTest(){
User user=new User();
user.setName("小欢欢A");
user.setSex("女");
user.setAge(27);
user.setDescription("小坏蛋");
List<User> userList=userService.findByNameSexAndDesc(user);
userList.forEach(n->log.info(n));
}
三.十二.二 Mapper接口及其相关XML文件实现
UserMapper接口
List<User> findByNameSexAndDesc(@Param("user") User user);
UserMapper.xml 实现
<select id="findByNameSexAndDesc" resultType="top.yueshushu.learn.pojo.User">
select * from user where 1=1
<if test="user.name != null and user.name != ''">
and name=#{user.name}
</if>
<if test="user.sex != null and user.sex != ''">
and sex=#{user.sex}
</if>
<if test="user.age != null">
and age <#{user.age}
</if>
<if test="user.description != null and user.description != ''">
and description like concat('%',#{user.description},'%')
</if>
<if test="user.id != null">
and id=#{user.id}
</if>
</select>
其实就是 MyBatis的动态SQL的用法。
三.十二.三 验证
三.十三 分页查询测试
执行两次 batchAddTest() 方法,多添加几条记录。
三.十三.一 测试类
@Test
public void pageTest(){
Integer pageNumber=2;
Integer pageSize=3;
PageInfo pageInfo=userService.pageUser(pageNumber,pageSize);
log.info("总数:"+pageInfo.getTotal());
List<User> userList=pageInfo.getList();
userList.forEach(n->log.info(n));
}
三.十三.二 UserServiceImpl的实现
@Override
public PageInfo pageUser(Integer pageNumber, Integer pageSize) {
//开启分页
PageHelper.startPage(pageNumber,pageSize);
//正常的查询
List<User> userList=userMapper.findAll();
//将结果转换成PageInfo对象。
PageInfo pageInfo=new PageInfo(userList);
return pageInfo;
}
调用的 findAll()方法,不需要写任何关于分页的操作。
三.十三.三 验证
分页成功。
这就是SpringBoot整合MyBatis的一些基本的用法。
本章节的代码放置在 github 上:
https://github.com/yuejianli/springboot/tree/develop/MyBatis
谢谢您的观看,如果喜欢,请关注我,再次感谢 !!!