xiaozhegaa

MyBatis Plus 学习

前言

快速入门

简介

特性

框架结构

代码托管

快速开始

初始化工程

添加依赖

配置

编码

开始使用

小结

安装

Release

Snapshot

配置

核心功能

代码生成器

添加依赖

切换模板引擎

自定义模板引擎

CRUD 接口

Mapper CRUD 接口

Service CRUD 接口

updateBatchById

条件构造器

AbstractWrapper

groupBy

last

QueryWrapper

UpdateWrapper

使用 Wrapper 自定义SQL

分页插件

XML 自定义分页

Sequence主键

如何使用Sequence作为主键，但是实体主键类型是String

前言

最近在学习了MyBatis Plus，认真详细查看了官方文档，确实写得非常清楚，就不专门去写MyBatis Plus入门基础博文，直接将官网知识贴在博客里面。个人非常推荐查看这篇文章

当然，除了这篇文章之后，个人也会总结一些MP启动注入原理分析、AQ支持、几个插件底层原理分析等文章。有兴趣可以看一下哦

这一篇当做是文档+基础哦

版本在3.0+，2.3版本跟这个有小小区别哦！

快速入门

简介

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

愿景

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

特性

无侵入：Mybatis-Plus 在 Mybatis 的基础上进行扩展，只做增强不做改变，引入 Mybatis-Plus 不会对您现有的 Mybatis 构架产生任何影响，而且 MP 支持所有 Mybatis 原生的特性
依赖少：仅仅依赖 Mybatis 以及 Mybatis-Spring
损耗小：启动即会自动注入基本CURD，性能基本无损耗，直接面向对象操作
预防Sql注入：内置Sql注入剥离器，有效预防Sql注入攻击
通用CRUD操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
多种主键策略：支持多达4种主键策略（内含分布式唯一ID生成器），可自由配置，完美解决主键问题
支持ActiveRecord：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可实现基本 CRUD 操作
支持代码生成：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用（P.S. 比 Mybatis 官方的 Generator 更加强大！）
支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
支持关键词自动转义：支持数据库关键词（order、key……）自动转义，还可自定义关键词
内置分页插件：基于Mybatis物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通List查询
内置性能分析插件：可输出Sql语句以及其执行时间，建议开发测试时启用该功能，能有效解决慢查询
内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，预防误操作

框架结构

代码托管

Gitee | Github

快速开始

我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能，在此之前，我们假设您已经：

拥有 Java 开发环境以及相应 IDE
熟悉 Spring Boot
熟悉 Maven

现有一张 User 表，其表结构如下：

id	name	age	email
1	Jone	18	[email protected]
2	Jack	20	[email protected]
3	Tom	28	[email protected]
4	Sandy	21	[email protected]
5	Billie	24	[email protected]

其对应的数据库 Schema 脚本如下：

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

其对应的数据库 Data 脚本如下：

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

Question

如果从零开始用 MyBatis-Plus 来实现该表的增删改查我们需要做什么呢？

初始化工程

创建一个空的 Spring Boot 工程（工程将以 H2 作为默认数据库进行演示）

TIP

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

添加依赖

引入 Spring Boot Starter 父工程：


    org.springframework.boot
    spring-boot-starter-parent
    2.0.3.RELEASE

引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、lombok、h2 依赖：


    
        org.springframework.boot
        spring-boot-starter
    
    
        org.springframework.boot
        spring-boot-starter-test
        test
    
    
        org.projectlombok
        lombok
        true
    
    
        com.baomidou
        mybatis-plus-boot-starter
        3.0.6
    
    
        com.h2database
        h2
        runtime

配置

在 application.yml 配置文件中添加 H2 数据库的相关配置：

# DataSource Config
spring:
  datasource:
    driver-class-name: org.h2.Driver
    schema: classpath:db/schema-h2.sql
    data: classpath:db/data-h2.sql
    url: jdbc:h2:mem:test
    username: root
    password: test

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application {

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

}

编码

编写实体类 User.java（此处使用了 Lombok 简化代码）

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

编写Mapper类 UserMapper.java

public interface UserMapper extends BaseMapper {

}

开始使用

添加测试类，进行功能测试：

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

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List userList = userMapper.selectList(null);
        Assert.assertEquals(5, userList.size());
        userList.forEach(System.out::println);
    }

}

TIP

UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件

控制台输出：

User(id=1, name=Jone, age=18, [email protected])
User(id=2, name=Jack, age=20, [email protected])
User(id=3, name=Tom, age=28, [email protected])
User(id=4, name=Sandy, age=21, [email protected])
User(id=5, name=Billie, age=24, [email protected])

TIP

完整的代码示例请移步：Spring Boot 快速启动示例 | Spring MVC 快速启动示例

小结

通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！

从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。

但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能？那就继续往下看吧！

安装

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求如下：

JDK 8+
Maven or Gradle

TIP

JDK7 以及下的请参考 MP2.0 版本，地址：2.0 文档

Release

Spring Boot

Maven：


    com.baomidou
    mybatis-plus-boot-starter
    3.0.6

Gradle：

compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '3.0.6'

Spring MVC

Maven:


    com.baomidou
    mybatis-plus
    3.0.6

Gradle：

compile group: 'com.baomidou', name: 'mybatis-plus', version: '3.0.6'

WARNING

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

Snapshot

快照 SNAPSHOT 版本需要添加仓库，且版本号为快照版本。

Maven：


    snapshots
    https://oss.sonatype.org/content/repositories/snapshots/

Gradle：

repositories {
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
}

配置

MyBatis-Plus 的配置异常的简单，我们仅需要一些简单的配置即可使用 MyBatis-Plus 的强大功能！

TIP

在讲解配置之前，请确保您已经安装了 MyBatis-Plus，如果您尚未安装，请查看安装一章。

Spring Boot 工程：

配置 MapperScan 注解

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application {

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

}

Spring MVC 工程：
- 配置 MapperScan
```
    
```
- 调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory
```
    
```

通常来说，一般的简单工程，通过以上配置即可正常使用 MyBatis-Plus，具体可参考以下项目：Spring Boot 快速启动示例、Spring MVC 快速启动示例。

同时 MyBatis-Plus 提供了大量的个性化配置来满足不同复杂度的工程，大家可根据自己的项目按需取用，详细配置请参考配置一文

核心功能

代码生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {

    /**
     * 
     * 读取控制台内容
     * 
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("jobob");
        gc.setOpen(false);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.baomidou.ant");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });

        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        // templateConfig.setEntity();
        // templateConfig.setService();
        // templateConfig.setController();
        
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
        strategy.setInclude(scanner("表名"));
        strategy.setSuperEntityColumns("id");
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

更多详细配置，请参考代码生成器配置一文。

添加依赖

MP 3.0.3 之后移除了自动模板引擎依赖，需要手动添加对应引擎的依赖坐标如下：



    org.apache.velocity
    velocity-engine-core
    最新版本




    org.freemarker
    freemarker
    最新版本

切换模板引擎

// 切换为 freemarker 模板引擎
mpg.setTemplateEngine(new FreemarkerTemplateEngine());

自定义模板引擎

请继承类 com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine

CRUD 接口

Mapper CRUD 接口

说明:

通用 CRUD 封装BaseMapper接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器

泛型 T 为任意实体对象

参数 Serializable 为任意类型主键 Mybatis-Plus 不推荐使用复合主键约定每一张表都有自己的唯一 id 主键

对象 Wrapper 为条件构造器

insert

/**
 * 
 * 插入一条记录
 * 
 *
 * @param entity 实体对象
 * @return 插入成功记录数
 */
int insert(T entity);

deleteById

/**
 * 
 * 根据 ID 删除
 * 
 *
 * @param id 主键ID
 * @return 删除成功记录数
 */
int deleteById(Serializable id);

deleteByMap

/**
 * 
 * 根据 columnMap 条件，删除记录
 * 
 *
 * @param columnMap 表字段 map 对象
 * @return 删除成功记录数
 */
int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

delete

/**
 * 
 * 根据 entity 条件，删除记录
 * 
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 * @return 删除成功记录数
 */
int delete(@Param(Constants.WRAPPER) Wrapper queryWrapper);

deleteBatchIds

/**
 * 
 * 删除（根据ID 批量删除）
 * 
 *
 * @param idList 主键ID列表(不能为 null 以及 empty)
 * @return 删除成功记录数
 */
int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);

updateById

/**
 * 
 * 根据 ID 修改
 * 
 *
 * @param entity 实体对象
 * @return 修改成功记录数
 */
int updateById(@Param(Constants.ENTITY) T entity);

update

/**
 * 
 * 根据 whereEntity 条件，更新记录
 * 
 *
 * @param entity        实体对象 (set 条件值,不能为 null)
 * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
 * @return 修改成功记录数
 */
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);

selectById

/**
 * 
 * 根据 ID 查询
 * 
 *
 * @param id 主键ID
 * @return 实体
 */
T selectById(Serializable id);

selectBatchIds

/**
 * 
 * 查询（根据ID 批量查询）
 * 
 *
 * @param idList 主键ID列表(不能为 null 以及 empty)
 * @return 实体集合
 */
List selectBatchIds(@Param(Constants.COLLECTION) Collection idList);

selectByMap

/**
 * 
 * 查询（根据 columnMap 条件）
 * 
 *
 * @param columnMap 表字段 map 对象
 * @return 实体集合
 */
List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

selectOne

/**
 * 
 * 根据 entity 条件，查询一条记录
 * 
 *
 * @param queryWrapper 实体对象
 * @return 实体
 */
T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);

selectCount

/**
 * 
 * 根据 Wrapper 条件，查询总记录数
 * 
 *
 * @param queryWrapper 实体对象
 * @return 满足条件记录数
 */
Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);

selectList

/**
 * 
 * 根据 entity 条件，查询全部记录
 * 
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 * @return 实体集合
 */
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);

selectMaps

/**
 * 
 * 根据 Wrapper 条件，查询全部记录
 * 
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 * @return 字段映射对象 Map 集合
 */
List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);

selectObjs

/**
 * 
 * 根据 Wrapper 条件，查询全部记录
 * 注意： 只返回第一个字段的值
 * 
 *
 * @param queryWrapper 实体对象封装操作类（可以为 null）
 * @return 字段映射对象集合
 */
List

MyBatis Plus 学习

前言

快速入门

简介

特性

框架结构

代码托管

快速开始

初始化工程

添加依赖

配置

编码

开始使用

小结

安装

Release

Snapshot

配置

核心功能

代码生成器

添加依赖

切换模板引擎

自定义模板引擎

CRUD 接口

Mapper CRUD 接口

Service CRUD 接口

updateBatchById

条件构造器

AbstractWrapper

groupBy

last

QueryWrapper

UpdateWrapper

使用 Wrapper 自定义SQL

分页插件

XML 自定义分页

Sequence主键

如何使用Sequence作为主键，但是实体主键类型是String

你可能感兴趣的:(MyBatis,Plus)