Mybatis-Plus代码生成器

最新推荐文章于 2025-10-13 11:19:54 发布
原创 最新推荐文章于 2025-10-13 11:19:54 发布 · 1.1k 阅读 · 7 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#mybatis #java #开发语言

Mybatis-Plus代码生成器

前言：这里提供了两种不同版本的代码生成器(一种是mybatis-plus3.3.1以下版本的，一种是3.3.1以上版本的)，根据自己的需求配置就可以了，大致都差不多

1、导入所需要的依赖
<dependencies>
    <!--Mybatis-Plus自动生成代码-->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.3.1</version><!--旧-->
        <!--            <version>3.5.2</version>&lt;!&ndash;新&ndash;&gt;-->
    </dependency>
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>3.3.1</version><!--旧-->
        <!--            <version>3.5.2</version>&lt;!&ndash;新&ndash;&gt;-->
    </dependency>
    <!--模板引擎依赖-->
    <!--velocity-->
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.0</version>
    </dependency>
    <!--freemarker-->
    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
    </dependency>
    <!--ibeetl-->
    <!--        <dependency>-->
    <!--            <groupId>com.ibeetl</groupId>-->
    <!--            <artifactId>beetl</artifactId>-->
    <!--        </dependency>-->
    <!--mysql-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.29</version>
    </dependency>
<!--       非必要      -->       
    <!--lombok依赖-->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.24</version>
    </dependency>
    <!--Swagger2-->
    <!--Swagger-UI-->
    <!--访问路径：http://IP:端口/swagger-ui.html-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    <!--swaggerui  几个自定义界面方便查看接口-->
    <!--访问路径：http://IP:端口/doc.html-->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>swagger-bootstrap-ui</artifactId>
        <version>1.9.6</version>
    </dependency>
    <dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version>25.1-jre</version>
    </dependency>
    <!--web依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.7.1</version>
    </dependency>
<!--       非必要      -->  
</dependencies>
2、从官网copy-demo到自己的路径

请添加图片描述

3、修改部分信息实现自己想要的效果

3.1旧版代码生成器

/** Mybatis-Plus代码生成器（实现自动生成代码）
 * @Author zzw
 * @Create
 * @Description
 */
public class OldAutoCodeGenerator {

    /**
     * <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("zzw");
        // 打开输出目录
        gc.setOpen(false);
        // xml开启BaseResultMap
        gc.setBaseResultMap(true);
        // xml开启BaseColumnList
        gc.setBaseColumnList(true);
        //实体属性 Swagger2 注解
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/usertest?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
//        pc.setModuleName(scanner("模块名:"));
        pc.setParent("com.example.demo")
                .setEntity("model")
                .setMapper("mapper")
                .setService("service")
                .setServiceImpl("service.impl")
                .setController("controller");
        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/"
                        + 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.setFileCreate((configBuilder, fileType, filePath) -> {
            //如果是Entity则直接返回true表示写文件
            if (fileType == FileType.ENTITY&&fileType == FileType.MAPPER) {
                return true;
            }
            //否则先判断文件是否存在
            File file = new File(filePath);
            boolean exist = file.exists();
            if (!exist) {
                file.getParentFile().mkdirs();
            }
            //文件不存在或者全局配置的fileOverride为true才写文件
            return !exist || configBuilder.getGlobalConfig().isFileOverride();
        });
        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("你自己的父类实体,没有就不用设置!");
        // 是否启用Lombok注解
        strategy.setEntityLombokModel(true);
        // 是否启用RestController注解
        strategy.setRestControllerStyle(true);
        // 公共父类
//        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
//        strategy.setSuperEntityColumns("id");
        // 生成实体类与数据库映射关系@TableFieId
        strategy.setEntityTableFieldAnnotationEnable(true);
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        // 是否生成controller Mapping路径
        strategy.setControllerMappingHyphenStyle(true);
//        strategy.setTablePrefix(pc.getModuleName() + "_");
        // 排除表前缀
        strategy.setTablePrefix("sys_");
        mpg.setStrategy(strategy);
        // 模板生成器
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

3.2新版代码生成器

public class NewAutoCodeGenerator {

    /**
     * <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) {
        String url = "jdbc:mysql://localhost:3306/userTest?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai";
        String username = "root";
        String password = "root";
        //表名集合
        List<String> tables = new ArrayList<>();
        String stringBuilder=new String(scanner("表名,用逗号隔开"));
        String[] split = stringBuilder.split(",", 0);
        for (String str:split){
            tables.add(str);
        }

        FastAutoGenerator.create(url, username, password)
                //全局配置
                .globalConfig(builder -> {
                    builder.fileOverride()   //    开启覆盖之前生成的文件
                            .disableOpenDir()  //禁止打开输出目录
                            .outputDir(System.getProperty("user.dir") + "\\zzw-generator\\src\\main\\java")   //指定输出目录
                            .author("zzw")   //作者名
                            //.enableKotlin()      //开启 kotlin 模式
                            .enableSwagger()     //开启 swagger 模式
                            .dateType(DateType.TIME_PACK)   //时间策略
                            .commentDate("yyyy-MM-dd");   //注释日期
                })
                //包配置
                .packageConfig(builder -> {
                    builder.parent("com.example.demo")     //父包名
                            .entity("model")                 //Entity 包名
                            .service("service")             // Service 包名
                            .serviceImpl("service.impl")    //Service Impl 包名
                            .mapper("mapper")               //Mapper 包名
                            .xml("mapper.xml")              // Mapper XML 包名
                            .controller("controller")       //Controller 包名
                            .other("config")                //自定义文件包名  输出自定义文件时所用到的包名
                            .pathInfo(Collections.singletonMap(OutputFile.xml, System.getProperty("user.dir") + "\\zzw-generator\\src\\main\\resources\\mapper"));//指定xml位置
                })
                //策略配置
                .strategyConfig(builder -> {
                    builder.addInclude(tables)
                            .addTablePrefix("sys_")//表名前缀，配置后生成的代码不会有此前缀
                            .serviceBuilder()
                            .formatServiceFileName("%sService")//服务层接口名后缀
                            .formatServiceImplFileName("%sServiceImpl")//服务层实现类名后缀
                            .entityBuilder()
                            .enableLombok()//实体类使用lombok,需要自己引入依赖
                            //.logicDeleteColumnName("status")//逻辑删除字段，使用delete方法删除数据时会将status设置为1。调用update方法时并不会将该字段放入修改字段中，而是在条件字段中
                            .enableTableFieldAnnotation()//加上字段注解@TableField
                            .controllerBuilder()
                            .formatFileName("%sController")//控制类名称后缀
                            .enableRestStyle()
                            .mapperBuilder()
                            .enableBaseResultMap() // 生成映射关系
                            .enableBaseColumnList() // 生成sql列
                            .superClass(BaseMapper.class)
                            .formatMapperFileName("%sMapper")
//                            .enableMapperAnnotation() // 生成@Mapper映射注解
                            .formatXmlFileName("%sMapper");
                })
                .execute();
    }
}

注意：数据库配置都需要配置自己的信息

4、测试

4.1输入表名

请添加图片描述

4.2查看测试结果

未测试前

请添加图片描述

测试之后

请添加图片描述

这样就是代码生成成功了

5、效果

5.1 实体类model

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("user_test")
@ApiModel(value="UserTest对象", description="")
public class UserTest implements Serializable {

    private static final long serialVersionUID = 1L;

    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    @TableField("username")
    private String username;

    @TableField("password")
    private String password;

    @TableField("nickName")
    private String nickName;

    @TableField("createTime")
    private LocalDateTime createTime;

    @TableField("updateTime")
    private LocalDateTime updateTime;
    
}

5.2 mapper业务访问层

public interface UserTestMapper extends BaseMapper<UserTest> {

}

5.3 mapper.xml(SQL编写)业务访问层

<?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="com.example.demo.mapper.UserTestMapper">

    <!-- 通用查询映射结果 -->
    <resultMap id="BaseResultMap" type="com.example.demo.model.UserTest">
        <id column="id" property="id" />
        <result column="username" property="username" />
        <result column="password" property="password" />
        <result column="nickName" property="nickName" />
        <result column="createTime" property="createTime" />
        <result column="updateTime" property="updateTime" />
    </resultMap>

    <!-- 通用查询结果列 -->
    <sql id="Base_Column_List">
        id, username, password, nickName, createTime, updateTime
    </sql>

</mapper>

5.4 服务类

public interface IUserTestService extends IService<UserTest> {

}

5.5 服务实现类

@Service
public class UserTestServiceImpl extends ServiceImpl<UserTestMapper, UserTest> implements IUserTestService {

}

5.6 前端控制器

@RestController
@RequestMapping("/user-test")
public class UserTestController {

}

至此我们代码生成器功能就实现了

微风粼粼
关注
mybatis-plus代码生成器
07-02
mybatis-plus代码生成器，自动生成，简便，快速
mybatis-plus代码生成器模版代码
08-17
本资源包含的是Mybatis-Plus的代码生成器模板代码，用于自动生成符合项目规范的Java实体类、Mapper接口及XML配置文件，提高开发效率。 代码生成器是开发中的利器，它能够根据数据库表结构快速生成对应的Java代码，...
mybatis-plus代码生成器(没有生成id问题)
weixin_43928962的博客
09-19 3221
package com.playjoy.platform.generator; import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.core.toolkit.StringUtils; import com.baomidou.mybatispl.
MyBatis-Plus 代码生成器入门保姆级教程：一键生成实体、Mapper、Service！
最新发布
学习笔记
10-13 1027
本文介绍了MyBatis-Plus代码生成器的两种工程模式：正向工程和逆向工程。正向工程是从代码生成数据库结构，适合初期设计阶段；逆向工程则是从数据库生成代码，适用于已有数据库项目。重点讲解了MyBatis逆向工程的具体实现步骤：1）创建数据库表；2）新建专用Module并导入相关依赖；3）编写生成器Java类进行配置。通过FastAutoGenerator可以快速生成实体类、Mapper接口、Service等代码文件，提高开发效率。文章最后提供了官网链接以获取更多配置功能。
MybatisPlus代码生成器
风止的博客
05-23 2342
MyBatis-Plus 的代码生成器主要是基于 MyBatis-Plus 的元数据分析功能，通过读取数据库中的表结构信息，生成对应的 Entity、Mapper、Service、Controller 等代码文件。代码生成器首先连接到数据库，读取数据库中的表结构信息，包括表名、字段名、字段类型、注释等元数据信息。代码生成器使用模板引擎来生成代码文件。模板文件定义了生成文件的结构和内容，其中可以包含一些占位符，用于动态替换成实际的数据，如表名、字段名等。
精选资源
非常好用的mybatis-plus代码生成器
05-20
Mybatis-Plus是一款基于Mybatis框架的扩展工具，它在Mybatis的基础上简化了开发工作，提供了许多便捷的功能，包括自动代码生成器。这个"非常好用的mybatis-plus代码生成器"能够帮助开发者快速生成常见的CRUD操作代码...
精选资源
mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip
07-20
mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip ...
mybatis-plus代码生成器配置文档
11-01
本文档详细介绍了MyBatis-Plus代码生成器的配置方法，包括数据源配置、数据库表配置、包名配置、模板配置、全局策略配置和注入配置等。 首先，我们需要了解MyBatis-Plus代码生成器的几个核心配置类： 1. ...
精选资源
mybatis-plus 代码生成器
09-05
在本项目中，我们关注的是 "mybatis-plus 代码生成器"，这是一个强大的工具，能够自动生成基于 MyBatis-Plus 的实体类、Mapper 接口及实现、XML 映射文件，从而极大地提高了开发效率，减少了手动编写重复代码的时间...
MyBatis-Plus代码生成器
Flying_Fish_roe的博客
09-22 6574
实体类：对应数据库表的 Java 实体类。Mapper 接口：用于数据库访问的 Mapper 接口。Mapper XML：与 Mapper 接口对应的 SQL 映射文件（可选）。Service 和 ServiceImpl：业务逻辑层的接口和实现类。Controller：处理 HTTP 请求的控制层代码（可选）。通过代码生成器，开发者只需要配置好数据库连接和表名等信息，即可自动生成一套基础的代码结构，节省大量重复性工作。可以通过方法指定代码生成的输出路径。
Mybatis Plus 代码生成器
qq_45740503的博客
03-09 367
Mybatis Plus 代码生成器
Mybatis-plus——代码生成器
weixin_61974247的博客
07-17 1043
新版本：适用版本于mybatis-plus-generator 3.5.1 及其以上版本旧版本：适用版本于mybatis-plus-generator 3.5.1 以下版本。
MybatisPlus的代码生成器
Skiray的博客
08-03 349
MybatisPlus代码生成器，可根据数据库快捷生成实体类，service,mapper等模板。 public void genCode() { // 1、创建代码生成器 AutoGenerator mpg = new AutoGenerator(); // 2、全局配置 GlobalConfig gc = new GlobalConfig(); String projectPath = System.getPrope.
Mybatis-Plus代码生成器(含代码+详细版)
weixin_45969142的博客
02-21 3704
Mybatis-Plus代码生成器 有时候我们拿到数据库，写接口啥的就显得很累。毕竟十几个数据库，每一个接口都得重复的写，pojo层，service层等信息，都是否有点不耐烦了？所以Mybatis-Plus代码生成器，就是为解决这个的。 1.添加依赖 <!--Mybatis-Plus生成器依赖--> <dependency> <groupId>com.baomidou</groupId>
mybatis-plus-generator快速代码生成
zbh17378211664的博客
05-09 258
自动生成
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值