MyBatis-Plus内置代码生成器

MyBatis-Plus是一个MyBatis的增强工具,致力于简化开发流程。本文介绍了如何配置mybatisplus依赖,并重点讲解如何使用其内置的代码生成器来高效地生成代码。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

MyBatis-Plus

MyBatis-Plus (简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
在这里插入图片描述

  • mybatisplus依赖
 <!--mybatis-plus支持-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>2.2.0</version>
        </dependency>
  • properties配置文件
#此处为本项目src所在路径(代码生成器输出路径),注意一定是当前项目所在的目录哟
OutputDir=D:\\java\\everyonebuys_parent\\everyonebuys_product_parent_8002\\everyonebuys_product_service\\src\\main\\java
#mapper.xml SQL映射文件目录
OutputDirXml=D:\\java\\everyonebuys_parent\\everyonebuys_product_parent_8002\\everyonebuys_product_service\\src\\main\\resources

OutputDirBase=D:\\java\\everyonebuys_parent\\everyonebuys_product_parent_8002\\everyonebuys_product_service\\src\\main\\java

#domain和query
OutputDirInterface=D:\\java\\everyonebuys_parent\\everyonebuys_product_parent_8002\\everyonebuys_product_interface\\src\\main\\java

#设置作者
author=xxx
#自定义包路径
parent=cn.itsource.everyonebuys.product

#数据库连接信息
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///everyonebuys
jdbc.user=root
jdbc.pwd=123456
  • 使用内置代码生成器,生成代码
 public static void main(String[] args) throws InterruptedException {
        //用来获取Mybatis-Plus.properties文件的配置信息
        ResourceBundle rb = ResourceBundle.getBundle("mybatisplus");
        AutoGenerator mpg = new AutoGenerator();
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        gc.setOutputDir(rb.getString("OutputDir"));
        gc.setFileOverride(true);
        gc.setActiveRecord(true);// 开启 activeRecord 模式
        gc.setEnableCache(false);// XML 二级缓存
        gc.setBaseResultMap(true);// XML ResultMap
        gc.setBaseColumnList(false);// XML columList
        gc.setAuthor(rb.getString("author"));
        mpg.setGlobalConfig(gc);
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setTypeConvert(new MySqlTypeConvert());
        dsc.setDriverName(rb.getString("jdbc.driver"));
        dsc.setUsername(rb.getString("jdbc.user"));
        dsc.setPassword(rb.getString("jdbc.pwd"));
        dsc.setUrl(rb.getString("jdbc.url"));
        mpg.setDataSource(dsc);
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setTablePrefix(new String[] { "t_" });// 此处可以修改为您的表前缀
        strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略 t_user_xxx UserXxx
        strategy.setInclude(new String[]{"t_product_type"}); // 需要生成的表 这里修改为自己需要生成的表
        mpg.setStrategy(strategy);
        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent(rb.getString("parent"));
        pc.setController("controller");
        pc.setService("service");
        pc.setServiceImpl("service.impl");
        pc.setEntity("domain");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 注入自定义配置,可以在 VM 中使用 cfg.abc 【可无】
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                Map<String, Object> map = new HashMap<String, Object>();
                map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-rb");
                this.setMap(map);
            }
        };

        List<FileOutConfig> focList = new ArrayList<FileOutConfig>();

        // 调整 domain 生成目录演示
        focList.add(new FileOutConfig("/templates/entity.java.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return rb.getString("OutputDirBase")+ "/cn/itsource/everyonebuys/product/domain/" + tableInfo.getEntityName() + ".java";
            }
        });

        // 调整 xml 生成目录演示
        focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return rb.getString("OutputDirXml")+ "/cn/itsource/everyonebuys/product/mapper/" + tableInfo.getEntityName() + "Mapper.xml";
            }
        });

        //生成controller
        focList.add(new FileOutConfig("/templates/controller.java.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return rb.getString("OutputDirInterface")+ "/cn/itsource/everyonebuys/product/controller/" + tableInfo.getEntityName() + "Controller.java";
            }
        });

        //生成query
        focList.add(new FileOutConfig("/templates/query.java.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return rb.getString("OutputDirInterface")+ "/cn/itsource/everyonebuys/product/query/" + tableInfo.getEntityName() + "Query.java";
            }
        });

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

        // 自定义模板配置,可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改,
        // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置,也可以自定义模板名称
        TemplateConfig tc = new TemplateConfig();
        tc.setService("/templates/service.java.vm");
        tc.setServiceImpl("/templates/serviceImpl.java.vm");
        tc.setEntity(null);
        tc.setMapper("/templates/mapper.java.vm");
        tc.setController(null);
        tc.setXml(null);
        // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。
        mpg.setTemplate(tc);

        // 执行生成
        mpg.execute();
    }
### MyBatis-Plus 代码生成器的使用方法及配置 MyBatis-Plus 是一款增强型的 MyBatis 框架,简化了开发流程并提供了丰富的功能支持。其内置代码生成器能够帮助开发者快速生成实体类、Mapper接口、XML文件以及Controller层代码等,从而减少重复劳动。 #### 配置与使用说明 以下是关于如何在 SpringBoot 项目中集成和使用 MyBatis-Plus代码生成器的具体描述: 1. **引入依赖** 在 `pom.xml` 文件中添加 MyBatis-Plus代码生成器所需的 Maven 依赖项[^2]。 ```xml <!-- MyBatis-Plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.1</version> </dependency> <!-- Velocity模板引擎(可选, 如果不指定则默认使用Freemarker) --> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.3</version> </dependency> ``` 2. **创建代码生成器类** 编写一个 Java 类来初始化代码生成器,并设置相应的参数。以下是一个完整的示例代码片段: ```java import com.baomidou.mybatisplus.generator.FastAutoGenerator; import com.baomidou.mybatisplus.generator.config.OutputFile; public class CodeGenerator { public static void main(String[] args) { FastAutoGenerator.create("jdbc:mysql://localhost:3306/test_db", "root", "password") // 数据库连接信息 .globalConfig(builder -> builder.author("YourName").outputDir(System.getProperty("user.dir") + "/src/main/java")) // 设置作者名和输出目录 .packageConfig(builder -> builder.parent("com.example.demo").moduleName(null).pathInfo(Collections.singletonMap(OutputFile.mapperXml, System.getProperty("user.dir") + "/src/main/resources/mapper"))) // 包路径配置 .strategyConfig(builder -> builder.addInclude("table_name") // 表名过滤条件 .entityBuilder().enableLombok() // 开启 Lombok 功能 .controllerBuilder().enableRestStyle()) // 启用 RESTful 风格控制器 .execute(); // 执行生成操作 } } ``` 上述代码通过调用 `FastAutoGenerator` 方法完成数据库表到代码的映射过程。 3. **自定义模板** 如果需要修改默认生成的代码样式或者结构,则可以通过覆盖模板的方式实现个性化需求。例如,在上述代码中的 `.templateEngine()` 中传入定制化的 Template Engine 实现即可。 4. **运行程序** 完成以上步骤之后,执行该工具类下的 Main 函数将会自动依据设定好的规则批量生产对应的源码文件。 --- ### 注意事项 - 确保 MySQL 连接 URL 正确无误,并且拥有足够的权限访问目标数据表。 - 若存在多模块工程架构下,请调整包扫描范围以匹配实际业务逻辑分布情况。 - 对于复杂场景可能还需要额外处理诸如分页插件等功能扩展部分[^1]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值