Mybatis-Plus详解

目录

一、Mybatis-Plus简介

（一）什么是Mybatis-Plus

（二）Mybatis-Plus的优势

（三）Mybatis-Plus的框架结构

二、SpringBoot整合Mybatis-Plus入门

（一）创建maven工程，添加依赖

（二）创建数据库表employee

（三）构建数据模型Employee

（四）配置application.yml

（五）编写SpringBoot启动类

（六）编写mapper接口

（七）启动服务测试结果

三、Lombok插件

（一）Lombok插件简介

（二）常用的Lombok注解介绍

（三）idea安装Lombok插件

（四）Lombok插件的使用

1、引入依赖

2、去除Employee类中的setter和getter方法

3、在Employee类上添加Lombok注解

四、CRUD

（一）BaseMapper接口方法介绍

（二）Insert方法

（三）@TableId注解

（四）@TableName注解

（五）@TableField注解

（六）插入数据获取主键值

（七）更新数据的通用方法

1、updateById方法

2、update(entity，wrapper)方法

（八）查询数据的通用方法

1、selectById方法

2、selectBatchIds方法

3、selectByMap方法

（九）删除数据方法

1、deleteById方法

2、deleteByMap方法

3、deletebatchIds方法

五、Mybatis-Plus条件构造器

（一）条件构造器介绍

（二）SelectOne方法

（三）SelectList方法

（四）SelectPage方法

（五）Update方法

（六）Delete方法

六、Mybatis-Plus的Service封装

（一）通用service简介

（二）通用service常用方法介绍

（三）通用service的案例

1、构建工程，添加依赖

2、构建service接口

3、构建service实现类

4、通用service测试

七、Mybatis-Plus代码生成器

（一）代码生成器介绍

（二）构建maven工程，引入依赖

（三）编写生成器代码

1、GlobalConfig全局配置编码

2、DataSourceConfig数据源配置编码

3、PackageConfig包名策略配置

4、StrategyConfig策略配置编码

5、执行

（四）执行生成器代码完成测试

---

一、Mybatis-Plus简介

（一）什么是Mybatis-Plus

Mybatis-Plus是一个Mybatis（opens new window）的增强工具，在Mybatis的基础上只做增强不做改变，为简化开发。

（二）Mybatis-Plus的优势

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响。
• 损耗小：启动即会自动注入基本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 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询。
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作。

（三）Mybatis-Plus的框架结构

 

二、SpringBoot整合Mybatis-Plus入门

（一）创建maven工程，添加依赖

    mysql
    mysql-connector-java
    5.1.47


    org.springframework.boot
    spring-boot-starter-test
    test


    com.baomidou
    mybatis-plus-boot-starter
    3.4.2


    junit
    junit
    4.12

（二）创建数据库表employee

CREATE TABLE employee(
emp_id BIGINT(20) NOT NULL,
name VARCHAR(30),
emp_gender VARCHAR(6),
age INT,
email VARCHAR(50),
PRIMARY KEY(emp_id)
);
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(1367686308726788098,'刘晓娟','女',20,'[email protected]');
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(1367709299695099906,'张春雨','男',28,'[email protected]');
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(1367717669156028418,'何雨柱','男',23,'[email protected]');

（三）构建数据模型Employee

public class Employee {
    private Long empId;
    private String name;
    private String empGender;
    private Integer age;
    private String email;

    public Long getEmpId() {
        return empId;
    }

    public void setEmpId(Long empId) {
        this.empId = empId;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmpGender() {
        return empGender;
    }

    public void setEmpGender(String empGender) {
        this.empGender = empGender;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @Override
    public String toString() {
        return "Employee{" +
        "empId=" + empId +
        ", name='" + name + '\'' +
        ", empGender='" + empGender + '\'' +
        ", age=" + age +
        ", email='" + email + '\'' +
        '}';
    }
}

（四）配置application.yml

spring:
datasource:
 driver-class-name: com.mysql.jdbc.Driver
 url: jdbc:mysql:///mybatis_plus
 username: root
 password: root
logging:
level:
 com:
   offcn:
      mapper: debug

（五）编写SpringBoot启动类

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

（六）编写mapper接口

public interface EmployeeMapper extends BaseMapper {}

（七）启动服务测试结果

@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlus01ApplicationTests {
    @Autowired
    private EmployeeMapper employeeMapper;
    
    @Test
    public void testSelect(){
        List employeeList = employeeMapper.selectList(null);
        employeeList.forEach( System.out::println);
    }
}

三、Lombok插件

（一）Lombok插件简介

Lombok是一个插件，用途是使用注解给你类里面的字段，自动的加上属性，构造器，ToString方法，Equals方法等，比较方便的一点是，你在更改字段的时候，Lombok会立即发生改变以保持和你代码的一致性。

（二）常用的Lombok注解介绍

@Data	注在类上，提供类的get、set、equals、hashCode、toString等方法
@Getter	加在类上，可以自动生成参数的getter方法
@Setter	加在类上，可以自动生成参数的setter方法
@ToString	加在类上，调用toString()方法，可以输出实体类中所有属性的值
@RequiredArgsConstructor	生成一个包含常量，和标识了NotNull的变量的构造方法。生成的构造方法是私有的private
@EqualsAndHashCode	生成equals和hashCode方法， 默认使用非静态的属性， 可以通过exclude参数排除不需要生成的属性。 通过of参数来指定需要生成的属性
@NoArgsConstructor	生成一个无参数的构造方法
@AllArgsConstructor	生成一个包含所有变量的构造方法。
@Value	这个注解要和Spring的@Value注解区分，Spring的是从配置文件读取内容，这个注解是在类中的所有字段默认全部声明为private final类型，只会生成Getter方法，不会生成Setter方法。
@Cleanup	主要用于关闭资源使用。

（三）idea安装Lombok插件

首先我们需要安装IntelliJ IDEA中的lombok插件，打开IntelliJ IDEA后点击菜单栏中的File-->Settings，或者使用快捷键Ctrl+Alt+S进入到设置页面。

                

我们点击设置中的Plugins进行插件的安装，在右侧选择Browse repositories...，然后在搜索页面输入lombok变可以查询到下方的Lombok Plugin，鼠标点击Lombok Plugin可在右侧看到Install按钮，点击该按钮便可安装。

        

 

安装完成之后重启idear即可。 

（四）Lombok插件的使用

1、引入依赖

    org.projectlombok
    lombok
    1.18.4
    provided

2、去除Employee类中的setter和getter方法

public class Employee {
    private Long empId;
    private String name;
    private String empGender;
    private Integer age;
    private String email;
}

3、在Employee类上添加Lombok注解

@NoArgsConstructor
@AllArgsConstructor
@Data
@ToString
public class Employee {
    private Long empId;
    private String name;
    private String empGender;
    private Integer age;
    private String email;
}

四、CRUD

（一）BaseMapper接口方法介绍

BaseMapper中提供了CRUD方法，具体方法如下：

// 插入一条记录
int insert(T entity);

// 根据 entity 条件，删除记录
int delete(@Param(Constants.WRAPPER) Wrapper wrapper);

// 删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);

// 根据 ID 删除
int deleteById(Serializable id);

// 根据 columnMap 条件，删除记录
int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

// 根据 whereEntity 条件，更新记录
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);

// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 查询（根据 columnMap 条件）
List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

// 根据 Wrapper 条件，查询全部记录
List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
List