Mybatis-Plus 学习笔记Day-01

原创已于 2022-04-05 16:46:02 修改 · 535 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #springboot #mybatis-plus #maven

于 2022-03-28 23:10:28 首次发布

Mybatis-Plus 工具专栏收录该内容

2 篇文章

订阅专栏

本文介绍MyBatis-Plus的特性和基本使用方法，包括快速搭建环境、基本CRUD操作，并通过实例演示如何实现增删改查等功能。

Mybatis-Plus

前言
一、MyBatis-Plus简介
二、快速开始
三、基本CRUD

前言

MyBatis-Plus提供了通用的mapper和service，可以在不编写任何SQL语句的情况下，快速的实现对单表的CRUD、批量、逻辑删除、分页等操作。
官网：https://baomidou.com/pages/24112f/#%E7%89%B9%E6%80%A7

一、MyBatis-Plus简介

1、简介

MyBatis-Plus (简称 MP) 是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。我们的愿景是成为MyBatis 最好的搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍。
在这里插入图片描述

2、特性

1.无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。

2.损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作。

3.强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求。

4.支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错。

5.支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题。

6.支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作。

7.支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）

8.内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用。

9.内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询。

10.分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库。

11.内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询。

12.内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作。

3、框架结构

在这里插入图片描述

二、快速开始

通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能。我们假设您已经：拥有 Java 开发环境以及相应 IDE，熟悉 Spring Boot，熟悉Maven。

1、建库建表

CREATE DATABASE `mybatis_plus`; 
use `mybatis_plus`;

DROP TABLE IF EXISTS t_user;

CREATE TABLE t_user
(
    id BIGINT(20) NOT NULL COMMENT '主键ID',
    name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT(11) NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);

INSERT INTO t_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');

2、创建Spring Boot工程

使用 Spring Initializr 快速初始化一个 Spring Boot 工程
在这里插入图片描述

引入依赖

 <!--mybatis-plus启动器-->
<dependency>
   <groupId>com.baomidou</groupId>
   <artifactId>mybatis-plus-boot-starter</artifactId>
   <version>3.5.1</version>
</dependency>

<!--lombok用于简化实体类开发-->
<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <optional>true</optional>
</dependency>

<!--mysql驱动-->
<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <scope>runtime</scope>
</dependency>

<dependency>
   <groupId>com.baomidou</groupId>
   <artifactId>mybatis-plus-generator</artifactId>
   <version>3.5.1</version>
</dependency>

idea中安装lombok插件

3、编写代码

配置application.yml

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&userSSL=false
    username: root
    password: root
# 输出日志 
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

Spring Boot启动类中添加@MapperScan注解，扫描mapper包

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

编写实体类

/**
 * Author:huang.bx
 * Date:2022/3/12
 */
@Data
public class User {
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

编写 mapper
BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型。

@Repository
public interface UserMapper extends BaseMapper<User> {

}

测试

/**
 * Author:huang.bx
 * Date:2022/3/12
 */
@SpringBootTest
public class MyBatisPlusTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectList(){
        //通过条件构造器查询一个list集合，若没有条件，则可以设置null为参数
        List<User> list = userMapper.selectList(null);
        list.forEach(System.out::println);
    }
}

测试结果
在这里插入图片描述

三、基本CRUD

1、BaseMapper

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用，接口如下：

public interface BaseMapper<T> extends Mapper<T> {
    /**
    * 插入一条记录 
    * @param entity 实体对象 
    */
    int insert(T entity);
    /**
    * 根据 ID 删除
    * @param id 主键ID
    */
    int deleteById(Serializable id);
    /**
    * 根据实体(ID)删除
    * @param entity 实体对象
    */
    int deleteById(T entity);
    /**
    * 根据 columnMap 条件，删除记录
    * @param columnMap 表字段 map 对象
    */
    int deleteByMap(@Param("cm") Map<String, Object> columnMap);
    /**
     * 根据 entity 条件，删除记录
     * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
    */
    int delete(@Param("ew") Wrapper<T> queryWrapper);
    /**
     * 删除（根据ID 批量删除）
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    int deleteBatchIds(@Param("coll") Collection<?> idList);
    /**
    * 根据 ID 修改 
    * @param entity 实体对象 
    */
    int updateById(@Param("et") T entity);
 
    int update(@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper);

    T selectById(Serializable id);

    List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);

    List<T> selectByMap(@Param("cm") Map<String, Object> columnMap);

    default T selectOne(@Param("ew") Wrapper<T> queryWrapper) {
        List<T> ts = this.selectList(queryWrapper);
        if (CollectionUtils.isNotEmpty(ts)) {
            if (ts.size() != 1) {
                throw ExceptionUtils.mpe("One record is expected, but the query result is multiple records", new Object[0]);
            } else {
                return ts.get(0);
            }
        } else {
            return null;
        }
    }

    default boolean exists(Wrapper<T> queryWrapper) {
        Long count = this.selectCount(queryWrapper);
        return null != count && count > 0L;
    }

    Long selectCount(@Param("ew") Wrapper<T> queryWrapper);

    List<T> selectList(@Param("ew") Wrapper<T> queryWrapper);

    List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> queryWrapper);

    List<Object> selectObjs(@Param("ew") Wrapper<T> queryWrapper);

    <P extends IPage<T>> P selectPage(P page, @Param("ew") Wrapper<T> queryWrapper);

    <P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param("ew") Wrapper<T> queryWrapper);
}

2、插入

@Test
public void testInsert(){
    User user = new User();
    user.setName("张三");
    user.setAge(23);
    user.setEmail("zhangsan@atguigu.com");
    int result = userMapper.insert(user);
    System.out.println("result:"+result);
    System.out.println("id:"+user.getId());
}

测试结果
在这里插入图片描述

3、删除

@Test
public void testDelete(){
   //通过id删除用户信息
   //DELETE FROM t_user WHERE id=?
   int result = userMapper.deleteById(7);
   System.out.println("result:"+result);
}

测试结果
在这里插入图片描述

@Test
public void testDelete(){
   //根据map集合中所设置的条件删除用户信息
   //DELETE FROM t_user WHERE name = ? AND age = ?
   Map<String, Object> map = new HashMap<>();
   map.put("name", "张三");
   map.put("age", 23);
   int result = userMapper.deleteByMap(map);
   System.out.println("result:"+result);
}

测试结果
在这里插入图片描述

@Test
public void testDelete(){
   //通过多个id实现批量删除
   //DELETE FROM t_user WHERE id IN ( ? , ? , ? )
   List<Long> list = Arrays.asList(1L, 2L, 3L);
   int result = userMapper.deleteBatchIds(list);
   System.out.println("result:"+result);
}

测试结果
在这里插入图片描述

4、修改

@Test
public void testUpdate(){
   //修改用户信息
   //UPDATE t_user SET name=?, email=? WHERE id=?
   User user = new User();
   user.setId(4L);
   user.setName("李四");
   user.setEmail("lisi@atguigu.com");
   int result = userMapper.updateById(user);
   System.out.println("result:"+result);
}

修改前的表数据
在这里插入图片描述
修改后

5、查询

@Test
public void testSelect(){
  //通过id查询用户信息
  //SELECT id,name,age,email FROM t_user WHERE id=?
  User user = userMapper.selectById(1L);
  System.out.println(user);
}

测试结果
在这里插入图片描述

@Test
public void testSelect(){
  //根据多个id查询多个用户信息
  //SELECT id,name,age,email FROM t_user WHERE id IN ( ? , ? , ? )
  List<Long> list = Arrays.asList(1L, 2L, 3L);
  List<User> users = userMapper.selectBatchIds(list);
  users.forEach(System.out::println);
}

测试结果
在这里插入图片描述

@Test
public void testSelect(){
  //根据map集合中的条件查询用户信息
  //SELECT id,name,age,email FROM t_user WHERE name = ? AND age = ?
  Map<String, Object> map = new HashMap<>();
  map.put("name", "杜兰特");
  map.put("age", 33);
  List<User> users = userMapper.selectByMap(map);
  users.forEach(System.out::println);
}

测试结果
在这里插入图片描述

@Test
public void testSelect(){
  //查询所有数据
  //SELECT id,name,age,email FROM t_user
  List<User> users = userMapper.selectList(null);
  users.forEach(System.out::println);
  /*Map<String, Object> map = userMapper.selectMapById(1L);
  System.out.println(map);*/
}

测试结果
在这里插入图片描述