搭建spring boot + mybatis plus项目
最近看到不少人在用mybatis plus，代码生成工具更好用。想起之前用mybatis 自己花了很大的功夫去实现这个代码生成工具，生成的代码只有dao层（即，那个mapper）层。我们今天就来搭建一个spring boot + mybatis plus 项目，实现一个代码生成器。
1.准备
先来看看我们的数据库表，这里有一个student表，只有3个字段，如下图：
2. 搭建
2.1 先搭建一个基础springboot
（1）点击IDEA左上角的File | new Project 到下面界面
（2）点击Next，填写坐标等基本设置，如下图：
（3）点击Next，添加lombok，MySQL，web相关依赖，如下图：
（4）点击Next设置项目存放路径，如下图：
到这里我们一个基础的spring boot就有了，接下来在该项目上做修改。
2.2 修改pom文件
首先在pom文件中把springboot的版本修改为2.2.0，接着添加下面的依赖：
org.springframework
spring-jdbc
com.baomidou
mybatis-plus-boot-starter
3.2.0
com.baomidou
mybatis-plus-generator
3.2.0
org.freemarker
freemarker
2.3.30
整个pom文件内容如下：
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.2.0.RELEASE
com.cdd
mybatis-plus-demo
0.0.1-SNAPSHOT
mybatis-plus-demo
Demo project for Spring Boot
1.8
org.springframework.boot
spring-boot-starter-web
mysql
mysql-connector-java
runtime
org.springframework
spring-jdbc
com.baomidou
mybatis-plus-boot-starter
3.2.0
com.baomidou
mybatis-plus-generator
3.2.0
org.freemarker
freemarker
2.3.30
org.projectlombok
lombok
true
org.springframework.boot
spring-boot-starter-test
test
org.junit.vintage
junit-vintage-engine
org.springframework.boot
spring-boot-maven-plugin
2.3 修改配置文件
新建一个application.yml文件，配置如下：
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/spring-frame-db?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true
username: root
password: root
mybatis-plus:
mapper-locations: classpath*:/mybatis/mapper/**Mapper.xml2.4 配置maper接口扫描包
启动类上打上@MapperScan注解
2.5 编写代码生成器
（1）新建一个util包，编写代码生成的类CodeGeneratorUtil，放在该包下，内容如下：
package com.cdd.demo.util;
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;
/**
* @Description 代码生成器工具类
* 详细可参考官方文档：https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B
* @Author cdd
* @Date 2020/6/4
* @Vesrion v1.0
**/
public class CodeGeneratorUtil {
public static final String DB_URL = "jdbc:mysql://localhost:3306/spring-frame-db?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=UTC";
public static final String DB_DRIVER_NAME = "com.mysql.cj.jdbc.Driver";
public static final String BASE_PACKAGE_PATH = "com.cdd.demo";
/**
* Description: 窗口获取信息
* @Author: cdd
* @Param: [tip]
* @Return: java.lang.String
*/
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 + "！");
}
/**
* Description: 执行生成代码
* @Author: cdd
* @Param: []
* @Return: void
*/
public static void execute() {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir"); // 获取当前项目路径
gc.setOutputDir(projectPath + "/src/main/java"); // 设置基础包路径
gc.setAuthor("cdd"); // Mapper,Service等类注解中显示创建人信息
gc.setOpen(false); // 文件生成完毕后，是否需要打开所在路径
// gc.setSwagger2(true); // 实体属性 Swagger2 注解
// gc.setBaseColumnList(true); // 在Mapper.xml文件中是否生成公用SQL代码段
// gc.setBaseResultMap(true); // 在Mapper.xml文件中是否生成公用返回集合ResultMap
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(CodeGeneratorUtil.DB_URL);
// dsc.setSchemaName("public");
dsc.setDriverName(CodeGeneratorUtil.DB_DRIVER_NAME);
dsc.setUsername("root");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName(scanner("模块名")); // 模块名称
pc.setParent(CodeGeneratorUtil.BASE_PACKAGE_PATH); // 基础包路径
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/mybatis/mapper/" + 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);
mpg.setTemplate(new TemplateConfig().setXml(null));
// 策略配置，具体配置可查看官方文档：
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel); // Entity文件名称命名规范
strategy.setColumnNaming(NamingStrategy.underline_to_camel); // Entity字段名称
strategy.setRestControllerStyle(true); // Controller注解使用是否RestController标注,否则是否开启使用Controller标注
// strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!"); // Entity的公共父类
strategy.setEntityLombokModel(true); // 是否使用lombok完成Entity实体标注Getting Setting ToString 方法
strategy.setControllerMappingHyphenStyle(true); // Controller注解名称，不使用驼峰，使用连字符
// strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!"); // controller公共父类
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
// strategy.setTablePrefix(pc.getModuleName() + "_"); // 表前缀，添加该表示，则生成的实体，不会有表前缀，比如sys_dept 生成就是Dept
// strategy.setFieldPrefix("sys_"); // 字段前缀
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine()); // 用的是freeemarker模板引擎
mpg.execute();
}
public static void main(String[] args) {
execute();
}
} （2）运行该类的main方法，再输入表名，如下图：
（3）再来看看我们的项目结构，
3 测试
（1）在StudentController里面，我们来写一个接口测试下，StudentController类内容如下：
package com.cdd.demo.controller;
import com.cdd.demo.service.IStudentService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
/**
*
* 学生表 前端控制器
*
*
* @author cdd
* @since 2020-06-04
*/
@RestController
@RequestMapping("/student")
public class StudentController {
@Resource
IStudentService studentService;
@GetMapping("/test")
public Object test(){
return studentService.getById(1L);
}
}
（2）启动该项目，启动成功后，在浏览器地址栏输入：http://localhost:8080/student/test ,响应如下：
