51工具盒子# mybatis-plus 基础教程 {#mybatis-plus-基础教程}
本文讲述 springboot 集成 mybatis-plus 的具体步骤。mybatis-plus 是基于 mybatis 开发而来，在 MyBatis 的基础上只做增强不做改变,是 java 领域首选的 orm 框架。使用 mybatis-plus 可以大大提高开发效率，运用自带的代码生成工具(按模块生成)，可以几秒钟实现从数据库生成基础的 entity、dao、service、controller 代码。该框架内置了常用的单表操作接口，几乎能满足大部分场景，而无需再额外开发代码。
官方文档 (opens new window)的内容较多，本教程删繁就简，带您立刻入门！
# 基于 gradle 创建 springboot 项目 {#基于-gradle-创建-springboot-项目}
使用 idea 自带的 Spring Initializr 初始化 springboot 项目.
提示
若初始化后的项目编译失败, 解决方法详见初始化后的项目编译失败
# 集成 mybatis-plus {#集成-mybatis-plus}
# 添加依赖 {#添加依赖}
/****************** start mybatis-plus *****************/
compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '3.3.2'
// 反向代码生成器
compile 'com.baomidou:mybatis-plus-generator:3.3.2'
// freemarker模板引擎,mybatis-plus的代码生成工具可以使用该模板引擎生成代码
compile 'org.freemarker:freemarker:2.3.30'
/****************** end mybatis-plus *****************/
# 主函数的类上添加注解 MapperScan {#主函数的类上添加注解-mapperscan}
@SpringBootApplication
@MapperScan("com.ruiboyun.facehr.**.mapper")
public class FacehrApplication {
public static void main(String[] args) {
SpringApplication.run(FacehrApplication.class, args);
}
}
# 使用代码生成器逆向工程 {#使用代码生成器逆向工程}
通过代码生成器，从数据库反向生成 java 代码。
- 创建一个工具类 MybatisAutoGenerator
只需要修改类中的"作者信息","包名","数据库信息", 即可在任何项目中使用
package com.ruiboyun.facehr.util;
import com.baomidou.mybatisplus.annotation.IdType;
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;
/**
* mybatis-plus的代码生成器
* 只需要修改类中的"作者信息","包名","数据库信息", 即可在任何项目中使用
* 使用方法: 执行main函数即可
*/
public class MybatisAutoGenerator {
/**
* <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("Wang Shibiao");
gc.setOpen(false);
// ID生成策略配置为雪花算法
gc.setIdType(IdType.ASSIGN_ID);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/facehr?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名"));
pc.setParent("com.ruiboyun.facehr");
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("调用默认方法创建的目录，自定义目录用");
if (fileType == FileType.MAPPER) {
// 已经生成 mapper 文件判断存在，不想重新生成返回 false
return !new File(filePath).exists();
}
// 允许生成模板文件
return true;
}
});
*/
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("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
// strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
// strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
// strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
- 运行工具类的 main 函数 根据提示进行操作即可，最终会自动生成 model、dao、service、controller 层代码。
# 数据库配置 {#数据库配置}
#spring
spring:
#数据库配置
datasource:
url: jdbc:mysql://localhost/facehr
username: root
password: 123456
driver-class-name: com.mysql.jdbc.Driver
