mybatisPlus自动生成代码

最新推荐文章于 2024-07-09 11:22:32 发布
最新推荐文章于 2024-07-09 11:22:32 发布
阅读量1.7k 收藏 3
点赞数
分类专栏： mybatisplus 文章标签： generator
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/luo_yu_1106/article/details/108283482
版权

                     参考文章

本文完全是参考↑↑参考文章

通过这个配置可以生成mapper.xml,mapper,serviceImpl,controller等等

大概介绍一下，主要分为几个部分

首先，就是依赖

第二，就是一个自动生成代码需要的配置类generatorConfig.properties （修改这个表里的配置可以改变你要生成实体的表名，位置等等）

第三，就是生成器代码

第四，最重要的一步，把我的配置文件改成你的，目录改成你的（如果你不知道怎么改，建议直接在main方法入口打个断点，慢慢调试，就明白了）

好了，下面开始上代码

第一，pom中需要加入的依赖

<!-- mybatisPlus-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatisplus.version}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>

        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

      <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
            <scope>provided</scope>
        </dependency>

      <!--swagger 文档-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

（我的项目时多模块项目，我把这个的依赖放在parent的pom.xml中了） 

 

第二步，自动生成的配置文件 generatorConfig.properties

generator.jdbc.driverClass=com.mysql.cj.jdbc.Driver
generator.jdbc.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
generator.jdbc.username=root
generator.jdbc.password=123456

projectPackage=com.luoyu.service
#下面两个字段都是从项目名开始填
outputFilePath=/luoyu-demo-service/src/main/java/com/luoyu/service/
outputMapXmlFilePath=/luoyu-demo-service/src/main/resources/mapper/

# 表名 多表之间逗号分隔
tableNames=user

# 包配置
setMapper=mapper
setEntity=model
setService=service
setController=controller

 对应项目中的位置

 

第三步、生成器代码 CodeGenerator

package com.luoyu.service.generator;

import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

/**
 * Project code genertor
 *
 * @author zjx
 */
public class CodeGenerator {


    /**
     * Project package
     */
    private static String projectPackage;

    private static String outputFilePath;

    private static String outputMapXmlFilePath;

    private static String tableNames;

    /**
     * 包配置
     */
    private static String setMapper;
    private static String setEntity;
    private static String setService;
    private static String setController;

    /**
     * Database url
     */
    private static String url;
    /**
     * Database username
     */
    private static String username;
    /**
     * Database password
     */
    private static String password;
    /**
     * Database driver class
     */
    private static String driverClass;

    /**
     * 文件名后缀
     */
    private static String fileSuffix = ".java";

    /**
     * Init database information
     */
    static {
        Properties properties = new Properties();
        InputStream i = CodeGenerator.class.getResourceAsStream("/generatorConfig.properties");
        try {
            properties.load(i);
            url = properties.getProperty("generator.jdbc.url").trim();
            username = properties.getProperty("generator.jdbc.username").trim();
            password = properties.getProperty("generator.jdbc.password").trim();
            driverClass = properties.getProperty("generator.jdbc.driverClass").trim();
            projectPackage = properties.getProperty("projectPackage").trim();
            outputFilePath = properties.getProperty("outputFilePath").trim();
            outputMapXmlFilePath = properties.getProperty("outputMapXmlFilePath").trim();
            tableNames = properties.getProperty("tableNames").trim();
            setMapper = properties.getProperty("setMapper").trim();
            setEntity = properties.getProperty("setEntity").trim();
            setService = properties.getProperty("setService").trim();
            setController = properties.getProperty("setController").trim();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * main method, execute code generator
     */
    public static void main(String[] args) {
        String projectPath = System.getProperty("user.dir");

        String javaPath = projectPackage.replaceAll("\\.", "/");
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        gc.setAuthor("luoyu");
//        gc.setOpen(false); // 是否打开输出目录,设置为true就是直接弹出生成的文件目录
//        gc.setOutputDir(projectPath + "/src/main/java"); // 输出文件目录
        gc.setFileOverride(false); // 是否覆盖已有文件
        gc.setSwagger2(true);  // 实体属性 Swagger2 注解
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setBaseResultMap(true); // mapper.xml中生成BaseResultMap
        gc.setActiveRecord(true);
        gc.setBaseColumnList(true);

        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(url.trim());
        //dsc.setSchemaName("public");
        dsc.setUsername(username.trim());
        dsc.setPassword(password.trim());
        dsc.setDriverName(driverClass.trim());

        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent(projectPackage.trim());
        //pc.setModuleName("model名"); 自定义包名
        pc.setMapper(setMapper.trim());
        pc.setEntity(setEntity.trim());
        pc.setService(setService.trim());
        pc.setController(setController.trim());
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();

        /**mapper xml文件*/
        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {

            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + outputMapXmlFilePath + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }

        });
        /**控制层*/
        templatePath = "/templates/controller.java.ftl";
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 + pc.getModuleName()
                String expand = projectPath + outputFilePath + "controller";
                String entityFile = String.format(expand + File.separator + "%s" + fileSuffix, tableInfo.getControllerName());
                return entityFile;
            }
        });

        /**业务接口层*/
        templatePath = "/templates/service.java.ftl";
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 + pc.getModuleName()
                String expand = projectPath + outputFilePath + "service";
                String entityFile = String.format(expand + File.separator + "%s" + fileSuffix, tableInfo.getServiceName());
                return entityFile;
            }
        });
        /**业务实现层*/
        templatePath = "/templates/serviceImpl.java.ftl";
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 + pc.getModuleName()
                String expand = projectPath + outputFilePath + "service/impl";
                String entityFile = String.format(expand + File.separator + "%s" + fileSuffix, tableInfo.getServiceImplName());
                return entityFile;
            }
        });

        /**数据mapper层*/
        templatePath = "/templates/mapper.java.ftl";
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 + pc.getModuleName()
                String expand = projectPath + outputFilePath + "mapper";
                String entityFile = String.format(expand + File.separator + "%s" + fileSuffix, tableInfo.getMapperName());
                return entityFile;
            }
        });

        /**数据entity层*/
        templatePath = "/templates/entity.java.ftl";
        // 自定义配置会优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 + pc.getModuleName()
                String expand = projectPath + outputFilePath + "model";
                String entityFile = String.format(expand + File.separator + "%s" + fileSuffix, tableInfo.getEntityName());
                return entityFile;
            }
        });

		/*cfg.setFileOutConfigList(new IFileCreate() {
			@Override
			public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
				// 判断自定义文件夹是否需要创建
				checkDir("调用默认方法创建目录");
				return false;
			}
		});*/

        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        templateConfig.setController(null);
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setSuperEntityClass("");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        //strategy.setExclude("");
        // 表名
        strategy.setInclude(tableNames.split(","));
        strategy.setControllerMappingHyphenStyle(true);
        /**表前缀，要自动去除添加*/
        //strategy.setTablePrefix("t_");

        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        mpg.execute();
    }
}

我放在项目中的对应位置

 第四步、记得去修改成你本地的对应配置哦 

需要修改的地方

1.generatorConfig.properties

2.codeGenerator中类似于下图圈中的地方（就是实际配置目录的地方）

好了，记录一下，以防以后现找，正好大家一起学习

luo_yu_1106
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot+Mybatis整合完整源码
04-02
Spring Boot+Mybatis+Maven 整合项目，可供学习，教程地址https://blog.csdn.net/qq_33768099/article/details/79787215
Springboot整合Mybatis-plus源码项目IDEA
11-26
Springboot整合Mybatis-plus,环境找的时间有点久，所以特别发出来,碰到的bug当时也搞的挺久，适合新手搭建Mybatis-plus项目
【源码免费下载】SpringBoot整合Spring+SpringMVC+MyBatisPlus案例：图书管理系统
ebb29bbe的博客
03-29 1700
案例实现方案分析：实体类开发 —— 使用Lombok快速制作实体类Dao开发 —— 整合MyBatisPlus，制作数据层测试类Service开发 —— 整合MyBatisPlus进行增量开发，制作业务层测试类Controller开发 —— 基于Restful开发，使用PostMan测试接口功能Controller开发 —— 前后端开发协议制作页面开发 —— 基于VUE+ElementUI制作，前后端联调，页面数据处理，页面消息处理项目异常处理按条件查询 —— 页面功能调整、Controller修正功能、S
【MyBatis-Plus】 代码生成器使用指南——快速上手最好用的代码生成器！
最新发布
m0_67414667的博客
07-09 1708
MyBatis-Plus 是一个 MyBatis 的增强工具，简化了 MyBatis 的开发过程。作为一个 ORM 框架，MyBatis-Plus 提供了很多便捷的功能，其中之一就是代码生成器。代码生成器可以根据数据库表结构自动生成相应的实体类、Mapper 接口、Service 接口及其实现类等，大大提高了开发效率，减少了重复劳动。本文将详细介绍如何使用 MyBatis-Plus 的代码生成器生成 Java 代码，以便快速开始项目开发。
mybatis-plus自动生成代码
蒋劲豪的博客
05-31 387
最后大功告成，生成成功！
idea集成mybatisPlus代码生成器插件
m0_60499031的博客
09-03 952
因为我下了所以没有搜索到。重启完应该会出现这个选项。
SpringBoot集成MyBatis-Plus代码生成器Demo
mickey2007的博客
04-02 944
MyBatis-Plus（简称 MP）是一个MyBatis的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。官网:AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
springboot集成mybatis-plus（一）自动生成基础代码篇
qq_43436985的博客
09-12 2031
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录springboot集成mybatis-plus（一）自动生成基础代码篇前言一、mybatis-plus是什么？二、使用步骤1.引入mybatis-plus的依赖总结 springboot集成mybatis-plus（一）自动生成基础代码篇 前言 提示：体验mybatis-plus的强大： 只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。本文就介绍一下mybatis-plus的代码生成以及使用，本文基于springbo
mybatisplus代码生成器
苏凯的博客
02-25 3万+
官方文档：https://mp.baomidou.com/guide/ 逆向工程链接： https://pan.baidu.com/s/1FloqrIhI2d1ns4XgvYPIkA 目录结构： 生成 ：xml映射文件， mapper接口 ，service接口与实现， controller类 ，实体类与AR； XML映射文件可以不与mapper放一个包，可以自己...
017-2022最新版MyBatisplus代码生成器
学习笔记
05-16 2012
🧑‍🎓 个人主页：Silence Lamb 📖 本章内容：【MyBatis-Plus代码生成器】
SpringBoot+MybatisPlus+代码生成器整合(真正让你专心做业务)
热门推荐
warrior
05-25 5万+
项目目录结构： pom文件：   &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:sche...
springboot整合mybatis-plus，代码自动生成
cf
10-08 6872
Mybatis-Plus（简称MP）是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生   特性   无侵入：Mybatis-Plus 在 Mybatis 的基础上进行扩展，只做增强不做改变，引入 Mybatis-Plus 不会对您现有的 Mybatis 构架产生任何影响，而且 MP 支持所有 Mybatis 原生的特性 依赖少：仅...
SpringBoot集成MyBatis-Plus自动代码生成器（官方代码生成）
仲夏宁叶香的博客
01-01 6962
文档来源：https://baomidou.gitee.io/mybatis-plus-doc/#/generate-code 最新文档来源：https://mybatis.plus/guide/generator.html 本博客演示的是MyBatis-Plus2.X文档，如需要看最新文档内容的请移步最新文档查看 1. pom文件 <!-- MySQL数据库...
spring-boot mybatis-plus 集成 + 代码生成器自定义controller 模板
qq_33842795的博客
05-07 2万+
mybatis-plus3.x 代码生成器请看以下链接 https://blog.csdn.net/qq_33842795/article/details/103682488 maven依赖 spring boot 和 thymeleaf 结合 controller 返回的控制器路径不能以/ 开头 否则运行没问题，发布之后就找不到文件 <mybatispl...
SpringBoot整合Mybatis-plus（一）基本使用与自定义模板代码生成器
胖虎儿的博客
03-04 1万+
SpringBoot整合Mybatis-plus 代码生成以及基本使用（一） 本小章节学习内容是SpringBoot整合Mybatis-plus ,通过本文可以初步了解以及使用Mybatis-plus 以下简称mp ，掌握对mp代码生成器的使用（内置/自定义模板） MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提...
mybatisplus自动生成代码
05-13
MyBatis-Plus是一款优秀的MyBatis框架的增强工具包，它为MyBatis提供了许多强大的功能，其中就包括自动生成代码的功能。 使用MyBatis-Plus自动生成代码的步骤如下： 1. 首先在项目的pom.xml文件中添加MyBatis-Plus的依赖： ```xml <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.1</version> </dependency> ``` 2. 在application.yml或application.properties文件中配置MyBatis-Plus的自动生成代码的相关配置，例如： ```yaml # 数据源配置 spring: datasource: url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC username: root password: root # MyBatis-Plus配置 mybatis-plus: # 实体扫描，多个package用逗号或者分号分隔 typeAliasesPackage: com.example.demo.entity # XML文件路径 mapperLocations: classpath:/mapper/*.xml # 自动填充配置 global-config: db-config: # 自动填充配置 field-strategy: not_null # 数据库主键自增策略 id-type: auto # 字段名下划线转驼峰 column-underline: true # 代码生成器配置 generator: # 生成文件输出目录 output-dir: src/main/java # 是否覆盖已有文件 fileOverride: true # 是否开启swagger注解 swagger2: true # 自定义文件命名，注意 %s 会自动填充表实体属性！ entity-name: %sEntity mapper-name: %sMapper xml-name: %sMapper service-name: %sService service-impl-name: %sServiceImpl controller-name: %sController # 指定生成的表名，多个表名用逗号分隔 include: user, role # 排除生成的表名，多个表名用逗号分隔 exclude: test, demo # 自定义继承的Entity类全称，带包名 super-entity-class: com.example.demo.common.BaseEntity # 自定义继承的Mapper类全称，带包名 super-mapper-class: com.example.demo.common.BaseMapper # 自定义继承的Service类全称，带包名 super-service-class: com.example.demo.common.BaseService # 自定义继承的ServiceImpl类全称，带包名 super-service-impl-class: com.example.demo.common.BaseServiceImpl # 自定义继承的Controller类全称，带包名 super-controller-class: com.example.demo.common.BaseController # 是否去掉生成实体时生成的get、set方法 entity-boolean-logic: false # 是否支持 ActiveRecord 模式 active-record: true # 是否生成实体时，生成字段注解 entity-column-annotation-enable: true # 是否生成 @RestController 控制器 rest-controller-style: true ``` 3. 在项目中创建一个代码生成器的类，例如： ```java package com.example.demo.generator; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.generator.AutoGenerator; import com.baomidou.mybatisplus.generator.config.*; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; public class CodeGenerator { public static void main(String[] args) { // 代码生成器 AutoGenerator mpg = new AutoGenerator(); // 全局配置 GlobalConfig gc = new GlobalConfig(); gc.setOutputDir(System.getProperty("user.dir") + "/src/main/java"); gc.setAuthor("your name"); gc.setOpen(false); gc.setFileOverride(true); gc.setActiveRecord(false); gc.setEnableCache(false); gc.setBaseResultMap(true); gc.setBaseColumnList(true); gc.setIdType(IdType.AUTO); gc.setServiceName("%sService"); gc.setServiceImplName("%sServiceImpl"); gc.setControllerName("%sController"); mpg.setGlobalConfig(gc); // 数据源配置 DataSourceConfig dsc = new DataSourceConfig(); dsc.setDbType(DbType.MYSQL); dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC"); dsc.setDriverName("com.mysql.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("root"); mpg.setDataSource(dsc); // 包配置 PackageConfig pc = new PackageConfig(); pc.setParent("com.example.demo"); pc.setEntity("entity"); pc.setMapper("mapper"); pc.setService("service"); pc.setServiceImpl("service.impl"); pc.setController("controller"); mpg.setPackageInfo(pc); // 策略配置 StrategyConfig strategy = new StrategyConfig(); strategy.setNaming(NamingStrategy.underline_to_camel); strategy.setColumnNaming(NamingStrategy.underline_to_camel); strategy.setEntityLombokModel(true); strategy.setRestControllerStyle(true); strategy.setControllerMappingHyphenStyle(true); strategy.setInclude("user", "role"); strategy.setTablePrefix(pc.getModuleName() + "_"); mpg.setStrategy(strategy); // 执行生成 mpg.execute(); } } ``` 4. 运行代码生成器的main方法即可自动生成代码。 注意：在执行代码生成器之前，需要先创建好对应的数据库表。另外，生成的代码需要进行适当的修改和优化，以符合实际的业务需求。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值