MyBatis-Plus框架学习

MyBatis-Plus

第 1 节 MyBatis-Plus 简介

MyBatis-Plus 官方文档入口

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

MyBatis-Plus 根据存在的数据表，逆向生成 model、controller、service、mapper 等。

特性：

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

第 2 节 导入启动依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3.4</version>
</dependency>

注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差异导致的问题。

第 3 节 MyBatis-Plus 开发

进行开发时，需要注意官方文档，尤其是 service 层。

注意：MyBatis-Plus 会将有下划线的数据库字段名自动转化为驼峰命名，例如 s_id -> sId，实体类属性名需要逐一对应。

MyBatis-Plus 适合单表开发，如果涉及到多表或者复杂的数据库操作，依然需要配置 xxxMapper.xml。

3.1 创建实体类

package com.luochen.pojo;

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

import java.util.Date;

/**
 * @Author 洛尘大大
 * @projectName SpringBoot
 * @title StudentController
 * @Date 2021/11/1 17:14
 * @Description TODO
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student{
    private String sId;
    private String sName;
    private String tId;
    private Date time;
}

3.2 创建 mapper 接口

package com.luochen.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.luochen.pojo.Student;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Repository;

import java.util.List;

/**
 * @Author 洛尘大大
 * @projectName SpringBoot
 * @title StudentMapper
 * @Date 2021/11/1 20:33
 * @Description student的dao接口
 */
@Mapper // 标识mapper接口
@Repository // 标识dao层，否则不能注册到SpringIOC
// 继承BaseMapper类，并传入实体类，否则不能标识创建哪张表对应的实体类
public interface StudentMapper extends BaseMapper<Student> {
}

3.3 主类

package com.luochen;

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

@SpringBootApplication
// @MapperScan("com.luochen.mapper") // 设置扫描包
public class SpringbootMybatisPlusApplication {

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

注：如果 mapper 接口没有 @Mapper 注解，则需要在主类上配置 @MapperScan 注解，并设置扫描包。

3.4 MyBatis-Plus 逆向工程

逆向工程，即由数据表自动生成增删改查的代码，例如通过配置项自动创建 controller、service、mapper 等层。

MyBatis-Plus 逆向工程通过调用方法即可操作单表，而不需要手写 SQL 语句；但若涉及多表查询，则需要另外手写 SQL 语句。

使用最新版 3.5.1+ 以上版本，配置 generator 类，运行以下配置代码会自动生成代码。注意查看官方文档。

package com.luochen.generator;


import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.querys.MySqlQuery;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
import com.baomidou.mybatisplus.generator.keywords.MySqlKeyWordsHandler;

import java.util.Collections;

/**
 * @Description MyBatisPlus逆向工程，运行主方法即可自动生成大量代码，采用链式编程
 */
public class MyBatisPlusGenerator {

    public static void main(String[] args) {
        // 数据库配置
        DataSourceConfig.Builder dataSourceConfig = new DataSourceConfig
                .Builder("jdbc:mysql:///test01", "root", "root")
                .dbQuery(new MySqlQuery())
                .schema("mybatis-plus")
                .typeConvert(new MySqlTypeConvert())
                .keyWordsHandler(new MySqlKeyWordsHandler());

        // 交互式配置
        FastAutoGenerator.create(dataSourceConfig)
                // 全局配置
                .globalConfig(builder -> {
                    builder.author("洛尘大大") // 设置作者
                            .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .dateType(DateType.ONLY_DATE) // java.Date
                            .outputDir("D:\\Softdownload\\IntelliJ_IDEA_2020\\IntelliJ_IDEA_Workspace\\SpringBoot\\springboot-mybatis-plus\\src\\main\\java"); // 指定输出目录，绝对路径
                })
                // 包配置
                .packageConfig(builder -> {
                    builder.parent("com.luochen") // 设置父包名
                            .entity("pojo") // 实体类包
                            .service("service")
                            .serviceImpl("service.impl")
                            .mapper("mapper")
                            .controller("controller")
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D:\\Softdownload\\IntelliJ_IDEA_2020\\IntelliJ_IDEA_Workspace\\SpringBoot\\springboot-mybatis-plus\\src\\main\\resources\\mybatis\\mapper")); // 设置mapper.xml生成绝对路径
                })

                // 策略配置
                .strategyConfig(builder -> builder
                        // pojo策略配置
                        .entityBuilder()
                        .enableChainModel()
                        .enableLombok()
                        .enableRemoveIsPrefix()
                        .enableTableFieldAnnotation()
                        .enableActiveRecord()
                        .naming(NamingStrategy.underline_to_camel)
                        .columnNaming(NamingStrategy.underline_to_camel)

                        // controller策略配置
                        .controllerBuilder()
                        .enableHyphenStyle()
                        .enableRestStyle()
                        .formatFileName("%sController") // 生成XxxController

                        // service策略配置
                        .serviceBuilder()
                        .formatServiceFileName("%sService")
                        .formatServiceImplFileName("%sServiceImp")

                        // mapper策略配置
                        .mapperBuilder()
                        .enableMapperAnnotation()
                        .enableBaseResultMap()
                        .enableBaseColumnList()
                        .formatMapperFileName("%sMapper")
                        .formatXmlFileName("%sMapper")
                        .build())
                .templateEngine(new VelocityTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();
    }
}