「Spring Boot架构」集成Mybatis-Plus的实例详解

Posted 2021-03-08 cqqfjy

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

特性

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

二、如何使用

1、项目pom.xml引入依赖

<!--mybatis-plus依赖-->
<dependency>
 <groupId>com.baomidou</groupId>
 <artifactId>mybatis-plus-boot-starter</artifactId>
 <version>3.2.0</version>
</dependency> 

2、User类

@Data
public class User {
 private Long id;
 private String name;
 private Date CreateDate;
} 

3、UserMapper类

public interface UserMapper extends BaseMapper<User> {
} 

4、application.yml

spring:
 datasource:
 url: jdbc:mysql://localhost:3306/testdb?characterEncoding=utf8
 username: root
 password: root
 driver-class-name: com.mysql.cj.jdbc.Driver 

5、app启动类，增加配置MapperScan自动扫描。

@SpringBootApplication
@MapperScan("com.example.mybatisplus.mapper")
public class MybatisPlusApplication {

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

} 

6、写单元测试类，进行测试。

@RunWith(SpringRunner.class)
@SpringBootTest
class MybatisPlusApplicationTests {

 @Autowired
 private UserMapper userMapper;

 @Test
 public void testSelect() {
 System.out.println(("----- selectAll method test ------"));
 List<User> userList = userMapper.selectList(null);
 //数据库目前两条数据，这块验证一下，如果数量一致则通过，就输出数据信息
 Assert.assertEquals(2, userList.size());
 userList.forEach(System.out::println);
 }
} 

 

 

三、代码生成器的使用

1、项目pom.xml增加依赖

<!--代码生成器-->
<dependency>
 <groupId>com.baomidou</groupId>
 <artifactId>mybatis-plus-generator</artifactId>
 <version>3.2.0</version>
</dependency>

<!--模板引擎-->
<dependency>
 <groupId>org.freemarker</groupId>
 <artifactId>freemarker</artifactId>
 <version>2.3.29</version>
</dependency> 

2、生成代码的工具类

package com.example.mybatisplus.service;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {
 /**
 * <p>
 * 读取控制台内容
 * </p>
 */
 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);
 // gc.setSwagger2(true); 实体属性 Swagger2 注解
 mpg.setGlobalConfig(gc);

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

 // 包配置
 PackageConfig pc = new PackageConfig();
 pc.setModuleName(scanner("模块名"));
 pc.setParent("com.example.mybatisplus.mybatis");
 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<FileOutConfig> 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.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
 strategy.setEntityLombokModel(true);
 strategy.setRestControllerStyle(true);
 // 公共父类
 strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
 // 写于父类中的公共字段
 strategy.setSuperEntityColumns("id");
 strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
 strategy.setControllerMappingHyphenStyle(true);
 strategy.setTablePrefix(pc.getModuleName() + "_");
 mpg.setStrategy(strategy);
 mpg.setTemplateEngine(new FreemarkerTemplateEngine());
 mpg.execute();
 }
} 

3、运行工具类，如下：