MybatisPlus 自定义.vm模板的生成

 更新时间:2024年03月18日 14:54:25   作者:王卷卷.  
为更加快捷方便的开发代码,使用MybatisPlus的代码自动生成功能,将一些繁琐的操作自动生成,本文主要介绍了MybatisPlus 自定义.vm模板的生成,感兴趣的可以了解一下

官方手册

Mybatis-Plus:

代码生成器(新) | MyBatis-Plus

代码生成器配置新 | 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模板内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 举例详解Java编程中HashMap的初始化以及遍历的方法

    举例详解Java编程中HashMap的初始化以及遍历的方法

    这篇文章主要介绍了Java编程中HashMap的初始化以及遍历的方法,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-11-11
  • jmeter添加自定函数的实例(jmeter5.3+IntelliJ IDEA)

    jmeter添加自定函数的实例(jmeter5.3+IntelliJ IDEA)

    这篇文章主要介绍了jmeter添加自定函数的实例(jmeter5.3+IntelliJ IDEA),本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • Spring事件监听机制使用和原理示例讲解

    Spring事件监听机制使用和原理示例讲解

    Spring事件监听机制是一个很不错的功能,我们在进行业务开发的时候可以引入,在相关的开源框架中也是用它的身影,比如高性能网关ShenYu中就使用了Spring事件监听机制来发布网关的更新数据,它可以降低系统的耦合性,使系统的扩展性更好
    2023-06-06
  • Spring Boot 端口被占用的解决方法

    Spring Boot 端口被占用的解决方法

    这篇文章主要介绍了解决 Spring Boot 端口被占用的方法详解,通过本文的介绍,你学习了如何解决 Spring Boot 端口被占用的问题。你了解了检查端口是否被占用、停止占用端口的进程、更改应用程序的端口号以及检查应用程序间的端口冲突等方法,需要的朋友可以参考下
    2023-07-07
  • Java使用反射获取list泛型过程浅析

    Java使用反射获取list泛型过程浅析

    这篇文章主要介绍了Java使用反射获取list泛型过程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2023-02-02
  • Spring Retry重试框架的使用讲解

    Spring Retry重试框架的使用讲解

    重试的使用场景比较多,比如调用远程服务时,由于网络或者服务端响应慢导致调用超时,此时可以多重试几次。用定时任务也可以实现重试的效果,但比较麻烦,用Spring Retry的话一个注解搞定所有,感兴趣的可以了解一下
    2022-10-10
  • 使用httpclient无需证书调用https的示例(java调用https)

    使用httpclient无需证书调用https的示例(java调用https)

    这篇文章主要介绍了使用httpclient无需证书调用https的示例(java调用https),需要的朋友可以参考下
    2014-04-04
  • springboot如何使用assembly打包项目和启动脚本

    springboot如何使用assembly打包项目和启动脚本

    这篇文章主要介绍了springboot如何使用assembly打包项目和启动脚本问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-06-06
  • Spring boot异步任务原理全面分析

    Spring boot异步任务原理全面分析

    这篇文章主要介绍了Spring boot异步任务原理,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • spring boot 测试单元修改数据库不成功的解决

    spring boot 测试单元修改数据库不成功的解决

    这篇文章主要介绍了spring boot 测试单元修改数据库不成功的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09

最新评论