环境
开发环境Win10、jdk1.8、MySQL8.0、SpringBoot2.5.6
创建工程
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qMV5CUkD-1635321952078)(http://note.makerknz.cn/image-20211002160053031.png)]
包名cn.makerknz.product.server
添加用到的库
使用Mybatis Plus
引入包
在build.gradle中添加
implementation group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '3.4.0'
/* 代码生成器依赖 */
testImplementation group: 'com.baomidou', name: 'mybatis-plus-generator', version: '3.4.0'
生成Mybatis 代码,将代码复制到test文件中,然后修改以下内容
package cn.makerknz.product.server;
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 org.springframework.boot.test.context.SpringBootTest;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
/**
* cn.makerknz.product.server
* 请输入表名,多个英文逗号分割:
* user,login_logs,product,product_topic_bind,device,connect_logs,device_events,application_token
*/
// 演示例子,执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
@SpringBootTest
public class CodeTableGenerator {
private static final String URL = "jdbc:mysql://192.168.31.216:3307/product_manager?useUnicode=true&useSSL=false&characterEncoding=utf8";
private static final String USERNAME = "product_manager";
private static final String PASSWORD = "product_manager";
/**
* <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.isNotBlank(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("maker knz");
gc.setOpen(false);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(URL);
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername(USERNAME);
dsc.setPassword(PASSWORD);
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName(scanner("输入模块的名称: "));
// pc.setParent("com.makerknz");
System.out.println(CodeTableGenerator.class.getPackage().getName());
pc.setParent(CodeTableGenerator.class.getPackage().getName());
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,并输入生成的表名,以逗号分开
cn.makerknz.product.server
请输入表名,多个英文逗号分割:
user,login_logs,product,product_topic_bind,device,connect_logs,device_events,application_token
修改配置
Mybatis Plus配置
在config包中添加MybatisPlusConfig.java文件
包括mapper包扫描和分页插件
package cn.makerknz.product.server.config;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @Author: maker_knz
* @Date: 2021/10/27/027 15:01
* @Version 1.0
*/
@Configuration
@MapperScan("cn.makerknz.product.server.mapper")
public class MybatisPlusConfig {
// 最新版分页插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
return interceptor;
}
}
数据库配置
在application.yml中添加
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://192.168.31.216:3307/product_manager?characterEncoding=utf-8&useSSL=false
username: product_manager
password: product_manager
测试
在user表中添加
INSERT INTO `product_manager`.`user`(`id`, `username`, `truename`, `icon`, `password`, `email`, `phone`, `role`, `user_desc`, `create_time`, `update_time`) VALUES (1, 'maker_knz', 'knz', NULL, '123456', '@qq.com', '123121231', 1, '测试', '2021-10-27 15:05:58', '2021-10-27 15:05:58');
在UserController中添加
@Autowired
private IUserService userService;
@GetMapping("/{id}")
public User user(@PathVariable("id") Integer id) {
return userService.getById(id);
}
在网页中访问
仓库地址
https://gitee.com/eaooglePlatform_he_jiaqi/product-manager-server/tree/%E9%A1%B9%E7%9B%AE%E5%88%9D%E5%A7%8B%E5%8C%96/
总结
本文介绍了使用IDEA创建产品服务的项目,并使用mybatis-plus-generator自动创建Mapper、Entiry、Service和Controller。并保证项目正常运行。