MybatisPlus 自定义.vm模板的生成
更新时间:2024年03月18日 14:54:25 作者:王卷卷.
为更加快捷方便的开发代码,使用MybatisPlus的代码自动生成功能,将一些繁琐的操作自动生成,本文主要介绍了MybatisPlus 自定义.vm模板的生成,感兴趣的可以了解一下
官方手册
Mybatis-Plus:
依赖
<!--引入MybatisPlus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.3.1</version> </dependency> <!--代码生成器--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.3.1</version> </dependency> <!--代码生成器:模板引擎依赖 Velocity--> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity</artifactId> <version>1.7</version> </dependency>
代码生成器配置
package com.xin.sbvms.utils; import com.baomidou.mybatisplus.generator.FastAutoGenerator; import com.baomidou.mybatisplus.generator.config.OutputFile; import com.baomidou.mybatisplus.generator.config.rules.DbColumnType; import java.sql.Types; import java.util.Collections; /** * @author WangXin * @description MyBatis-Plus代码生成器 * @date 2024/03/17 22:02 **/ public class CodeGenerator { public static void main(String[] args) { mpGenerator(); } private static void mpGenerator() { FastAutoGenerator.create("jdbc:mysql://localhost:3306/sbvms?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai", "root", "123456") .globalConfig(builder -> { builder.author("WangXin") // 设置作者 // .enableSwagger() // 开启 swagger 模式 .outputDir("D:\\Code\\Java\\SBV-MS\\src\\main\\java\\"); // 指定输出目录 }) .dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> { int typeCode = metaInfo.getJdbcType().TYPE_CODE; if (typeCode == Types.SMALLINT) { // 自定义类型转换 return DbColumnType.INTEGER; } return typeRegistry.getColumnType(metaInfo); })) .packageConfig(builder -> { builder.parent("com.xin.sbvms") // 设置父包名 .moduleName(null) // 设置父包模块名 .pathInfo(Collections.singletonMap(OutputFile.xml, "D:\\Code\\Java\\SBV-MS\\src\\main\\resources\\mapper\\")); // 设置mapperXml生成路径 }) .strategyConfig(builder -> { builder.entityBuilder().enableLombok(); // 开启lombok功能 builder.entityBuilder().enableFileOverride(); // 覆盖已生成文件 builder.controllerBuilder().enableFileOverride(). enableRestStyle(); // 开启Rest风格 builder.serviceBuilder().enableFileOverride(); builder.mapperBuilder().enableFileOverride(); builder.addInclude("sys_user") // 设置需要生成的表名 .addTablePrefix("t_", "sys_"); // 设置过滤表前缀 }) .templateConfig(builder -> { builder.controller("/templates/myController.java") // 指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别 .build(); // 指定模板 }) // .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板 .execute(); } }
controller模板
- 模板存放路径:resources/templates/myController.java.vm
- 包名:${package.Entity}
- 类名:${entity} 如 User
- 表面:${table.entityPath} 如 user
package ${package.Controller}; import com.baomidou.mybatisplus.extension.plugins.pagination.Page; import org.springframework.web.bind.annotation.*; import javax.annotation.Resource; import java.util.List; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import ${package.Service}.${table.serviceName}; import ${package.Entity}.${entity}; #if(${restControllerStyle}) import org.springframework.web.bind.annotation.RestController; #else import org.springframework.stereotype.Controller; #end #if(${superControllerClassPackage}) import ${superControllerClassPackage}; #end /** * $!{table.comment} 前端控制器 * * @author ${author} * @since ${date} */ #if(${restControllerStyle}) @RestController #else @Controller #end @RequestMapping("#if(${package.ModuleName})/${package.ModuleName}#end/#if(${controllerMappingHyphenStyle})${controllerMappingHyphen}#else${table.entityPath}#end") #if(${kotlin}) class ${table.controllerName}#if(${superControllerClass}) : ${superControllerClass}()#end #else #if(${superControllerClass}) public class ${table.controllerName} extends ${superControllerClass} { #else public class ${table.controllerName} { #end @Resource private ${table.serviceName} ${table.entityPath}Service; // 新增或者更新 @PostMapping("/add") public boolean save(@RequestBody ${entity} ${table.entityPath}){ return ${table.entityPath}Service.saveOrUpdate(${table.entityPath}); } @DeleteMapping("/{id}") public Boolean delete(@PathVariable Integer id){ return ${table.entityPath}Service.removeById(id); } @PostMapping("/del/batch") public boolean deleteBatch(@RequestBody List<Integer> ids){ return ${table.entityPath}Service.removeByIds(ids); } @GetMapping public List<${entity}> findAll(){ return ${table.entityPath}Service.list(); } @GetMapping("/{id}") public ${entity} findOne(@PathVariable Integer id){ return ${table.entityPath}Service.getById(id); } @GetMapping("/page") public Page<${entity}> findPage(@RequestParam Integer pageNum,@RequestParam Integer pageSize){ QueryWrapper<User> queryWrapper=new QueryWrapper<>(); queryWrapper.orderByDesc("id"); return ${table.entityPath}Service.page(new Page<>(pageNum,pageSize),queryWrapper); } } #end
Bug
自定义controller.java.vm 不生效
在生成器代码【CodeGenerator】中添加下面代码,引入自定义模板【myController.java.vm】
.templateConfig(builder -> { builder.controller("/templates/myController.java") // 指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别 .build(); // 指定模板 })
到此这篇关于MybatisPlus 自定义.vm模板的生成的文章就介绍到这了,更多相关MybatisPlus 自定义.vm模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
相关文章
SpringBoot整合Swagger和Actuator的使用教程详解
Swagger 是一套基于 OpenAPI 规范构建的开源工具,可以帮助我们设计、构建、记录以及使用 Rest API。本篇文章主要介绍的是SpringBoot整合Swagger(API文档生成框架)和SpringBoot整合Actuator(项目监控)使用教程。感兴趣的朋友一起看看吧2019-06-06
最新评论