零碎03 MybatisPlus代码生成

最新推荐文章于 2025-02-03 16:52:32 发布
最新推荐文章于 2025-02-03 16:52:32 发布
阅读量1.2k 收藏 31
点赞数 13
分类专栏： 零碎知识点 文章标签： java 代码生成 mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Elaine2391/article/details/143975864
版权
  1. 目录

使用默认的模版引擎进行配置生成

一个简单的CodeGenerator实现：

MyBatis-Plus代码器官方默认模版：

1、entity.java.vm

2、controller.java.vm

3、service.java.vm

4、serviceImpl.java.vm

5、mapper.java.vm

6、mapper.xml.vm

官网地址：MyBatis-Plus 🚀 为简化开发而生

MyBatis-Plus 提供了一个强大的 代码生成器，可以根据数据库表结构自动生成对应的实体类、Mapper 接口、Mapper XML 文件、Service 和 Controller 等代码。它极大地提高了开发效率，减少了手动编写基础代码的工作量。通过配置代码生成器，开发者可以快速生成项目中常用的 CRUD 代码，并且可以自定义生成策略，灵活调整生成的代码结构。

什么是 MyBatis-Plus 代码生成器？ MyBatis-Plus 代码生成器基于模板引擎，可以自动生成以下内容：

  • 实体类：对应数据库表的 Java 实体类。

  • Mapper 接口：用于数据库访问的 Mapper 接口。

  • Mapper XML：与 Mapper 接口对应的 SQL 映射文件（可选）。

  • Service 和 ServiceImpl：业务逻辑层的接口和实现类。

  • Controller：处理 HTTP 请求的控制层代码（可选）。

通过代码生成器，开发者只需要配置好数据库连接和表名等信息，即可自动生成一套基础的代码结构，节省大量重复性工作。

使用默认的模版引擎进行配置生成

  • 引入依赖包：注意mybatis-plus-generator的3.5+版本是没有兼容历史版本的。

    MyBatis-Plus生成器官网地址：代码生成器 | MyBatis-Plus

    <dependencies>
    <!-- MyBatis-Plus 代码生成器 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.3.0</version>
    </dependency>
​
    <!-- 模板引擎（Freemarker 或 Velocity）-->
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.3</version>
    </dependency>
​
    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.31</version>
    </dependency>
</dependencies>
    一个简单的CodeGenerator实现：
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
​
/**
 * Mybatis代码生成器
 * @author lwer
 */
public class CodeGenerator {
    public static void main(String[] args) {
        // 1.创建代码生成器
        AutoGenerator generator = new AutoGenerator();
​
        // 2.全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir"); // 获取当前项目路径
        globalConfig.setOutputDir(projectPath + "/backend/src/main/java"); // 设置输出路径
        globalConfig.setFileOverride(true); // 是否覆盖已有文件
        globalConfig.setAuthor("lwer"); // 作者
        globalConfig.setSwagger2(true); // 是否开启swagger2
        globalConfig.setOpen(false); // 是否打开输出目录
        globalConfig.setServiceName("%sService");  // 去掉 Service 接口的首字母 I
        generator.setGlobalConfig(globalConfig);
​
        // 3.数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/blog?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai");
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("123456");
        dataSourceConfig.setDbType(DbType.MYSQL);
        generator.setDataSource(dataSourceConfig);
​
        // 4.包配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setParent("site.lwer.service"); // 设置父包名
        packageConfig.setEntity("entity"); // 设置实体包名
        packageConfig.setMapper("mapper"); // 设置mapper包名
        packageConfig.setXml("mapper.xml"); // 设置xml包名
        packageConfig.setService("service"); // 设置service包名
        packageConfig.setServiceImpl("service.impl"); // 设置service实现类包名
        generator.setPackageInfo(packageConfig);
​
        // 5.策略配置
        StrategyConfig strategiesConfig = new StrategyConfig();
        strategiesConfig.setNaming(NamingStrategy.underline_to_camel);  // 表名生成策略
        strategiesConfig.setColumnNaming(NamingStrategy.underline_to_camel); // 字段名生成策略
        strategiesConfig.setEntityLombokModel(true); //  启用lombok
        strategiesConfig.setRestControllerStyle(true); // 生成RestController
        strategiesConfig.setTablePrefix("sys_"); // 表名前缀
        // 需要生成的表名
        strategiesConfig.setInclude("sys_user","sys_role_permission");
​
        strategiesConfig.setControllerMappingHyphenStyle(true); //  URL 中驼峰转连字符
        generator.setStrategy(strategiesConfig);
​
        // 6.模板引擎配置
        generator.setTemplateEngine(new VelocityTemplateEngine());
​
        // 7.执行
        generator.execute();
    }
}
MyBatis-Plus代码器官方默认模版：

模板引擎是 velocity(默认引擎)

自己可根据需要稍作修改，如果要大改则需要去看模板引擎的语法了。

1、entity.java.vm
package ${package.Entity};
​
#foreach($pkg in ${table.importPackages})
import ${pkg};
#end
#if(${swagger2})
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
#end
#if(${entityLombokModel})
import lombok.Data;
import lombok.EqualsAndHashCode;
#if(${chainModel})
import lombok.experimental.Accessors;
#end
#end
​
/**
 * <p>
 * $!{table.comment}
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${entityLombokModel})
@Data
  #if(${superEntityClass})
@EqualsAndHashCode(callSuper = true)
  #else
@EqualsAndHashCode(callSuper = false)
  #end
  #if(${chainModel})
@Accessors(chain = true)
  #end
#end
#if(${table.convert})
@TableName("${table.name}")
#end
#if(${swagger2})
@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}> {
#else
public class ${entity} implements Serializable {
#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(${swagger2})
    @ApiModelProperty(value = "${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(${versionFieldName}==${field.name})
    @Version
#end
## 逻辑删除注解
#if(${logicDeleteFieldName}==${field.name})
    @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
    protected 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
}
2、controller.java.vm
package ${package.Controller};
​
​
import org.springframework.web.bind.annotation.RequestMapping;
​
#if(${restControllerStyle})
import org.springframework.web.bind.annotation.RestController;
#else
import org.springframework.stereotype.Controller;
#end
#if(${superControllerClassPackage})
import ${superControllerClassPackage};
#end
​
/**
 * <p>
 * $!{table.comment} 前端控制器
 * </p>
 *
 * @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
​
}
​
#end
3、service.java.vm
package ${package.Service};
​
import ${package.Entity}.${entity};
import ${superServiceClassPackage};
​
/**
 * <p>
 * $!{table.comment} 服务类
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${kotlin})
interface ${table.serviceName} : ${superServiceClass}<${entity}>
#else
public interface ${table.serviceName} extends ${superServiceClass}<${entity}> {
​
}
#end
4、serviceImpl.java.vm
package ${package.ServiceImpl};
​
import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${package.Service}.${table.serviceName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Service;
​
/**
 * <p>
 * $!{table.comment} 服务实现类
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
@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} {
​
}
#end
5、mapper.java.vm
package ${package.Mapper};
​
import ${package.Entity}.${entity};
import ${superMapperClassPackage};
​
/**
 * <p>
 * $!{table.comment} Mapper 接口
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${kotlin})
interface ${table.mapperName} : ${superMapperClass}<${entity}>
#else
public interface ${table.mapperName} extends ${superMapperClass}<${entity}> {
​
}
#end
6、mapper.xml.vm
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="${package.Mapper}.${table.mapperName}">
​
#if(${enableCache})
    <!-- 开启二级缓存 -->
    <cache type="org.mybatis.caches.ehcache.LoggingEhcache"/>
​
#end
#if(${baseResultMap})
    <!-- 通用查询映射结果 -->
    <resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
#foreach($field in ${table.fields})
#if(${field.keyFlag})##生成主键排在第一位
        <id column="${field.name}" property="${field.propertyName}" />
#end
#end
#foreach($field in ${table.commonFields})##生成公共字段
        <result column="${field.name}" property="${field.propertyName}" />
#end
#foreach($field in ${table.fields})
#if(!${field.keyFlag})##生成普通字段
        <result column="${field.name}" property="${field.propertyName}" />
#end
#end
    </resultMap>
​
#end
#if(${baseColumnList})
    <!-- 通用查询结果列 -->
    <sql id="Base_Column_List">
#foreach($field in ${table.commonFields})
        ${field.columnName},
#end
        ${table.fieldNames}
    </sql>
​
#end
</mapper>

mybatis-plus代码生成器
07-02
mybatis-plus代码生成器，自动生成，简便，快速
First:各种零碎代码
05-11
【标题】: "First:各种零碎代码" 是一个项目或者集合，其中包含了各种不同类型的代码片段，可能涵盖多个编程语言和技术领域。这个标题暗示了这是一个开发者用来存储、组织和分享代码示例或实用功能的地方。这些代码...
mybatis-plus自动生成代码（整理版）
郝南过的博客
11-21 4072
整理版，添加了注释模版，常用基础方法。也可直接替换成公共的或自己代码中自定义的。仅提供基础方法，可根据具体需求自行改造。仅提供基础方法，可根据具体需求自行改造。仅提供基础方法，可根据具体需求自行改造。
使用mybatisPlus插件生成代码步骤及注意事项
最新发布
XiaoyuEr_6688的博客
02-03 772
使用mybatisPlus插件可以很方便的生成与数据库对应的PO对象，以及对应的controller、service、ImplService、mapper代码，生成这种代码的方式有很多，包括mybatis-plus提供的代码生成器，以及idea提供的代码生成器，无论哪一种只要掌握了方法并熟练操作，都可以达到相同的效果，这里介绍采用mybatisPlus插件自动生成代码。
Mybatis-plus生成代码
qq_37128815的博客
07-12 902
生成模板，放在resources/templates文件夹里。
mybatis-plus代码生成
qq_43089596的博客
12-07 3146
mybatis-plus生成代码，以及代码的使用示例，包含自动生成crud、逻辑删除
MyBatis-Plus代码生成器
Flying_Fish_roe的博客
09-22 5251
实体类：对应数据库表的 Java 实体类。Mapper 接口：用于数据库访问的 Mapper 接口。Mapper XML：与 Mapper 接口对应的 SQL 映射文件（可选）。Service 和 ServiceImpl：业务逻辑层的接口和实现类。Controller：处理 HTTP 请求的控制层代码（可选）。通过代码生成器，开发者只需要配置好数据库连接和表名等信息，即可自动生成一套基础的代码结构，节省大量重复性工作。可以通过方法指定代码生成的输出路径。
MybatisPlus代码生成器
风止的博客
05-23 2056
MyBatis-Plus 的代码生成器主要是基于 MyBatis-Plus 的元数据分析功能，通过读取数据库中的表结构信息，生成对应的 Entity、Mapper、Service、Controller 等代码文件。代码生成器首先连接到数据库，读取数据库中的表结构信息，包括表名、字段名、字段类型、注释等元数据信息。代码生成器使用模板引擎来生成代码文件。模板文件定义了生成文件的结构和内容，其中可以包含一些占位符，用于动态替换成实际的数据，如表名、字段名等。
Mybatis-plus——代码生成器
weixin_61974247的博客
07-17 866
新版本：适用版本于mybatis-plus-generator 3.5.1 及其以上版本旧版本：适用版本于mybatis-plus-generator 3.5.1 以下版本。
wp-utils:我创建或策划修改的各种零碎代码以帮助 WordPress 开发
07-09
我创建和/或策划/修改的各种零碎代码以帮助 WordPress 开发。 祝浏览愉快！ :thumbs_up: 用法： 检查代码。 用你喜欢的。 问题？ 随意提出。 :grinning_face_with_smiling_eyes: 更多信息即将推出。 合法的 版权...
matlab代码转java-Tiny-Things-Archive:零碎文件的存档
05-23
matlab代码转java Tiny Things Collection 1. How to examine your device is Big-Endian mode or Little-Endian mode? Use union! Check out 1-Endian.cpp. union内的数据共享一片内存 2. Closure 闭包 Make the ...
零碎暗红记忆网页模板
01-14
"零碎暗红记忆"网页模板以暗红色调为主，通过精心搭配的颜色、图像和布局，创造出一种独特的视觉效果，适合那些希望打造具有个性和深度的网站。 【色彩心理学与设计】 暗红色通常被赋予强烈、激情和能量的含义，...
SAP ABAP 关键字语法图和 ABAP 代码自动生成工具 Code Composer
2007 年 ~ 2025 年，深耕 SAP 技术 18 年
04-30 1783
本文介绍的两个知识点比较零碎，所以我放在同一篇文章里来介绍。 Jerry在做SAP CRM Fiori应用开发时，在学习JavaScript时，读过这本书： 书中使用这种语法图讲解JavaScript的语法： 其实ABAP帮助文档里也存在类似的语法图，只是藏在一个不起眼的角落，不为大家所熟知： 以关键字APPEND为例，查看其语法图： 单击超链接，语法图就展示出来了，我觉得比帮助文档里的文...
Mybatis-plus代码生成器
m0_68076368的博客
04-17 634
【代码】Mybatis-plus代码生成器。
MyBatis-Plus代码生成
qq_44808710的博客
07-01 144
工程中可以直接复制
Mybatis Plus————代码生成器
热门推荐
Morty的技术乐园
06-17 11万+
代码生成器MyBatis Plus是MyBatis的扩展框架，而代码生成器是MP的核心功能之一，另外还有 “条件构造器”和“通用CRUD”等功能。步骤演示mp的代码生成器有两种方式自动生成代码，一种是通过main方法来执行程序，另一种是通过maven插件build产生。第二种方法需要在pom.xml中添加大量的配置信息，因此本人偏向于使用第一种方式。步骤如下：一、添加mybatis plus依赖：...
MyBatis-Plus 提供了自动生成代码超详细教程
qq_42631788的博客
07-23 3112
MyBatis-Plus 提供了自动生成代码的工具（代码生成器），可以快速生成实体类、Mapper 接口、Service 类以及 Controller 等代码。这大大提高了开发效率，特别是在处理大型项目时。
MyBatis-Plus--代码生成器/根据表生成代码--方法/实例
IT利刃出鞘的博客
09-26 7874
原文网址： 其他网址 官网 代码生成器 | MyBatis-Plus代码生成器配置 | MyBatis-Plus MyBatis-Plus代码生成器 - 掘金MyBatisPlus 3.x 代码生成器 - 简书Mybatis Plus————代码生成器_燃烧的小宇宙-优快云博客 简介 MybatisPlus的代码生成器很好用，可以根据表来生成Entity、Mapper、Service、Controller，非常方便，只需要配置数据库信息然后运行代码即可。 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Elaine202391

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值