Mybatis-Plus 系列:简介和基本使用

发布时间 2023-09-25 23:29:22作者: Code技术分享

一、简介

官网:https://www.baomidou.com

MyBatis-Plus是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,主要作用为简化开发、提高效率

二、特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 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、初始化数据库

create database db_mybatisPlus character set utf8;
use db_mybatisPlus;
DROP TABLE IF EXISTS user;
CREATE TABLE 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 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 工程(工程将以 MySQL 作为默认数据库进行演示)

提示

可以使用 Spring Initializer 快速初始化一个 Spring Boot 工程

导入依赖

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>


        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.30</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/com.alibaba/druid-spring-boot-starter -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.19</version>
        </dependency>

创建实体类

package com.mcode.javampdemo01.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * ClassName: User
 * Package: com.mcode.javampdemo01.entity
 * Description:
 *
 * @Author robin
 * @Create 2023/9/25 22:54
 * @Version 1.0
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private  Long id;
    private String name;
    private Integer age;
    private String email;
}

集成 Mybatis-Plus

package com.mcode.javampdemo01.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mcode.javampdemo01.entity.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

/**
 * ClassName: UserMapper
 * Package: com.mcode.javampdemo01.mapper
 * Description:
 *
 * @Author robin
 * @Create 2023/9/25 22:56
 * @Version 1.0
 */
@Mapper
public interface UserMapper extends BaseMapper<User> {
}

编写 Service 接口

package com.mcode.javampdemo01.service;

import com.mcode.javampdemo01.entity.User;

import java.util.List;

/**
 * ClassName: UserService
 * Package: com.mcode.javampdemo01.service
 * Description:
 *
 * @Author robin
 * @Create 2023/9/25 22:58
 * @Version 1.0
 */
public interface UserService {
    List<User> selectList();
}

编写 Service 实现

package com.mcode.javampdemo01.service.impl;

import com.mcode.javampdemo01.entity.User;
import com.mcode.javampdemo01.mapper.UserMapper;
import com.mcode.javampdemo01.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * ClassName: UserServiceImpl
 * Package: com.mcode.javampdemo01.service.impl
 * Description:
 *
 * @Author robin
 * @Create 2023/9/25 22:59
 * @Version 1.0
 */
@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public List<User> selectList() {
         return userMapper.selectList(null);
    }
}

编写 Controller

package com.mcode.javampdemo01.controller;

import com.mcode.javampdemo01.entity.User;
import com.mcode.javampdemo01.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * ClassName: UserController
 * Package: com.mcode.javampdemo01.controller
 * Description:
 *
 * @Author robin
 * @Create 2023/9/25 23:03
 * @Version 1.0
 */
@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/users")
    public List<User> selectList(){
        return  userService.selectList();
    }
}

编写 application.yml

spring:
    datasource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        username: root
        password: 123456
        # MyBatis 8 需要配置时区 serverTimezone=GMT%2B8
        url: jdbc:mysql://localhost:3306/db_mybatisplus?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
        type: com.alibaba.druid.pool.DruidDataSource

测试结果

image

3、精简 SpringBoot 相关日志

去除 MybatisPlus 的 logo

mybatis-plus:
    global-config:
        banner: off

去除 SpringBoot 的 logo

spring:
    main:
        banner-mode: off

MybatisPlus 的执行日志

mybatis-plus:
    configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl