SpringBoot整合MybatisPlus入门笔记

MP的官方文档地址
我们要学习MP，那我们先来了解一下什么是MybatisPlus

1、简介

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

这话的意思就是：Mybatis能做的MP就能做。这就是叫做只做增强不做改变。

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 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作。

3、支持多种数据库

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

4、框架结构

开始入门 1、开发环境

IDE：idea 2020.3.2
JDK：JDK8
构建工具：maven 3.5.4
MySQL版本：MySQL 8
Spring Boot：2.6.3
MyBatis-Plus：3.5.1

2、数据准备

创建表

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)
);

2.插入数据

DELETE FROM user;

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');

3、创建SpringBoot工程

（创建过程需要联网，不建议使用校园网，因为有可能会出现构建不成功）

需要用到WEB模块，选择Web勾选Spring Web，
因为需要连接数据库，这SQL 选择MySQL Driver

4、引入依赖

 
	com.baomidou 
	mybatis-plus-boot-starter 
	3.5.1 


	org.projectlombok 
  	lombok
   	true

 
     mysql
     mysql-connector-java 
     runtime

5、idea中安装lombok插件

在文件->设置->插件中搜索lombok安装并重启

编写代码 1、配置application.properties

spring.datasource.type=com.zaxxer.hikari.HikariDataSource
#配置数据源
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/testdb?serverTimezone&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456

#设置全局数据表前缀，设置之后可以不适用@TableName注解进行标注了
mybatis-plus.global-config.db-config.table-prefix=t_

#配置类型别名
mybatis-plus.type-aliases-package=com.sjm.pojo

#配置扫描通用枚举
mybatis-plus.type-enums-package=com.sjm.enums

注意：mysql版本不同连接方式和驱动名有所不同

MySQL5.7版本的url：
jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
驱动：com.mysql.jdbc.Driver
MySQL8.0版本的url：
jdbc:mysql://localhost:3306/mybatis_plus?
serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
驱动： com.mysql.cj.jdbc.Driver

2、新建文件结构，分别创建UserController类，UserService类，UserMapper类，ResultUtil类

3、配置启动类

@SpringBootApplication
//用于扫描mapper接口的包
@MapperScan("com.sjm.mapper")
@MapperScan("com.sjm.dao")
@MapperScan("com.sjm.utils")

public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }

}

4、添加mapper为了在mvc结构中调用方法不报错，在dao层或者mapper层添加注解。

IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确
的执行。
为了避免报错，可以在mapper接口上添加 @Repository 注解
UserMapper类

//Repository将接口标记为实体
@Repository
public interface UserMapper extends BaseMapper {
//    此处可以自定义查询
  //这里就是MybatisPlus的神奇之处了，
}

5、添加实体类

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

6、ResultUtil类代码，是封装后的结果类

package com.sjm.utils;

public class ResultUtil {
    private String msg;
    private Integer status;
    private Object data;

    //成功无结果集
    private ResultUtil(String msg) {
        this.status = 200;
        this.msg = msg;
    }

    public static ResultUtil success(String msg) {
        return new ResultUtil(msg);
    }

    //    成功有结果集
    private ResultUtil(String msg, Object data) {
        this.msg = msg;
        this.data = data;
        this.status = 200;
    }

    public static ResultUtil success(String msg, Object data) {
        return new ResultUtil(msg, data);
    }

    //失败
    private ResultUtil(int status, String msg) {
        this.status = status;
        this.msg = msg;
    }

    public static ResultUtil fail(int status, String msg) {
        return new ResultUtil(status, msg);
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public int getStatus() {
        return status;
    }

    public void setStatus(int status) {
        this.status = status;
    }

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }


}

7、测试查询功能

Controller：

@Controller
public class UserController {
    @Autowired
    UserService userService;

    @RequestMapping("/selectAll")
    @ResponseBody
//    查询所有
    public List selectALLUser() {
        return userService.selectAll();
    }
 }

Service接口

@Service
public class UserService {
    @Autowired
    UserMapper userMapper;
    public List selectAll() {
        return userMapper.selectList(null);
    }
  }

浏览器打开：http://localhost:8080/selectAll
返回的结果：

添加日志

#配置mybatisplus日志输出
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

基本CRUD

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用。可以按住Ctrl点击BaseMapper查看BaseMapper代码。

public interface BaseMapper extends Mapper {
    int insert(T entity);

    int deleteById(Serializable id);

    int deleteById(T entity);

    int deleteByMap(@Param("cm") Map columnMap);

    int delete(@Param("ew") Wrapper queryWrapper);

    int deleteBatchIds(@Param("coll") Collection idList);

    int updateById(@Param("et") T entity);

    int update(@Param("et") T entity, @Param("ew") Wrapper updateWrapper);

    T selectById(Serializable id);

    List selectBatchIds(@Param("coll") Collection idList);

    List selectByMap(@Param("cm") Map columnMap);

    default T selectOne(@Param("ew") Wrapper queryWrapper) {
        List 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 queryWrapper) {
        Long count = this.selectCount(queryWrapper);
        return null != count && count > 0L;
    }

    Long selectCount(@Param("ew") Wrapper queryWrapper);

    List selectList(@Param("ew") Wrapper queryWrapper);

    List> selectMaps(@Param("ew") Wrapper queryWrapper);

    List

SpringBoot整合MybatisPlus入门笔记

Java相关栏目本月热门文章