SpringBoot中整合MyBatis-Plus的方法示例

今天带来SpringBoot中整合MyBatis-Plus的方法示例教程详解

MyBatis 框架相信大家都用过，虽然 MyBatis 可以直接在 xml 中通过 SQL 语句操作数据库，很是灵活。但正其操作都要通过 SQL 语句进行，就必须写大量的 xml 文件，很是麻烦。于是 MyBatis-Plus 应运而生，作为 MyBatis 的增强工具，更是为我们开发效率得到了质的飞跃。

一、简介

1、MyBatis

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

官方文档：
https://mybatis.org/mybatis-3/zh/index.html

2、MyBatis-Plus

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

官方文档：
https://mybatis.plus/guide/

二、开发前戏

1、引入 MyBatis-Plus

在 pom.xml 文件中引入 MyBatis-Plus 所需依赖

<!-- mybatis-plus -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.3.1</version>
</dependency>
<!-- mybatis-plus代码生成器 -->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-generator</artifactId>
  <version>3.3.1.tmp</version>
</dependency>
<!-- mybatisPlus Freemarker 模版引擎 -->
<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
</dependency>
<!-- mysql连接 -->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <scope>runtime</scope>
</dependency>

freemarker 作为 MyBatis-Plus 自动生成代码时作为模板使用，还可选用 velocity 作为模板

<dependency>
  <groupId>org.apache.velocity</groupId>
  <artifactId>velocity-engine-core</artifactId>
  <version>2.2</version>
</dependency>

本次我们选用 freemarker 作为模板

2、配置信息

在 application.yml 文件中，配置 mybatis-plus 的信息

# mybatis配置
mybatis-plus:
 # xml文件路径
 mapper-locations: classpath:mapper/*.xml
 # 实体类路径
 type-aliases-package: com.zyxx.sbm.entity
 configuration:
  # 驼峰转换
  map-underscore-to-camel-case: true
  # 是否开启缓存
  cache-enabled: false
  # 打印sql
  log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
 # 全局配置
 global-config:
  # 数据库字段驼峰下划线转换
  db-column-underline: true
  # id自增类型(数据库id自增)
  id-type: 0

我们主要配置了：

xml 文件的存放位置 实体类的存放位置 开启驼峰转换原则 开启缓存 打印 sql 日志 id 自增策略，有多种策略，如下：

/**
 * 数据库ID自增
 */
AUTO(0),
/**
 * 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
 */
NONE(1),
/**
 * 用户输入ID
 * <p>该类型可以通过自己注册自动填充插件进行填充</p>
 */
INPUT(2),

/* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
/**
 * 分配ID (主键类型为number或string）,
 * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
 *
 * @since 3.3.0
 */
ASSIGN_ID(3),
/**
 * 分配UUID (主键类型为 string)
 * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
 */
ASSIGN_UUID(4);

MyBatis-Plus 默认的是推特的“雪花算法”，但是这样生成的主键 id 会比较长，本次我们选择数据库自增策略

我们还需要在项目启动类加上

@MapperScan("com.zyxx.sbm.mapper")
@ComponentScan(basePackages = {"com.zyxx"})

扫描我们 mapper 包下面的文件，有时你会发现不在启动类当前包下面的文件无法扫描，于是加上第二个注解，扫描其他文件

3、自动生成代码类

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
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 org.apache测试数据mons.lang3.StringUtils;

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

/**
 * 代码生成器
 *
 * @Author Lizhou
 */
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();
    // TODO 全局配置
    GlobalConfig gc = new GlobalConfig();
    String projectPath = System.getProperty("user.dir");
    // 生成文件的输出目录【默认 D 盘根目录】
    gc.setOutputDir(projectPath + "/src/main/java");
    // 作者
    gc.setAuthor("lizhou");
    // 是否打开输出目录
    gc.setOpen(false);
    // controller 命名方式，注意 %s 会自动填充表实体属性
    gc.setControllerName("%sController");
    // service 命名方式
    gc.setServiceName("%sService");
    // serviceImpl 命名方式
    gc.setServiceImplName("%sServiceImpl");
    // mapper 命名方式
    gc.setMapperName("%sMapper");
    // xml 命名方式
    gc.setXmlName("%sMapper");
    // 开启 swagger2 模式
    gc.setSwagger2(true);
    // 是否覆盖已有文件
    gc.setFileOverride(true);
    // 是否开启 ActiveRecord 模式
    gc.setActiveRecord(true);
    // 是否在xml中添加二级缓存配置
    gc.setEnableCache(false);
    // 是否开启 BaseResultMap
    gc.setBaseResultMap(true);
    // XML columList
    gc.setBaseColumnList(false);
    // 全局 相关配置
    mpg.setGlobalConfig(gc);

    // TODO 数据源配置
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://127.0.0.1:3306/sbm?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC&useSSL=true&characterEncoding=UTF-8");
    dsc.setDriverName("com.mysql.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("123456");
    mpg.setDataSource(dsc);

    // TODO 包配置
    PackageConfig pc = new PackageConfig();
    // 父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
    pc.setParent("com.zyxx.sbm");
    // Entity包名
    pc.setEntity("entity");
    // Service包名
    pc.setService("service");
    // Service Impl包名
    pc.setServiceImpl("service.impl");
    mpg.setPackageInfo(pc);

    // TODO 自定义配置
    InjectionConfig cfg = new InjectionConfig() {
      @Override
      public void initMap() {
        // to do nothing
      }
    };
    // 输出文件配置
    List<FileOutConfig> focList = new ArrayList<>();
    focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
      @Override
      public String outputFile(TableInfo tableInfo) {
        // 自定义输入文件名称
        return projectPath + "/src/main/resources/mapper/" + tableInfo.getEntityName() + "Mapper.xml";
      }
    });
    // 自定义输出文件
    cfg.setFileOutConfigList(focList);
    mpg.setCfg(cfg);
    mpg.setTemplate(new TemplateConfig().setXml(null));

    // TODO 策略配置
    StrategyConfig strategy = new StrategyConfig();
    // 数据库表映射到实体的命名策略，驼峰原则
    strategy.setNaming(NamingStrategy.underline_to_camel);
    // 字数据库表字段映射到实体的命名策略，驼峰原则
    strategy.setColumnNaming(NamingStrategy.underline_to_camel);
    // 实体是否生成 serialVersionUID
    strategy.setEntitySerialVersionUID(false);
    // 是否生成实体时，生成字段注解
    strategy.setEntityTableFieldAnnotationEnable(true);
    // 使用lombok
    strategy.setEntityLombokModel(true);
    // 设置逻辑删除键
    strategy.setLogicDeleteFieldName("del_flag");
    // TODO 指定生成的bean的数据库表名
    strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
    // 驼峰转连字符
    strategy.setControllerMappingHyphenStyle(true);
    mpg.setStrategy(strategy);
    // 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！
    mpg.setTemplateEngine(new FreemarkerTemplateEngine());
    mpg.execute();
  }
}

我们需要改变的就是：

数据库的连接信息，地址，用户，密码 controller、service、mapper、xml 等文件的命名规则 生成文件 controller、service、mapper、xml 文件的存放位置 数据库与实体类之间的一些策略配置等

三、开发进行中

1、创建数据表

我们创建一个用户信息表 user_info

以上就是关于SpringBoot中整合MyBatis-Plus的方法示例全部内容,感谢大家支持。

查看更多关于SpringBoot中整合MyBatis-Plus的方法示例的详细内容...