MyBatisPlus（二十二）代码生成器

拼搏现实的明天。 2024-03-27 18:49 71阅读 0赞

## 使用场景 ##

使用代码生成器，根据数据库表，自动生成对应的 Entity，Mapper，Service，Controller 。

## 代码 ##

### 依赖 ###

两个依赖：

1.  生成器依赖
2.  模板依赖

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.5.3.2</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-freemarker</artifactId>
            </dependency>

### 生成器代码 ###

package com.example.db.mybatisplus;
    
    import com.baomidou.mybatisplus.annotation.FieldFill;
    import com.baomidou.mybatisplus.generator.FastAutoGenerator;
    import com.baomidou.mybatisplus.generator.config.OutputFile;
    import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
    import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
    import com.baomidou.mybatisplus.generator.fill.Column;
    
    import java.sql.Types;
    import java.util.Collections;
    
    public class AutoGenerator {
        
        public static void main(String[] args) {
        
            String url = "jdbc:mysql://localhost:3306/mybatisplus?serverTimeZone=UTC&characterEncoding=utf8&useUnicode=true&useSSL=false&allowPublicKeyRetrieval=true";
            FastAutoGenerator.create(url, "root", "password")
                    .globalConfig(builder -> {
        
                        builder.author("宋冠巡") // 设置作者
    //                            .enableSwagger() // 开启 swagger 模式
                                .outputDir("E://mybatis-plus/"); // 指定输出目录
                    })
                    .dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {
        
                        int typeCode = metaInfo.getJdbcType().TYPE_CODE;
                        if (typeCode == Types.SMALLINT) {
        
                            // 自定义类型转换
                            return DbColumnType.INTEGER;
                        }
                        return typeRegistry.getColumnType(metaInfo);
                    }))
                    .packageConfig(builder -> {
        
                        builder.parent("com.example.db") // 设置父包名
                                .moduleName("mybatisplus") // 设置父包模块名
                                .pathInfo(Collections.singletonMap(OutputFile.xml, "E://mybatis-plus/")); // 设置mapperXml生成路径
                    })
                    .strategyConfig(builder -> {
        
                        builder.entityBuilder()
                                .formatFileName("%sEntity")
    //                            .superClass("com.example.db.BaseEntity")
    //                            .addSuperEntityColumns("id", "create_time", "update_time")
                                .enableLombok()
                                .disableSerialVersionUID()
                                .logicDeleteColumnName("deleted")
                                .versionColumnName("version")
                                .addTableFills(new Column("create_time", FieldFill.INSERT))
                                .addTableFills(new Column("update_time", FieldFill.INSERT_UPDATE));
                        builder.serviceBuilder()
                                .formatServiceFileName("%sService");
                        builder.addInclude("tb_user") // 设置需要生成的表名
                                .addTablePrefix("tb_"); // 设置过滤表前缀
                    })
                    .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                    .execute();
        }
    }

## 效果 ##

将生成的代码，复制到项目中。  
配置好 `MapperScan` 后，能够正常运行。  
注意：`entity` 默认使用的 lombok 为`@Getter @Setter`，需要手动改为`@Data`。

### 生成代码示例 ###

![在这里插入图片描述][e79aa2b3667541febfe419db1bb49740.png]

### 放入项目后示例 ###

![在这里插入图片描述][788aaee46cec47fd9bf6cc0385064292.png]

## 参考 ##

[官网 - 代码生成器配置][-]

[e79aa2b3667541febfe419db1bb49740.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/3c3bf9e0b8eb4e2499596c41fb1d2293.png
[788aaee46cec47fd9bf6cc0385064292.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/d78181cc915b42bea7e4a28711587d9c.png
[-]: https://baomidou.com/pages/981406/#%E6%95%B0%E6%8D%AE%E5%BA%93%E9%85%8D%E7%BD%AE-datasourceconfig