Mybatis Plus的使用（Mybatis增强工具）- Mybatis从学习到忘记

概述

如果你是刚刚学习完Mybatis那么恭喜你，你竟然在起步阶段，就发现了一款可以让Mybatis起飞的东西；如果你是Mybatis熟客，或者是会使用Mybatis-generator、Mybatis-PageHelper、Mybatis通用mapper，那么也提前恭喜你，你可以放弃这些“散件”，只需要掌握今天这个东西，上面这些过客可以统统说“拜拜”了。Mybatis Plus看似有着一统Mybatis所有工具（插件）集的架势，那么等什么呢，开始吧！

 一、Mybatis-Plus（MP）简介

• MP官网：https://mp.baomidou.com/ 
• GigHub源码地址：https://github.com/baomidou/mybatis-plus
• MP宗旨：为简化开发而生
• MP愿景：成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。
• MP特性：

1. 润物无声：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
2. 效率至上：只需简单配置，即可快速进行 CRUD 操作，从而节省大量时间。
3. 丰富功能：热加载、代码生成、分页、性能分析等功能一应俱全。
4. 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
5. 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
6. 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
7. 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
8. 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
9. 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
10. 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
11. 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
12. 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
13. 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库
14. 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
15. 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

• MP经典主图（就想魂斗罗一样并肩作战）：

二、安装

Spring Boot项目添加Mybatis-plus的依赖如下：

    com.baomidou
    mybatis-plus-boot-starter
    3.1.2

Spring MVC项目添加Mybatis-plus的依赖如下：

    com.baomidou
    mybatis-plus
    3.1.2

三、配置

3.1 Spring Boot 工程：配置 MapperScan 注解

@SpringBootApplication
@MapperScan("com.xxx.xx.mapper") // 自己mapper所在的报名
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(QuickStartApplication.class, args);
    }
}

配置mapper的xml映射文件

mybatis-plus.mapper-locations=classpath*:mapper/*.xml

3.2 Spring MVC 工程：

3.2.1 配置 MapperScan

3.2.2 调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory

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

3.3 使用MP

使用其实很简单，只是让自己的Mapper继承MP的BaseMapper，那么自己的Mapper就可以愉快的使用BaseMapper的各种CRUD方法了

public class UserMapper extends BaseMapper {
    // 已经可以使用BaseMapper中的大量CRUD方法
}

怎么样除了在Mapper中继承了一个类，xml中没有任何修改，哪怕没有xml都可以对数据库进行操作了，简单使用就是这样，接下来看看MP有哪些有用的功能吧。 

四、核心功能

4.1 代码生成器（很好用的-选择使用）

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

4.1.1 添加 代码生成器 依赖

MyBatis-Plus 从3.0.3之后移除了代码生成器与模板引擎的默认依赖，需要手动添加代码生成器的依赖：

    com.baomidou
    mybatis-plus-generator
    latest-version

4.1.2 添加 模板引擎 依赖

MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。

• Velocity（默认）：

• 
      org.apache.velocity
      velocity-engine-core
      latest-velocity-version
  
  

• Freemarker：

• 
      org.freemarker
      freemarker
      latest-freemarker-version
  
  

 注意！如果您选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。

AutoGenerator generator = new AutoGenerator();

// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());

代码生成器 代码演示：

public class MPGenerator {

	// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
	public static String scanner(String tip) {
		Scanner scanner = new Scanner(System.in);
		StringBuilder help = new StringBuilder();
		help.append("请输入" + tip + "：");
		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.setFileOverride(false);
		gc.setAuthor("wtao");
		gc.setOpen(false);
		gc.setBaseColumnList(true);
		gc.setBaseResultMap(true);
		gc.setIdType(IdType.AUTO);
		// gc.setSwagger2(true); 实体属性 Swagger2 注解
		mpg.setGlobalConfig(gc);

		// 数据源配置
		DataSourceConfig dsc = new DataSourceConfig();
		dsc.setUrl("jdbc:mysql://127.0.0.1/mp?useUnicode=true&characterEncoding=utf-8");
		// dsc.setSchemaName("public");
		dsc.setDriverName("com.mysql.cj.jdbc.Driver");
		dsc.setUsername("root");
		dsc.setPassword("123456");
		mpg.setDataSource(dsc);

		// 包配置
		PackageConfig pc = new PackageConfig();
		pc.setModuleName(scanner("模块名"));
		pc.setParent("com.eyaoshun.crm");
		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) {
				// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
				return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
				+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
			}
		});
		/*
	        cfg.setFileCreate(new IFileCreate() {
	            @Override
	            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
	                // 判断自定义文件夹是否需要创建
	                checkDir("调用默认方法创建的目录");
	                return false;
	            }
	        });
		 */
		cfg.setFileOutConfigList(focList);
		mpg.setCfg(cfg);

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

		// 配置自定义输出模板
		//指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
		// templateConfig.setEntity("templates/entity2.java");
		// 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.setRestControllerStyle(true);
		strategy.setInclude("t_.*");
		strategy.setControllerMappingHyphenStyle(true);
		strategy.setTablePrefix("t_");
		mpg.setStrategy(strategy);
		
		// 模板引擎
		mpg.setTemplateEngine(new VelocityTemplateEngine());
		
		// 执行生成器
		mpg.execute();
	}

}

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

运行main->控制台输入"demo"后将生成的结构如下（resources下还有xml文件）：

4.2 CRUD 接口介绍(MP的核心功能）

4.2.1 Mapper CRUD 接口

• 通用 CRUD 封装BaseMapper 接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器
• 泛型 T 为任意实体对象
• 参数 Serializable 为任意类型主键 Mybatis-Plus 不推荐使用复合主键约定每一张表都有自己的唯一 id 主键
• 对象 Wrapper 为 条件构造器

其实我们真正在使用Mybatis时候核心就是使用接口编程，MP帮助我们创建了大量的公共接口和实现，我们只需要再在自己的Mapper接口中继承BaseMapper接口即可使用其内部的各CRUD方法了。提供的方法如下：

//// 插入一条记录
int insert(T entity);

// 根据 ID 删除
int deleteById(Serializable id);
// 根据 columnMap 条件，删除记录，  参数为表字段 map 对象
int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);
// 根据 entity 条件，删除记录
int delete(@Param(Constants.WRAPPER) Wrapper wrapper);
// 删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);

// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);
// 根据 whereEntity 条件，更新记录
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);

// 根据 ID 查询
T selectById(Serializable id);
// 查询（根据ID 批量查询）
List selectBatchIds(@Param(Constants.COLLECTION) Collection idList);
// 查询（根据 columnMap 条件）
List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);
// 根据 entity 条件，查询一条记录
T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);
// 根据 Wrapper 条件，查询总记录数
Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);
// 根据 entity 条件，查询全部记录
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);
// 根据 Wrapper 条件，查询全部记录
List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);
//  根据 Wrapper 条件，查询全部记录
List