栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Mybaties-Plus【SpringBoot版】看着一篇章就够啦。

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Mybaties-Plus【SpringBoot版】看着一篇章就够啦。

文章目录
  • 一、MyBatis-Plus简介
  • 二、基本的简单认识
    • 1)、简单环境搭建
    • 2)、基本CRUD
    • 3)、通用Service
  • 三、常见的注解
    • 1)、@TableName
    • 2)、@TableId
    • 3)、@TableField
    • 4)、@TableLogic
  • 四、条件构造器和常用接口
    • 1)、条件构造器体系的基本了解
    • 2)、QueryWrapper
    • 3)、UpdateWrapper
    • 4)、Condition
    • 5)、LambdaQueryWrapper
    • 6)、LambdaUpdateWrapper
  • 五、插件
    • 1)、分页插件
    • 2)、乐观锁
    • 2)、创建通用枚举类型
  • 六、代码生成器
  • 七、多数据源
  • 八、MyabtiesX插件

一、MyBatis-Plus简介

1、简介
MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为 简化开发、提高效率而生


2、特性
● 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
● 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
● 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
● 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由 配置,完美解决主键问题
● 支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强 大的 CRUD 操作
支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
● 内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
● 内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等 同于普通 List 查询
● 分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、 Postgre、SQLServer 等多种数据库
● 内置性能分析插件:可输出 SQL 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出 慢查询


3、支持数据库
任何能使用MyBatis进行 CRUD, 并且支持标准 SQL 的数据库,具体支持情况如下
● MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss , ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb
● 达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据 库,瀚高数据库


4、代码及文档地址

  • 官方地址:http://mp.baomidou.com

  • 代码发布地址:

  • Github: https://github.com/baomidou/mybatis-plus

  • Gitee: https://gitee.com/baomidou/mybatis-plus

  • 文档发布地址:https://baomidou.com/pages/24112f

二、基本的简单认识 1)、简单环境搭建

1、开发环境

  • IDE:idea 2019.2
  • JDK:JDK8+
  • 构建工具:maven 3.5.4
  • MySQL版本:MySQL 5.7
  • Spring Boot:2.6.3
  • MyBatis-Plus:3.5.1

2、创建数据库和表

## 创建数据库
CREATE DATABASE `mybatis_plus` ;
##进入数据库
use `mybatis_plus`;
## 创建表
CREATE TABLE `user`
(
   `id`    bigint(20) NOT NULL COMMENT '主键ID',
   `name`  varchar(30) DEFAULT NULL COMMENT '姓名',
   `age`   int(11)     DEFAULT NULL COMMENT '年龄',
   `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
   PRIMARY KEY (`id`)
) ENGINE = InnoDB
 DEFAULT CHARSET = utf8;

添加数据

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

3、添加依赖


    
        org.springframework.boot
        spring-boot-starter
    
    
        org.springframework.boot
  spring-boot-starter-test
        test
    
    
        com.baomidou
        mybatis-plus-boot-starter
        3.5.1
    
    
        org.projectlombok
        lombok
        true
    
    
        mysql
        mysql-connector-java
        runtime
    


4.配置application.yml

配置application.yml

  1. 驱动类易错说明
  • spring boot 2.0(内置jdbc5驱动),驱动类使用 : driver-class-name: com.mysql.jdbc.Driver
  • Spring boot 2.1及以上(内置jdbc8驱动),驱动类使用: driver-class-name: com.mysql.cj.jdbc.Driver
  1. 连接地址url
  • MySQL5.7版本的url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false

  • MySQL8.0版本的url: jdbc:mysql://localhost:3306/mybatis_plus?
    serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false

否则运行测试用例报告如下错误:
java.sql.SQLException: The server time zone value ‘ÖÐ1ú±ê×1⁄4ʱ1⁄4ä’ is unrecognized or represents more

    spring:
# 配置数据源信息 datasource:
# 配置数据源类型
type: com.zaxxer.hikari.HikariDataSource
# 配置连接数据库信息
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-
8&useSSL=false
username: root
    password: 123456
##配置MyBatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

6、 启动类

@SpringBootApplication
@MapperScan("com.atguigu.mybatisplus.mapper")
public class MybatisplusApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisplusApplication.class, args);
} }

7、 添加实体

@Data //lombok注解
 public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

8、添加Mapper

public interface UserMapper extends BaseMapper {
}

9、测试

@SpringBootTest
public class MybatisPlusTest {
    @Autowired
    private UserMapper userMapper;
@Test
public void testSelectList(){ 
	//selectList()根据MP内置的条件构造器查询一个list集合,null表示没有条件,即查询所有 userMapper.selectList(null).forEach(System.out::println);
 } 


2)、基本CRUD

1. 插入

最终执行的结果,所获取的id为1475754982694199298 ,这是因为MyBatis-Plus在实现插入数据时,会默认基于雪花算法的策略生成id

@Test
public void testInsert(){
	User user = new User(null, "张三", 23, "zhangsan@atguigu.com"); 
	//INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? ) 
	int result = userMapper.insert(user); 
	System.out.println("受影响行数:"+result);
	//1475754982694199298 
	System.out.println("id自动获取:"+user.getId());
}

2.删除

2.1 通过id删除记录

 @Test
public void testDeleteById(){
	//通过id删除用户信息
	//DELETE FROM user WHERe id=?
	int result = userMapper.deleteById(1475754982694199298L); 
	 System.out.println("受影响行数:"+result);
}

2.2 通过id批量删除记录

@Test
public void testDeleteBatchIds(){ 
    //通过多个id批量删除
	//DELETE FROM user WHERe id IN ( ? , ? , ? ) 
	List idList = Arrays.asList(1L, 2L, 3L); 
	int result = userMapper.deleteBatchIds(idList); 
	System.out.println("受影响行数:"+result);
}

2.3 通过map条件删除记录

@Test
public void testDeleteByMap(){ 
	//根据map集合中所设置的条件删除记录
	//DELETE FROM user WHERe name = ? AND age = ? 
	Map map = new HashMap<>(); 
	map.put("age", 23);
	map.put("name", "张三");
	int result = userMapper.deleteByMap(map); 
	System.out.println("受影响行数:"+result);
}

3. 修改

Test
public void testUpdateById(){
	User user = new User(4L, "admin", 22, null); 
	//UPDATE user SET name=?, age=? WHERe id=? 
	int result = userMapper.updateById(user); 
	System.out.println("受影响行数:"+result);
}

4. 查询

通过观察BaseMapper中的方法,大多方法中都有Wrapper类型的形参,此为条件构造器,可针
对于SQL语句设置不同的条件,若没有条件,则可以为该形参赋值null,即查询(删除/修改)所 有数据

4.1 通过id查询信息

@Test
public void testSelectById(){
	//根据id查询用户信息
	//SELECT id,name,age,email FROM user WHERe id=? 
	User user = userMapper.selectById(4L);
    System.out.println(user);
}

4.2 通过多个id查询多个信息

@Test
public void testSelectBatchIds(){
	//根据多个id查询多个用户信息
	//SELECT id,name,age,email FROM user WHERe id IN ( ? , ? ) 
	List idList = Arrays.asList(4L, 5L);
	List list = userMapper.selectBatchIds(idList)
	list.forEach(System.out::println);
}

4.3 通过map条件查询用户信息

@Test
public void testSelectByMap(){
	//通过map条件查询用户信息
	//SELECT id,name,age,email FROM user WHERe name = ? AND age = ? 
	Map map = new HashMap<>();
	map.put("age", 22);
	map.put("name", "admin");
	List list = userMapper.selectByMap(map);    list.forEach(System.out::println);
}

4.4 查询所有信息

@Test
public void testSelectList(){ //查询所有用户信息
    //SELECT id,name,age,email FROM user
    List list = userMapper.selectList(null);
    list.forEach(System.out::println);
}
3)、通用Service

● MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl,封装了常见的业务层逻辑

3.1 创建Service接口和实现类

public interface UserService extends IService{

}
@Service
public class UserServiceImpl extends ServiceImpl implements UserService {
	
}

3.2 测试

@Autowired
private UserService userService;

@Test
public void testGetCount(){
	long count = userService.count(); System.out.println("总记录数:" + count);
}
@Test
public void testSaveBatch(){
// SQL长度有限制,海量数据插入单条SQL无法实行,
// 因此MP将批量插入放在了通用Service中实现,而不是通用Mapper ArrayList users = new ArrayList<>();
for (int i = 0; i < 5; i++) {
        User user = new User();
        user.setName("ybc" + i);
        user.setAge(20 + i);
        users.add(user);
}
    //SQL:INSERT INTO t_user ( username, age ) VALUES ( ?, ? )
    userService.saveBatch(users);
}
三、常见的注解 1)、@TableName

在实体类类型上添加@TableName(“t_user”),标识实体类对应的表,即可成功执行SQL语句


当然我们也可以通过yml的全局配置文件进行,全局映射

mybatis-plus:
 configuration:
 # 配置MyBatis日志
 log-impl:  org.apache.ibatis.logging.stdout.StdOutImpl
 global-config:
 db-config:
 # 配置MyBatis-Plus操作表的默认前缀 
 table-prefix: t_

2)、@TableId

经过以上的测试,MyBatis-Plus在实现CRUD时,会默认将id作为主键列,并在插入数据时,默认 基于雪花算法的策略生成id
若实体类和表中表示主键的不是id,而是其他字段,例如uid,MyBatis-Plus会自动识别uid为主 键列吗?
我们实体类中的属性id改为uid,将表中的字段id也改为uid,测试添加功能 程序抛出异常,Field ‘uid’ doesn’t
have a default value,说明MyBatis-Plus没有将uid作为主键 赋值



3)、@TableField


4)、@TableLogic

四、条件构造器和常用接口 1)、条件构造器体系的基本了解

2)、QueryWrapper

例1:组装查询条件

@Test
public void test01(){ //查询用户名包含a,年龄在20到30之间,并且邮箱不为null的用户信息
//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERe
//is_deleted=0 AND (username LIKE ? AND age BETWEEN ? AND ? AND email IS NOT NULL)
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.like("username", "a")
            .between("age", 20, 30)
            .isNotNull("email");
    List list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

例2:组装排序条件

@Test
public void test02(){
//按年龄降序查询用户,如果年龄相同则按id升序排列
//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERe
is_deleted=0 ORDER BY age DESC,id ASC
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper
            .orderByDesc("age")
            .orderByAsc("id");
    List users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

例3:组装删除条件

@Test
public void test03(){
	//删除email为空的用户
	//DELETE FROM t_user WHERe (email IS NULL) 
	QueryWrapper queryWrapper = new QueryWrapper<>(); queryWrapper.isNull("email"); //条件构造器也可以构建删除语句的条件
	int result = userMapper.delete(queryWrapper); System.out.println("受影响的行数:" + result);
}

例4:条件的优先级

方法一:

函数之前的拼接默认都是and拼接的,且他们是一体的

@Test
public void test04() {
QueryWrapper queryWrapper = new QueryWrapper<>(); //将(年龄大于20并且用户名中包含有a)或邮箱为null的用户信息修改
//UPDATE t_user SET age=?, email=? WHERe (username LIKE ? AND age > ? OR
//email IS NULL
    queryWrapper
            .like("username", "a")
            .gt("age", 20)
            .or()
            .isNull("email");
User user = new User();
user.setAge(18); user.setEmail("user@atguigu.com");
int result = userMapper.update(user, queryWrapper); System.out.println("受影响的行数:" + result);
}

方法二:

可以利用and方法,将绑定的关系,整合在一起

@Test
public void test04() {
QueryWrapper queryWrapper = new QueryWrapper<>();
 //将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
//UPDATE t_user SET age=?, email=? WHERe (username LIKE ? AND (age > ? OR
//email IS NULL)) 
//lambda表达式内的逻辑优先运算 
queryWrapper .like("username", "a")
            .and(i -> i.gt("age", 20).or().isNull("email"));
              User user = new User();
user.setAge(18); user.setEmail("user@atguigu.com");
int result = userMapper.update(user, queryWrapper); 
System.out.println("受影响的行数:" + result);

例5:只查询出来固定的几个属性

@Test
public void test05() {
//查询用户信息的username和age字段
//SELECT username,age FROM t_user
QueryWrapper queryWrapper = new QueryWrapper<>(); 
queryWrapper.select("username", "age"); 
//selectMaps()返回Map集合列表,通常配合select()使用,避免User对象中没有被查询到的列值
// 为null
List> maps = userMapper.selectMaps(queryWrapper); maps.forEach(System.out::println);
}

例6:实现子查询

@Test
public void test06() {
//查询id小于等于3的用户信息
//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERe (id IN (select id from t_user where id <= 3))
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.inSql("id", "select id from t_user where id <= 3");
    List list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

3)、UpdateWrapper
@Test
public void test07() { 
//将(年龄大于20或邮箱为null)并且用户名中包含有a的用户信息修改 
//组装set子句以及修改条件
UpdateWrapper updateWrapper = new UpdateWrapper<>(); 
//lambda表达式内的逻辑优先运算
updateWrapper
        .set("age", 18)
        .set("email", "user@atguigu.com")
        .like("username", "a")
        .and(i -> i.gt("age", 20).or().isNull("email"));
//这里必须要创建User对象,否则无法应用自动填充。如果没有自动填充,可以设置为null
    //UPDATE t_user SET username=?, age=?,email=? WHERe (username LIKE ? AND
//(age > ? OR email IS NULL))
//User user = new User(); //user.setName("张三");
//int result = userMapper.update(user, updateWrapper);
    //UPDATE t_user SET age=?,email=? WHERe (username LIKE ? AND (age > ? ORemail IS NULL))
    int result = userMapper.update(null, updateWrapper);
    System.out.println(result);
}

4)、Condition

在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因 此我们在组装这些条件时,必须先判断用户是否选择了这些条件,若选择则需要组装该条件,若 没有选择则一定不能组装,以免影响SQL执行的结果

@Test
public void test08UseCondition() {
//定义查询条件,有可能为null(用户未输入或未选择)
String username = null;
Integer ageBegin = 10;
Integer ageEnd = 24;
QueryWrapper queryWrapper = new QueryWrapper<>(); 
//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
         queryWrapper
        .like(StringUtils.isNotBlank(username), "username", "a")  
        .ge(ageBegin != null, "age", ageBegin)
        .le(ageEnd != null, "age", ageEnd);
    //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERe (age >=
? AND age <= ?)
    List users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

5)、LambdaQueryWrapper

利用函数式接口,防止字段名写错

@Test
public void test09() {
//定义查询条件,有可能为null(用户未输入)
String username = "a";
Integer ageBegin = 10;
Integer ageEnd = 24;
LambdaQueryWrapper queryWrapper = new LambdaQueryWrapper<>(); //避免使用字符串表示字段,防止运行时错误
queryWrapper
            .like(StringUtils.isNotBlank(username), User::getName, username)
            .ge(ageBegin != null, User::getAge, ageBegin)
            .le(ageEnd != null, User::getAge, ageEnd);
    List users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

6)、LambdaUpdateWrapper
@Test
public void test10() { //组装set子句
    LambdaUpdateWrapper updateWrapper = new LambdaUpdateWrapper<>();
    updateWrapper
        .set(User::getAge, 18)
        .set(User::getEmail, "user@atguigu.com")
        .like(User::getName, "a")
        .and(i -> i.lt(User::getAge, 24).or().isNull(User::getEmail)); //lambda
表达式内的逻辑优先运算
User user = new User();
int result = userMapper.update(user, updateWrapper); System.out.println("受影响的行数:" + result);

五、插件 1)、分页插件

MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能

情况1 : 利用代码拼接的SQL

@Configuration
@MapperScan("com.atguigu.mybatisplus.mapper") //可以将主类中的注解移到此处 public class MybatisPlusConfig {
@Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new
PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
} }

测试

@Test
public void testPage(){ 
//设置分页参数
Page page = new Page<>(1, 5); 
userMapper.selectPage(page, null);
//获取分页数据
  List list = page.getRecords();
  list.forEach(System.out::println); 
  System.out.println("当前页:"+page.getCurrent());
  System.out.println("每页显示的条数:"+page.getSize());
   System.out.println("总记录数:"+page.getTotal()); System.out.println("总页数:"+page.getPages()); 
  System.out.println("是否有上一页:"+page.hasPrevious()); 
  System.out.println("是否有下一页:"+page.hasNext());
}

情况2、 xml自定义写的分页SQL

Page selectPageVo(@Param("page") Page page, @Param("age") Integer age);

id,username,age,email