Springboot整合mybatis-plus利用到代码自动生成—>整合swagger–>整合控制台运行sql语句打印
一、Springboot整合mybatis-plus利用到代码自动生成
1.1创建一个springboot项目
添加上这几个有用的jar 若找不到后期可手动加上
创建出来后的结构
引入mybatis-plus和代码生成器相关pool文件到pom.xml
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
</dependency>
<!--mybatis-plus依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.2.0</version>
</dependency>
<!--mybatis-plus代码生成器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.2.0</version>
</dependency>
<!--引入freemarker,自动生成代码的时候会用到-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
1.2创建数据库表—(想自动生成一整套代码的表)如下图
1.3引入工具类 在我项目的com.demo1.mybatisplusdemo(按自己文件名来)下创建util文件夹,复制下面工具类
package com.demo.mybatisplusdemo.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;
/**
* @author JZJY
* @version 1.0
* @Description 代码生成器工具类
* 详细可参考官方文档:https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B
* @date 2020/10/28
*/
public class CodeGeneratorUtil {
public static final String DB_URL = "jdbc:mysql://localhost:3306/s?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.demo.mybatisplusdemo";
/**
* 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("123456");
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<FileOutConfig> 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();
}
}
可以好好看一下;特别注意两段代码
一切完成之后点击工具类中main方法,在控制台输入你的表名如果没有报错并且项目格式如下证明代码生成成功(但是现在还不能跑,项目启动不知道怎么读取扫描包啊文件等)
配置1:在启动器上面配置扫描(如图)
配置二:在resources下创建application.yml文件,配置数据源,端口号等等信息(如图) ---- 数据库名,账号密码等信息不要照抄
#服务端口号更改 (如果不更改默认访问8080端口)
server:
port: 8081
#数据源配置
spring:
datasource:
# driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/s?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&serverTimezone=UTC
username: root
password: 123456
#映射地点
mybatis-plus:
mapper-locations: classpath*:/mybatis/mapper/**Mapper.xml
配置完成后项目就能正常启动了,但是没有测试的东西。 所以我们要写点东西便于测试,在controller自动生成的方法上来一刀
重启项目,浏览器访问localhost:8081/user/test (端口号填写自己写的啊,照抄的就是8081,在application.yml上配置的那个) 就会出现
二、到此Springboot整合mybatis-plus利用到代码自动生成就完成了,但是不便于测试,我们进一步整合swagger
2.1添加pool文件 2.8.0版本的比较好看 2.5.0的不好看(自己见解)
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
2.2 与controller平级目录下创建config文件夹,写入SwaggerConfig配置(注意更改配置中的路劲信息),代码如下:
package com.demo1.mybatisplusdemo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @author JZJY
* @version 1.0
* @date 2020/10/29
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// 自行修改为自己的包路径
.apis(RequestHandlerSelectors.basePackage("com.demo1.mybatisplusdemo.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Springboot使用swagger在线文档")
.description("swagger UI接入教程")
//服务条款网
.termsOfServiceUrl("我的博客地址,x")
//版本号
.version("1.0")
.contact(new Contact("我的博客", "x", "x@qq.com"))
.build();
}
}
2.3重启项目后,登入localhost:8081/swagger-ui.html查看吧(端口号上面说过了,注意下),如图:
到此与swagger集成完毕,但是在测试过程中我们发现不能在控制台看到执行的sql语句,现在我们也把他也搞进去
三、在application.yml中继续添加
# 控制台打印sql语句
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
重启后通过swagger测试时就可以看到(如图)
这些也都是根据他人的自己结合慢慢摸索,适合初学者借鉴下。
第一次发文谢谢观看O(∩_∩)O