MybatisPlus

Mybatis-Plus介绍

1.1 Mybatis-Plus介绍

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发提高效率而生。该框架由baomidou（苞米豆）组织开发并且开源的。

官 网 ：MyBatis-Plus或 Redirect

github 地 址 ： https://github.com/baomidou/mybatis-plus

码云地址：https://gitee.com/baomidou/mybatis-plus

 

我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P 2P，基友搭配，效率翻倍。

1.2 支持的数据库

MyBatisPlus支持如下数据库：

mysql mariadb oracle db2 h2 hsql sqlite postgresql sqlserver

达梦数据库 虚谷数据库 人大金仓数据库

1.3 特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝滑

损耗小：启动即会自动注入基本 CRUD，性能基本无损耗，直接面向对象操作

强大的 CRUD 操作：内置通用 Mapper 通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作， 更有强大的条件构造器，满足各类使用需求

支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错

支持多种数据库：支持 MySQL MariaDB Oracle DB2 H2 HSQL SQLite Postgre SQLServer2005 SQLServer

等多种数据库

支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题1

支持 XML 热加载：Mapper 对应的 XML支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动

支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD

操作

支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）

支持关键词自动转义：支持数据库关键词（order key......）自动转义，还可自定义关键词

内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper Model Service Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用

内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通List 查询

内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询

内置全局拦截插件：提供全表 delete update 操作智能分析阻断，也可自定义拦截规则，预防误操作

内置Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

1.4 架构

Mybatis主要包含以下模块：

核心功能(core），基于Mybatis的封装，提供了Mybatis Plus的基础配置类与核心功能，如内置通用Mapper，

Lambda 表达式查询等。

注解(annotation)，提供了Mybatis Plus中注解的定义。

扩展功能(extension)，提供扩展及插件功能，包括分页插件 通用 Service扩展性能分析插件等。

代码生成器(generator)：通过代码生成器可以快速生成 Mapper接口 Entity实体类 Mapper XML Service

Controller 等各个模块的代码，极大的提升了开发效率。

执行流程：

（1）扫描注解Entity，反射提取注解信息如：表名称、字段名称等信息。

（2）分析注解信息并基于com.baomidou.mybatisplus.core.enums的SQL模板生成基本CRUD SQL。

（3）最后将这些SQL注入到Mybatis环境中。

因此Mybatis plus无需编写CRUD SQL语句，只需继承BaseMapper，魔术般的拥有了CRUD功能(通用CRUD)。

---

入门项目

项目框架

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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.yh</groupId>
    <artifactId>yh-mp-springboot</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.10.RELEASE</version>
    </parent>

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

        <!--简化代码的工具包，针对实体类-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--mybatis‐plus的springboot支持-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.0</version>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.30</version>
        </dependency>

    </dependencies>

</project>

分页插件配置文件

MybatisPlusConfig

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisPlusConfig {
    /**
     * 分页插件
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

Mapper层

UserMapper

public interface UserMapper extends BaseMapper<User> {
    User myFindUserById(Integer id); //自定义的查询方法，目的是练习传统Mybatis的使用
}

Pojo实体类

User

package cn.yh.mp.pojo;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.time.LocalDateTime;

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("tb_user")   //指定数据库表
public class User {


    /**
     * 指定主键
     *
     * 使用该主键生成策略：@TableId(value = "id",type = IdType.ID_WORKER) 要注意下面内容
     * 如果数据库id字段是bigint类型，那么java实体类中属性类型为java.long.Long,Integer位数远远不够了
     */
    @TableId(value = "id")
    private Long id;

//    @TableField("user_name")   //mybatis-plus默认开启驼峰匹配，可不写@TableField("user_name")
    private String userName;

//    @TableField("password")
    private String password;

//    @TableField("name")
    private String name;

//    @TableField("age")
    private Integer age;

//    @TableField("email")
    private String email;

//    @TableField("birthday")
    private LocalDateTime birthday;

}

引导类/启动类

MyApplication

@MapperScan("cn.yh.mp.mapper") 扫描对应包下的接口并加到Spring的Ioc容器中。

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

@SpringBootApplication
@MapperScan("cn.yh.mp.mapper")
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

resources配置

UserMapper

<?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">

<!--namespace是mapper层对应的接口名-->
<mapper namespace="cn.yh.mp.mapper.UserMapper">

    <!--id是mapper层对应的接口名中对应的方法名-->
    <select id="myFindUserById" resultType="User">
        select *
        from tb_user
        where id = #{id}
    </select>


</mapper>

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!--设置驼峰匹配，MybatisPlus默认开启驼峰匹配-->
<!--    <settings>-->
<!--        <setting name="mapUnderscoreToCamelCase" value="true"/>-->
<!--    </settings>-->

</configuration>

application.yml

spring:
  application: #服务名
    name: local-mp
  #数据源，连接自己电脑上的数据库
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver   #MySQL8版本及以上要加cj,此工程用的是MySQL8
    username: root
    password: 123456       #注意url有问题时可以尝试加时区
#    url: jdbc:mysql://localhost:3306/mp?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true
#    url: jdbc:mysql://127.0.0.1:3306/mp
    url: jdbc:mysql:///mp   #三种写法都可以，localhost=127.0.0.1，表示本机


#日志
logging:
  level:
    root: debug


#设置mybatis-plus
mybatis-plus:
  config-location: classpath:mybatis/mybatis-config.xml  #配置文件
  mapper-locations: classpath:mybatis/mapper/*.xml  #设置mapper层对应的接口对应的mapper.xml的路径
  type-aliases-package: cn.yh.mp.pojo  #设置别名，mapper.xml中resultType="cn.yh.mp.pojo.User"可省去包，即resultType="User"
  #开启自动驼峰映射，注意：配置configuration.map-underscore-to-camel-case则不能配置config-location，可写到mybatis-config.xml中
#  configuration:
#    map-underscore-to-camel-case: true

测试类

MapperPlusTest

import cn.yh.mp.mapper.UserMapper;
import cn.yh.mp.pojo.User;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.Arrays;
import java.util.List;

@SpringBootTest
@RunWith(SpringRunner.class)
public class MapperPlusTest {

    @Autowired
    private UserMapper userMapper;

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

    @Test
    public void findUserById() {
        User user = userMapper.myFindUserById(2);
        System.out.println(user);
    }

    /**
     * 插入数据
     */
    @Test
    public void testInsert() {
        User user = new User();
        user.setAge(20);
        user.setEmail("test@yh.cn");
        user.setName("曹操");
        user.setUserName("caocao");
        user.setPassword("123456");
        userMapper.insert(user);

    }


    /**
     * 根据id 批量删除
     */
    @Test
    public void testDeleteByIds() {
//根据id集合批量删除   DELETE FROM tb_user WHERE ID IN ( ? , ? , ? )
        int result = this.userMapper.deleteBatchIds(Arrays.asList(1, 2, 4));
        System.out.println("result   = " + result);
    }


    /**
     * 分页
     */
    @Test
    public void testPage() {
        QueryWrapper<User> wrapper = new QueryWrapper<User>();
        wrapper.eq("age", 20); //查询条件，age=20

        IPage<User> page = new Page<>(1, 2);


        IPage<User> userIPage = userMapper.selectPage(page, wrapper);
        System.out.println("数据总条数：" + userIPage.getTotal());
        System.out.println("总页数:" + userIPage.getPages());
    }


    /**
     * 修改
     */
    @Test
    public void testUpdate() {
        User user = new User();
        user.setId(5L);
        user.setAge(20);
        user.setEmail("test@yh.cn");
        user.setName("曹操");
        user.setUserName("caocao");
        user.setPassword("123");

        userMapper.updateById(user);

//        userMapper.update()
    }


    /**
     * 模糊查询
     */
    @Test
    public void testLike() {
        LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
//        wrapper.like(User::getName, "曹");   //%曹%
        wrapper.likeRight(User::getName, "曹");  //曹%
        List<User> userList = userMapper.selectList(wrapper);
        userList.forEach(System.out::println);


        userMapper.selectList(wrapper);
    }

    /**
     * 测试or,默认and拼接条件
     */
    @Test
    public void testOr() {
        LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
        lambdaQueryWrapper.eq(User::getName, "曹丕");
        lambdaQueryWrapper.or();   //添加or条件
        lambdaQueryWrapper.eq(User::getAge, 22);

        /**
         * SELECT id,user_name,password,name,age,email,birthday FROM tb_user
         * WHERE name = ? OR age = ?
         */
        List<User> userList = userMapper.selectList(lambdaQueryWrapper);
        userList.forEach(System.out::println);

    }


    @Test
    public void testLogicSelect() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.and(wp -> wp
                        .eq("password", "123")
                        .or()
                        .ge("age", 20))
                .in("name", "张三", "李四", "王五");

        /**
         * SELECT id,user_name,password,name,age,email,birthday FROM tb_user
         * WHERE password = ? OR age >= ? AND name IN (?,?,?)
         */
        List<User> userList = userMapper.selectList(wrapper);
        userList.forEach(user -> System.out.println(user));
    }


}

总结：

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变。

在项目中多为二者结合使用。

朋友！

都看到这里了，点个赞再走吧！