一文学会使用 mybatis-plus

1、mybatis-plus 简介

        MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

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 操作智能分析阻断，也可自定义拦截规则，预防误操作 支持数据库 任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。

13）、支持数据库：MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb ，达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库。

3、mybatis-plus 项目搭建流程

 3.1、引入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.16</version>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

3.2、编写实体类（略过）和 Mapper 接口

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

3.3、编写 service 接口和实现类

// 1、接口
public interface UserService extends IService<User>{
}
// 2、实现类
public class UserServiceImpl extends ServiceImpl<UserMapper,User> implements UserService{
}

 3.4、创建 **Mapper.xml 文件

        一般在 resources 目录下创建 mapper 文件夹，**Mapper.xml 文件都创建在此处。

<?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="Mapper 接口全限定名称">

</mapper>

        创建完 **Mapper.xml 文件，在配置文件中指定 **Mapper.xml 文件的位置

mybatis-plus:
  global-config:
    banner: off
    db-config:
      table-prefix: tb_
      id-type: none
      logic-delete-field: is_deleted
      logic-delete-value: 0
      logic-not-delete-value: 1
  mapper-locations: classpath:mapper/*.xml  # 指定 *Mapper.xml 文件位置
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    map-underscore-to-camel-case: true

4、字段名与实体类名映射

1）、表名和实体类名映射 -> 表名user 实体类名User （默认）；

2）、字段名和实体类属性名映射 -> 字段名name 实体类属性名name；

3）、字段名下划线命名方式和实体类属性小驼峰命名方式映射 -> 字段名 user_email 实体类属性名 userEmail。

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl  # 开启sql打印日志
    map-underscore-to-camel-case: true   # 开启下划线转驼峰字段映射

4.1、表映射

        通过 @TableName() 注解指定映射的数据库表名，就会按照指定的表名进行映射。例如：此时将数据库的表名为 powershop_user，要完成表名和实体类名的映射，需要将实体类名也要指定为 PowershopUser（默认采用驼峰映射规则）。默认是实体类名和表明要一致（不加@TableName() 注解时）。

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("powershop_user")
public class User {  // 不加@TableName() 注解时，需要将类名改成 PowershopUser
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

        如果有很多实体类，对应到数据库中的很多表，我们不需要每个依次配置，只需要配置一个全局的设置，他都会给每个实体类名前面添加指定的前缀（配置完后不用加 @TableName 注解），全局配置如下：

mybatis-plus:
  global-config:
    db-config:
      table-prefix: powershop_

4.2、字段映射

1）、可以使用 @TableField() 注解改变字段和属性的映射，让注解中的名称和表字段保持一致；如：此时将数据库字段的名称我们改为 username，在根据实体类的属性拼接SQL的使用，就会使用 @TableField() 中指定的名称username进行拼接。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableField("username")  // 数据库字段名
    private String name;     
}

2）、可以在sql语句中使用别名的方式更改字段名称，使其查询结果和实体类属性对应。

3）、可以使用 resultMap，通过实体类和数据表字段进行映射。

4）、遇到关键字，需要使用 @TableField()  将关键字加上反引号，例如：@TableField("`desc`")。

4.3、字段失效

        当数据库中有字段不希望被查询，我们可以通过 @TableField(select = false) 来隐藏这个字段，那在拼接SQL语句的时候，就不会拼接这个字段。

总结：本文介绍 mybatis-plus 基本使用，整个过程和 mybatis 一致，只不过是对 mybatis 进行增强，后面会详细介绍两个条件构造器，体会使用 mybatis-plus 的便利。

        本人是一个从小白自学计算机技术，对运维、后端、各种中间件技术、大数据等有一定的学习心得，想获取自学总结资料（pdf版本）或者希望共同学习，关注微信公众号：it自学社团。后台回复相应技术名称/技术点即可获得。（本人学习宗旨：学会了就要免费分享）