MybatisPlus代码生成器-Pyethel

本文介绍如何使用MyBatis-Plus的AutoGenerator快速生成Entity、Mapper、Service等代码,提升开发效率。包括配置策略、数据源、包信息及模板引擎。

AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

官网地址:https://mybatis.plus/guide/generator.html

步骤:

  1. 添加代码生成器依赖。
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.3.2</version>
    </dependency>

     

  2. 添加模版引擎依赖。MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎。
    
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.2</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.30</version>
    </dependency>
    
    <dependency>
        <groupId>com.ibeetl</groupId>
        <artifactId>beetl</artifactId>
        <version>3.1.8.RELEASE</version>
    </dependency>

     

  3. 编写配置(以下是我整理的代码生成器)
    package com.lehteypzzz.generate;
    
    import com.baomidou.mybatisplus.annotation.DbType;
    import com.baomidou.mybatisplus.annotation.FieldFill;
    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.po.TableFill;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
    
    import java.util.ArrayList;
    
    /**
     * date: 2020/8/14 17:40
     *
     * @author pyethel
     */
    public class CodeGenerator {
        public static void main(String[] args) {
            //构建一个代码自动生成器
            AutoGenerator mpg = new AutoGenerator();
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            //配置策略
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            String projectPath = System.getProperty("user.dir");
            gc.setOutputDir(projectPath+"/src/main/java");
            gc.setAuthor("Lehteypzzz");
            gc.setOpen(false);
            gc.setFileOverride(false);
            gc.setServiceName("%sService");
    //        gc.setSwagger2(true);
            mpg.setGlobalConfig(gc);
    
            //设置数据源
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/vueblog?useSSL=false&useUnicode=true" +
                    "&characterEncoding=utf-8&serverTimezone=Asia/Shanghai");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("Lzyll1234");
            dsc.setDbType(DbType.MYSQL);
            mpg.setDataSource(dsc);
    
            //包的配置
            PackageConfig pc = new PackageConfig();
            pc.setParent("com.lehteypzzz");
            pc.setEntity("entity");
            pc.setMapper("mapper");
            pc.setService("service");
            pc.setController("controller");
            mpg.setPackageInfo(pc);
    
            //策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setTablePrefix("m_");
            strategy.setInclude("m_user","m_blog");//设置要映射的表名
            strategy.setNaming(NamingStrategy.underline_to_camel);
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            strategy.setEntityLombokModel(true);
            strategy.setLogicDeleteFieldName("deleted");
    
            //自动填充配置
            TableFill gmtCreated = new TableFill("gmt_created", FieldFill.INSERT);
            TableFill gmtModified = new TableFill("gmt_modified",FieldFill.INSERT_UPDATE);
            ArrayList<TableFill> tableFills = new ArrayList<>();
            tableFills.add(gmtCreated);
            tableFills.add(gmtModified);
            strategy.setTableFillList(tableFills);
    
            //乐观锁
            strategy.setVersionFieldName("version");
            strategy.setRestControllerStyle(true);
            strategy.setControllerMappingHyphenStyle(true);
            mpg.setStrategy(strategy);
    
            mpg.execute();
            }
        }
    

     

  4. 注意修改工程路径,包名,数据源配置

  5. 工程路径中不能有中文路径,否则会出错。

### 如何在 Spring Boot 中使用 MyBatis Plus 代码生成器并集成 Swagger #### 配置 MyBatis Plus 和 Swagger 的依赖 为了实现这一目标,在 `pom.xml` 文件中添加必要的 Maven 依赖来引入 MyBatis Plus 及其代码生成工具,以及 Swagger UI。 ```xml <dependencies> <!-- MyBatis Plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.2</version> </dependency> <!-- MyBatis Plus Code Generator --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.4.0</version> </dependency> <!-- Velocity Template Engine (for code generation templates) --> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.3</version> </dependency> <!-- Swagger/OpenAPI for API documentation --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> </dependencies> ``` #### 创建 MyBatis Plus 自动化代码生成功能 定义一个 Java 类用于启动自动化代码生成过程。此操作可以通过编写一段简单的程序完成: ```java 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; public class MpCodeGen { 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"); // 输出路径设置为当前项目的 src/main/java 下 // 数据源配置 DataSourceConfig dsc = new DataSourceConfig(); dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC"); dsc.setUsername("root"); dsc.setPassword("password"); dsc.setDriverName("com.mysql.cj.jdbc.Driver"); // 包名策略配置 PackageConfig pc = new PackageConfig(); pc.setParent("com.example.demo"); pc.setModuleName(null); // 表策略配置 StrategyConfig strategy = new StrategyConfig(); strategy.setInclude("table_name"); // 此处填写要生成表的名字 strategy.setNaming(mp.service.NamingStrategy.underline_to_camel); strategy.setColumnNaming(mp.service.NamingStrategy.underline_to_camel); strategy.setEntityLombokModel(true); // 使用 Lombok 注解简化实体类开发 strategy.setRestControllerStyle(true); // 开启驼峰命名法到下划线风格转换功能 // 将以上配置应用至AutoGenerator实例上 mpg.setGlobalConfig(gc).setDataSource(dsc).setPackageInfo(pc).setStrategy(strategy); // 执行代码生成命令 mpg.execute(); } } ``` 这段代码将会基于数据库中的指定表格来自动生成相应的 Controller, Service, Mapper 接口及其对应的 XML 映射文件[^1]。 #### 启用 Swagger 文档支持 为了让应用程序能够通过 Swagger 展示 RESTful APIs 的文档信息,需进一步调整 Spring Boot 应用程序的主要入口点(通常是带有@SpringBootApplication注解的那个类),加入@EnableSwagger2 或者 @EnableOpenApi 来激活 Swagger 功能: ```java import org.springframework.context.annotation.Bean; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @SpringBootApplication @EnableSwagger2 public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 现在访问 http://localhost:8080/swagger-ui.html 即可查看由 Swagger 自动生成的 API 文档界面[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值