MyBatisPlus学习笔记（一）入门之整合到SpringBoot

水深无声 2022-09-12 10:59 224阅读 0赞

## 1. 介绍 ##

#### 1.1 定义 ####

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

#### 1.2 官网地址 ####

**[MyBatisPlus官网地址][MyBatisPlus]**

#### 1.3 MyBatisPlus特性 ####

*  **无侵入**：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
 *  **损耗小**：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作。

#### 1.4 MyBatisPlus 常用注解 ####

**@TableName：** 用于定义表名，作用于类上。

![在这里插入图片描述][57a56ee4f3d44544ab21ab90d60d04a0.png]

**@TableId**：用于定义表的主键，作用于属性上。

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16]  
**@TableField：** 用于定义表的非主键字段，作用与属性上。

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16 1]

**@TableLogic：** 用于定义表的字段进行逻辑删除。

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16 2]

**@Version：用于字段实现乐观锁。**

![在这里插入图片描述][e9bbf9dd7a124650803cdd28cb37610e.png]

## 2. SpringBoot整合MyBatisPlus ##

#### 2.1 基础版 ####

**配置文件application-dev.yml：**

#指定端口
    server:
      port: 8888
    
    # 数据库配置
    spring:
      datasource:
        username: root
        password: root
        url: jdbc:mysql://localhost:3306/jbp?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
        driver-class-name: com.mysql.jdbc.Driver
    
    # 控制台打印sql配置
    mybatis-plus:
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

**Mapper类（继承BaseMapper）：**

package com.example.mapper;
    
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.example.entity.User;
    
    /** * @ClassName: UserMapper * @description: * @author: JiangBeiPing * @create: 2021-09-18 13:36 * @Version: 1.0 **/
    public interface UserMapper extends BaseMapper<User> { 
    
    }

**实体类：**

package com.example.entity;
    
    import lombok.Data;
    
    import java.util.Date;
    
    /** * @ClassName: User * @description: 用户实体类 * @author: JiangBeiPing * @create: 2021-09-18 11:34 * @Version: 1.0 **/
    @Data
    public class User { 
        private Integer id;
        private String name;
        private Integer age;
        private Date birthday;
        private Integer enable;
        private Integer version;
    }

**Service类：**

package com.example.service;
    
    /** * @ClassName: UserService * @description: * @author: JiangBeiPing * @create: 2021-09-18 13:44 * @Version: 1.0 **/
    
    import com.example.entity.User;
    import com.example.mapper.UserMapper;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import java.util.List;
    
    @Service
    public class UserService { 
    
        @Autowired
        UserMapper userMapper;
    
        public List<User> queryAll(){ 
            return userMapper.selectList(null);
        }
    
    }

**Controller类：**

package com.example.controller;
    
    import com.example.entity.User;
    import com.example.service.UserService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    /** * @ClassName: UserController * @description: * @author: JiangBeiPing * @create: 2021-09-18 13:35 * @Version: 1.0 **/
    @RestController
    @RequestMapping("/user")
    public class UserController { 
    
        @Autowired
        UserService userService;
    
        @GetMapping("/queryAll")
        public List<User> queryAll(){ 
            List<User> users = userService.queryAll();
            return users;
        }
    }

**测试效果：**

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16 3]

[MyBatisPlus]: https://mp.baomidou.com/
[57a56ee4f3d44544ab21ab90d60d04a0.png]: /images/20220828/b0d71c5656ae4591815113298d8a04ba.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/1d0a53cd9f8f49ee888726f848e8f90a.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/b9e8f9cd568f4fc9a235e20ea0051768.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220828/d5e2664bcccc4ce99c12b5e4b33fe511.png
[e9bbf9dd7a124650803cdd28cb37610e.png]: /images/20220828/e470ed6fac7440a291d6c739b02c67ac.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA6Zuq5a2k5Z-O_size_20_color_FFFFFF_t_70_g_se_x_16 3]: /images/20220828/cf7245a00dda405e8e4388806ea11294.png