Mybatis-Plus 代码生成器（java.vm配置文件）

已于 2023-05-06 11:51:32 修改
阅读量1.5k 收藏 5
点赞数
文章标签： mybatis java spring boot
于 2023-05-05 19:02:02 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/L2735516933/article/details/130512955
版权

Mybatis-Plus 代码生成器的使用

一、项目目录结构
二、配置类
三、自定义配置文件
四、配置依赖


一、项目目录结构

下图目录都是展开状态
请添加图片描述

二、配置类

CodeGenerator.java

package com.xcdh.utils;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;

import java.util.Collections;

/**
 * @Author: XCDH
 * @Date: 2023/4/23 01:37
 * @Description:
 */
public class CodeGenerator {
    public static void main(String[] args) {
        generator();
    }

    public static void generator() {
        FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/xxx?serverTimezone=GMT%2B8&characterEncoding=utf-8&userSSL=false", "root", "xxx")
                .globalConfig(builder -> {
                    builder.author("xcdh") // 设置作者
                            .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir("/Users/xcdh/Documents/idea-projects/springboot_vue/mybatisplus-generator/src/main/java/"); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.xcdh") // 设置父包名
                            .moduleName(null) // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "/Users/xcdh/Documents/idea-projects/springboot_vue/mybatisplus-generator/src/main/resources/mapper/")); // 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.entityBuilder().enableLombok();// 启用lombok注解
                    builder.mapperBuilder().enableMapperAnnotation().build(); // 开启mapper注解(@Mapper)
                    builder.controllerBuilder().enableHyphenStyle()  // 开启访问路径 驼峰转连字符
                            .enableRestStyle();  // 开启生成@RestController 控制器
                    builder.addInclude("sys_role") // 设置需要生成的表名
                            .addTablePrefix("t_", "sys_"); // 设置过滤表前缀
                })
                .execute();
    }
}

三、自定义配置文件

  1. 配置文件需要放在 resources/templates文件夹下才生效
  2. 不要使用 idea 格式化以下自定义配置文件，否则生成出来的代码会很乱

controller.java.vm

package ${package.Controller};

import com.baomidou.mybatisplus.core.metadata.IPage;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import java.util.List;

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

/**
 * @Author: ${author}
 * @Date: ${date}
 * @Description:
 */
@Api("xxx接口")
#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;

    @ApiOperation("查询所有用户")
    @GetMapping
    public List<${entity}> findAll() {
        return ${table.entityPath}Service.list();
    }

    @ApiOperation("根据id查询用户")
    @GetMapping("/{id}")
    public ${entity} findOne(@PathVariable Integer id) {
        return ${table.entityPath}Service.getById(id);
    }

    @ApiOperation("根据分页查询用户")
    @GetMapping("/page")
    public IPage<${entity}> findPage(@RequestParam Integer pageNum, @RequestParam Integer pageSize, ${entity} ${table.entityPath}) {
        IPage<${entity}> page = ${table.entityPath}Service.getPage(pageNum, pageSize, ${table.entityPath});
        if (page.getCurrent() > page.getPages()) {
            page = ${table.entityPath}Service.getPage((int) page.getPages(), pageSize, ${table.entityPath});
        }
        return page;
    }

    @ApiOperation("添加或修改用户")
    @PostMapping
    public Boolean save(@RequestBody ${entity} ${table.entityPath}) {
        return ${table.entityPath}Service.saveOrUpdate(${table.entityPath});
    }

    @ApiOperation("根据id删除用户")
    @DeleteMapping("/{id}")
    public Boolean delete(@PathVariable Integer id) {
        return ${table.entityPath}Service.removeById(id);
    }

    @ApiOperation("根据id批量删除")
    @DeleteMapping("/del/batch")
    public Boolean deleteBatch(@RequestBody List<Integer> ids) {
        return ${table.entityPath}Service.removeBatchByIds(ids);
    }

}
#end

service.java.vm

package ${package.Service};

import com.baomidou.mybatisplus.core.metadata.IPage;
import ${superServiceClassPackage};
import ${package.Entity}.${entity};


/**
 * @Author: ${author}
 * @Date: ${date}
 * @Description:
 */
#if(${kotlin})
interface ${table.serviceName} : ${superServiceClass}<${entity}>
#else
public interface ${table.serviceName} extends ${superServiceClass}<${entity}> {

    IPage<${entity}> getPage(Integer pageNum, Integer pageSize, ${entity} ${table.entityPath});

}
#end

serviceImpl.java.vm

package ${package.ServiceImpl};

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import javax.annotation.Resource;

import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${package.Service}.${table.serviceName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Service;

/**
 * @Author: ${author}
 * @Date: ${date}
 * @Description:
 */
@Service
#if(${kotlin})
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>(), ${table.serviceName} {

}
#else
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> implements ${table.serviceName} {

    @Resource
    private ${table.mapperName} ${table.entityPath}Mapper;

    @Override
    public IPage<${entity}> getPage(Integer pageNum, Integer pageSize, ${entity} ${table.entityPath}) {
        IPage<${entity}> page = new Page<>(pageNum, pageSize);
        LambdaQueryWrapper<${entity}> qw = new LambdaQueryWrapper<>();
        // 添加条件...

        return page(page, qw);
    }

}
#end

mapper.java.vm

package ${package.Mapper};

import ${package.Entity}.${entity};
import ${superMapperClassPackage};
#if(${mapperAnnotation})
import org.apache.ibatis.annotations.Mapper;
#end

/**
 * @Author: ${author}
 * @Date: ${date}
 * @Description:
 */
#if(${mapperAnnotation})
@Mapper
#end
#if(${kotlin})
interface ${table.mapperName} : ${superMapperClass}<${entity}>
#else
public interface ${table.mapperName} extends ${superMapperClass}<${entity}> {

}
#end

entity.java.vm(改动较少)

package ${package.Entity};

#foreach($pkg in ${table.importPackages})
import ${pkg};
#end

#if(${swagger})
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
#end

#if(${entityLombokModel})
import lombok.Data;
#if(${chainModel})
import lombok.experimental.Accessors;
#end
#end

/**
 * @Author: ${author}
 * @Date: ${date}
 * @Description:
 */
#if(${entityLombokModel})
@Data
  #if(${chainModel})
@Accessors(chain = true)
  #end
#end
#if(${table.convert})
@TableName("${schemaName}${table.name}")
#end
#if(${swagger})
@ApiModel(value = "${entity}对象", description = "$!{table.comment}")
#end
#if(${superEntityClass})
public class ${entity} extends ${superEntityClass}#if(${activeRecord})<${entity}>#end {
#elseif(${activeRecord})
public class ${entity} extends Model<${entity}> {
#elseif(${entitySerialVersionUID})
public class ${entity} implements Serializable {
#else
public class ${entity} {
#end
#if(${entitySerialVersionUID})

    private static final long serialVersionUID = 1L;
#end
## ----------  BEGIN 字段循环遍历  ----------
#foreach($field in ${table.fields})

#if(${field.keyFlag})
#set($keyPropertyName=${field.propertyName})
#end
#if("$!field.comment" != "")
  #if(${swagger})
  @ApiModelProperty("${field.comment}")
  #else
    /**
     * ${field.comment}
     */
  #end
#end
#if(${field.keyFlag})
## 主键
  #if(${field.keyIdentityFlag})
  @TableId(value = "${field.annotationColumnName}", type = IdType.AUTO)
  #elseif(!$null.isNull(${idType}) && "$!idType" != "")
  @TableId(value = "${field.annotationColumnName}", type = IdType.${idType})
  #elseif(${field.convert})
  @TableId("${field.annotationColumnName}")
  #end
## 普通字段
#elseif(${field.fill})
## -----   存在字段填充设置   -----
  #if(${field.convert})
  @TableField(value = "${field.annotationColumnName}", fill = FieldFill.${field.fill})
  #else
  @TableField(fill = FieldFill.${field.fill})
  #end
#elseif(${field.convert})
  @TableField("${field.annotationColumnName}")
#end
## 乐观锁注解
#if(${field.versionField})
  @Version
#end
## 逻辑删除注解
#if(${field.logicDeleteField})
  @TableLogic
#end
  private ${field.propertyType} ${field.propertyName};
#end
## ----------  END 字段循环遍历  ----------

#if(!${entityLombokModel})
#foreach($field in ${table.fields})
  #if(${field.propertyType.equals("boolean")})
    #set($getprefix="is")
  #else
    #set($getprefix="get")
  #end

    public ${field.propertyType} ${getprefix}${field.capitalName}() {
        return ${field.propertyName};
    }

  #if(${chainModel})
    public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
  #else
    public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
  #end
        this.${field.propertyName} = ${field.propertyName};
  #if(${chainModel})
        return this;
  #end
    }
#end
## --foreach end---
#end
## --end of #if(!${entityLombokModel})--

#if(${entityColumnConstant})
  #foreach($field in ${table.fields})
    public static final String ${field.name.toUpperCase()} = "${field.name}";

  #end
#end
#if(${activeRecord})
  @Override
  public Serializable pkVal() {
  #if(${keyPropertyName})
      return this.${keyPropertyName};
  #else
      return null;
  #end
    }

#end
#if(!${entityLombokModel})
   @Override
    public String toString() {
        return "${entity}{" +
  #foreach($field in ${table.fields})
    #if($!{foreach.index}==0)
        "${field.propertyName}=" + ${field.propertyName} +
    #else
        ", ${field.propertyName}=" + ${field.propertyName} +
    #end
  #end
        "}";
    }
#end
}

四、配置依赖

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.10</version>
        <relativePath/>
    </parent>

    <groupId>com.xcdh</groupId>
    <artifactId>mybatisplus-generator</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
       
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.6</version>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        
        <dependency
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--swagger3-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

        <!--mybatis-plus代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.1</version>
        </dependency>

        <!--模板引擎配置-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity</artifactId>
            <version>1.7</version>
        </dependency>
    </dependencies>

</project>
xcdh-lzj
关注
Mybaits-plus之代码生成器
weixin_47698446的博客
07-22 365
Mybaits-plus之代码生成器：实现entity层、mappper层（…、+.xml文件）、service层（…、impl实现层）、controller层。
MyBatis-Plus代码生成器配置及application文件配置
IceStreamLab
03-17 1898
一）、代码生成器配置 <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.0</version> </dependenc...
MybatisPlus代码生成器——自定义.vm模板
weixin_45761659的博客
03-18 1430
用MybatisPlus生成代码，引入自定义模板文件
MyBatis-Plus代码生成器
最新发布
Flying_Fish_roe的博客
09-22 2312
实体类：对应数据库表的 Java 实体类。Mapper 接口：用于数据库访问的 Mapper 接口。Mapper XML：与 Mapper 接口对应的 SQL 映射文件（可选）。Service 和 ServiceImpl：业务逻辑层的接口和实现类。Controller：处理 HTTP 请求的控制层代码（可选）。通过代码生成器，开发者只需要配置好数据库连接和表名等信息，即可自动生成一套基础的代码结构，节省大量重复性工作。可以通过方法指定代码生成的输出路径。
mybatisplus代码生成器
java_study_的博客
03-07 1122
通过mybatisplus代码生成器可以自动生成单表所有的类。 1、添加依赖 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.1</version> </
MybatisPlus学习（六）代码生成器详解
Code皮皮虾的博客
08-27 2567
文章目录1、代码生成器简介2、代码生成器配置3、运行结果 环境搭建请看该链接的MybatisPlus模块 1、代码生成器简介 AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。 2、代码生成器配置 添加依赖 <dependency> <groupId>com.baomid
MyBatis-Plus--代码生成器/根据表生成代码--方法/实例
IT利刃出鞘的博客
09-26 7477
原文网址： 其他网址 官网 代码生成器 | MyBatis-Plus代码生成器配置 | MyBatis-Plus MyBatis-Plus代码生成器 - 掘金MyBatisPlus 3.x 代码生成器 - 简书Mybatis Plus————代码生成器_燃烧的小宇宙-CSDN博客 简介 MybatisPlus的代码生成器很好用，可以根据表来生成Entity、Mapper、Service、Controller，非常方便，只需要配置数据库信息然后运行代码即可。 ...
Mybatis-plus自动生成代码
10-12
总的来说，Mybatis-plus的代码生成器是提高开发效率的有效工具，它简化了数据库与Java代码之间的映射过程，使得开发者可以更专注于业务逻辑的实现，而不是重复的基础工作。在实际项目中，合理运用代码生成器，能够...
mybatis-plus自动生成代码(包含swaager注解)
08-21
在实际项目中，我们需要在配置文件中设置 MyBatis-Plus 代码生成器的相关参数，如数据库连接信息、生成的包路径等。然后通过命令行或 IDE 插件运行生成器，即可快速生成代码。 通过以上步骤，MyBatis-Plus 代码...
springboot+mybatis-plus 代码生成器 CRUD 分页插件
12-21
在Spring Boot项目中，MyBatis-Plus是一个强大的扩展，为MyBatis提供了代码生成器和CRUD操作的便利。本篇文章将详细讲解如何利用Spring Boot集成MyBatis-Plus的代码生成器以及分页插件，以实现高效开发。 首先，你...
mybatis-plus代码生成器自动生成代码
qq_51979055的博客
06-20 1050
mybatis-plus代码生成器，快速生成
mybatis，mybatis-plus代码生成器
10-17
mybatis，mybatis-plus代码生成器,已经整理好了，两种方式，下载之后看说明
【SpringBoot】MyBatisPlus代码生成器
鹏啊鹏
05-01 1219
在SpringBoot中使用Mybatis-Plus代码生成器生成所有表的增删改查
MyBatis-Plus代码生成器（Maven3.5.7）
qq_55930097的博客
09-16 582
PS：青戈P11课程代码无法生成Controller代码可以试着粘贴下面的generate()代码。复制粘贴到pom.xml文件中，点击加载按钮重新加载所有的Maven项目。
Mybatis-Plus的代码生成器
qq_43223307的博客
11-22 479
一、介绍 代码生成器顾名思义就是为我们生成一些代码，省去了我们一些时间。AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity(pojo)、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率,MyBatis-Plus从3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖，才能实现代码生成器功能。 二、入门案例 （1）引入依赖 <de
MyBatis-Plus的代码生成器
qq_31275085的博客
01-23 659
.pom依赖文件 &lt;dependencies&gt; &lt;dependency&gt; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &lt;artifactId&gt;spring-boot-starter-web&lt;/artifactId&gt; ...
mybatis-plus 的代码生成器
menghunzhihun的博客
11-22 136
要学会偷懒，搞个代码生成器。 直接上连接： 链接：https://pan.baidu.com/s/1rVnmX76RLQzAlz9XxWu0Kw 提取码：1234 参考资料：https://baomidou.com/guide/generator.html#%E6%B7%BB%E5%8A%A0%E4%BE%9D%E8%B5%96 https://baomidou.com/config/#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE 步骤： 1、修改config.p..
mybatis- plus 代码生成器
JUN_LLLL的博客
03-24 231
详细配置和教程可以参考官方教程 public class CodeGenerator { private static String url ="jdbc:mysql://localhost:3306/demo?&serverTimezone = GMT"; private static String username = "root"; private st...
MyBatisPlus中的代码生成器
weixin_47316183的博客
07-02 1142
MyBatisPlus中的代码生成器
Mybatis-plus代码生成器在Spring Boot中的应用
资源摘要信息:"Spring Boot + mybatis-plus代码生成器 自动生成项目结构" Spring Boot和mybatis-plus是当前Java开发中非常流行的两个框架，它们可以非常有效地提高开发效率，降低开发难度。特别是mybatis-plus的...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值