MybatisPlus（1）

anotherQu

已于 2022-04-20 15:51:47 修改

阅读量681

点赞数

分类专栏： java 文章标签： java

于 2022-04-19 16:42:18 首次发布

本文链接：https://blog.csdn.net/anotherqu/article/details/124226797

版权

java 专栏收录该内容

16 篇文章 0 订阅

订阅专栏

本教程来自尚硅谷对应教程：https://www.bilibili.com/video/BV12R4y157Be?p=3&spm_id_from=pageDriver

1 MybatisPlus介绍

对mybatis做增强，提供了通用的mapper和service，可以在不写sql语句的情况下完全包办简单的单表crud操作，但复杂的sql(多表联查、子查询请还是在xml中写sql)
官方文档：https://baomidou.com/pages/24112f/#%E7%89%B9%E6%80%A7
主要内容：
在这里插入图片描述
特性：
无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

框架结构：
在这里插入图片描述
流程：查找实体类–》使用反射，抽取实体类的属性，对照分析数据库表名和字段名–》生成sql语句–》sql语句注入mybatis容器中

2 快速开始

2.1 搭建数据库、数据表

数据库名：testdb
数据库表：

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

DELETE FROM user;
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.2 搭建环境

创建的是个spring boot项目，引入依赖，配置yaml，启动类上mapper包扫描，创建实体类、mapper接口、测试类。
springboot+mybatisplus+druid可以看看这个博客：https://blog.csdn.net/u010739100/article/details/118187086
目录结构：
在这里插入图片描述

pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.coderhao</groupId>
    <artifactId>mybatisplus</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mybatisplus</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.17</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

yaml:

spring:

  datasource:

    url: jdbc:mysql://localhost:3306/testdb?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
    #使用的连接池类型
    type: com.alibaba.druid.pool.DruidDataSource

    #这里druid连接池的配置不是重点，不手动配，用默认的配置，想改配置请查查官方文档啥的
    druid:
      #druid连接池监控平台：http://localhost:3000/druid
      stat-view-servlet:
        enabled: true
        login-username: admin
        login-password: admin

mybatis-plus:
  configuration:
    #sql日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

启动类上mapper包扫描：

package com.coderhao.mybatisplus;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.coderhao.mybatisplus.mapper")
public class MybatisplusApplication {

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

User:

package com.coderhao.mybatisplus.pojo;

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

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

UserMapper:

package com.coderhao.mybatisplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.coderhao.mybatisplus.pojo.User;

public interface UserMapper extends BaseMapper<User> {
}

测试类：

package com.coderhao.mybatisplus;

import com.coderhao.mybatisplus.mapper.UserMapper;
import com.coderhao.mybatisplus.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;

@SpringBootTest
class MybatisplusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    void selectAll() {
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

2.3 测试非Wrapper的crud

	@Test
    void selectAll() {
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

    @Test
    void insert() {
        User user = new User(null, "coderhao", 35, "coderhao@xx.com");
        userMapper.insert(user);
        //可以看到user的id自动生成并且回显了
        //id生成默认雪花算法
        System.out.println(user.getId());
    }

    @Test
    void delete() {
        //1
        userMapper.deleteById(1515896900408942594L);
        //2
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "zhangsan");
        map.put("age", 33);
        userMapper.deleteByMap(map);
        //3
        List<Long> ids = Arrays.asList(10L, 11L, 12L);
        userMapper.deleteBatchIds(ids);
    }

    @Test
    void update() {
        //1
        User user = new User(1L, null, null, "test1update@xx.com");
        userMapper.updateById(user);
    }

    @Test
    void select() {
        //1
        User user = userMapper.selectById(1L);
        System.out.println(user);
        //2
        List<User> users1 = userMapper.selectBatchIds(Arrays.asList(1L, 2L));
        users1.forEach(System.out::println);
        //3
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "o");
        List<User> users2 = userMapper.selectByMap(map);
        users2.forEach(System.out::println);
    }

2.4 测试自定义的sql

自定义需要mapper接口的xml映射文件，按照mybatis的配置，是需要配置xml路径的，但mybatisplus有默认的路径，可以不配路径：
在这里插入图片描述
userMapper:

package com.coderhao.mybatisplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.coderhao.mybatisplus.pojo.User;
import java.util.List;

public interface UserMapper extends BaseMapper<User> {
    public List<User> selectAllTabel();
}

userMapper.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="com.coderhao.mybatisplus.mapper.UserMapper">
    <select id="selectAllTabel" resultType="com.coderhao.mybatisplus.pojo.User">
        select * from `user`
    </select>
</mapper>

测试，依然可用，mybatisplus只是在mybatis的基础上做了增强，不做改动，mybatis那一套照样用。

2.5 测试通用serivce接口

为了保证mapper接口中方法的职责的单一性，批量添加、批量修改、批量删除这种功能就会放在通用service里面。
参考官方文档:https://baomidou.com/pages/49cc81/#service-crud-%E6%8E%A5%E5%8F%A3
这个通用service的批量操作是每条sql分别执行的，不是手写自定义的一个sql，博主对极高记录数情况下的效率存疑。

3 常见注解

3.1 @TableName

mybatisplus的自动sql操作的表名是根据实体类名来确定的，如果实体类名和表名不对应，就需要这个注解，加在实体类上，指明数据库表。
在这里插入图片描述
或者表名都有个前缀xxx_tableName,后面和实体类名一样，可以yaml中配个前缀（但这种方式和就不能使用 @TableName了，其实也不能保证你的表名一定就是“前缀_实体类名”这个格式，还是老老实实用 @TableName就完了）：

mybatis-plus:
  global-config:
    db-config:
      #统一表前缀
      table-prefix: xxx_

3.2 @TableId

mybatisplus只知道实体类中属性id和表中id是对应的主键，如果表中主键名变了，就需要@TableId在实体类中告诉对应的表中主键名。

public class User {
    //value:表中主键名
    //type:主键策略，设为自增（AUTO）时需要表中主键也设为自增
    @TableId(value = "user_id",type = IdType.AUTO)
    private Long userId;
    private String name;
    private Integer age;
    private String email;
}

@TableId里面还有一个type属性是设置主键策略：
在这里插入图片描述
如果所有实体类设置的主键生成策略都一样的话，可以提取出来，在yaml里设置：

mybatis-plus:
  global-config:
    db-config:
      id-type: auto

了解：雪花算法

背景

随着数据量增大，数据库扩展方式出现：业务分库、主从复制（主要实现读写分离功能）、数据库分表

数据库分表

淘宝几亿用户不可能放一个表里，分表有水平和垂直两种方式。
在这里插入图片描述
垂直拆分把不经常使用的大容量的字段拆出去。
水平拆分把很多行的1张表拆成几张表，一般5000W分一次表。
水平分表要保证主键唯一是个问题。
水平分表的主键略：

@TableField

非主键情况下，实体类属性名称对应数据库表字段名
在这里插入图片描述

@TableName("user")
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    //value:表中主键名
    //type:主键策略，设为自增（AUTO）时需要表中主键也设为自增
    @TableId(value = "user_id",type = IdType.AUTO)
    private Long userId;
    @TableField("user_name")
    private String name;
    private Integer age;
    private String email;
}

@TabelLogic

删除分两种，物理删除和逻辑删除
物理删除就是从表中直接删了，逻辑删除就是用一个字段来标记这个记录是否是删除状态
逻辑删除好点，不会删数据
首先表中加个逻辑删除的字段：
在这里插入图片描述
然后实体类也加上对应的属性，并加注解@TabelLogic

public class User {
    @TableId(value = "user_id",type = IdType.AUTO)
    private Long userId;
    @TableField("user_name")
    private String name;
    private Integer age;
    private String email;
    @TableLogic
    private Integer isDeleted;
}

测试删除，会发现不是真删除，而是把is_deleted字段变为1，通用查询也找不到逻辑删除的记录行。
控制台日志发现删除的执行代码变为了update:

UPDATE user SET is_deleted=1 WHERE user_id IN ( ? , ? , ? ) AND is_deleted=0

查询sql也变了，带了个is_deleted=0条件：

SELECT user_id,user_name AS name,age,email,is_deleted FROM user WHERE is_deleted=0