【MyBatis-Plus】代码生成器实际应用

一、数据库准备

CREATE DATABASE mybatis_plus CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
use mybatis_plus;
create table if not exists user
(
    id          bigint auto_increment comment '主键ID'
        primary key,
    name        varchar(30)                        null comment '姓名',
    age         int                                null comment '年龄',
    email       varchar(50)                        null comment '邮箱',
    create_time datetime default CURRENT_TIMESTAMP null on update CURRENT_TIMESTAMP comment '创建时间',
    update_time datetime default CURRENT_TIMESTAMP null on update CURRENT_TIMESTAMP comment '更新时间',
    version     int      default 1                 null comment '乐观锁字段',
    deleted     int      default 0                 null comment '逻辑删除'
);

二、导入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.0.5</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!--代码生成所依赖模板-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>
<!--Knife4i是为Java MVC框架集成Swaggers生成Api文档的增强解决方案-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-autoconfigure</artifactId>
    <version>3.0.2</version>
</dependency>

三、配置文件

默认为application.properties文件我们要手动改为.yml文件

server:
  port: 8881
spring:
  profiles: # 环境设置
    active: dev
  datasource: # 数据库连接
    url: jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
  mybatis-plus:
    # xml扫描，多个目录用逗号或者分号分隔（告诉 Mapper 所对应的 XML 文件位置）
    mapper-locations: classpath:/mapper/*.xml
    # 实体类路径
    type-aliases-package: com.hzj.entity
    configuration:
      # 输出sql语句
      log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
      # 是否开启自动驼峰命名规则映射:从数据库列名到Java属性驼峰命名的类似映射
      map-underscore-to-camel-case: true
    # 逻辑删除
    global-config:
      db-config:
        db-type: MYSQL
        logic-delete-value: 1
        logic-not-delete-value: 0

我们把数据库连接信息抽取出来放在generator.properties文件里面

# jdbc数据库连接信息
jdbc.username = root
jdbc.password = root
# mysql8的url中一定要加上时区否则会连接不上数据库 serverTimezone=GMT%2B8
jdbc.url = jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8
# mysql8和mysql5的驱动名称不同
jdbc.driver = com.mysql.cj.jdbc.Driver

# 父路径
parent = com.hzj

 四、编写代码生成器类

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
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.TableFill;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.*;

/**
 * @Description: 代码生成器
 */
@SuppressWarnings("ALL")
public class CodeGeneration {
    public static void main(String[] args) {
        // 构建一个代码生成器对象
        AutoGenerator autoGenerator = new AutoGenerator();
        // 配置策略

        // 1.全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        // 1.1获取当前项目路径
        String objectPath = System.getProperty("user.dir");

        globalConfig
                // 1.2设置输出路径
                .setOutputDir(objectPath + "/src/main/java")
                // 1.3设置作者
                .setAuthor("MonkeyJun")
                // 1.4生成后不打开资源管理器
                .setOpen(false)
                // 1.5是否覆盖当前文件
                .setFileOverride(false)
                // 1.6格式化Service命名
                .setServiceName("%sService")
                // 1.7设置主键策略
                .setIdType(IdType.ID_WORKER)
                // 1.8设置日期格式
                .setDateType(DateType.ONLY_DATE)
                // 1.9 自动配置Swagger文档
                .setSwagger2(true);
        // 开启全局配置
        autoGenerator.setGlobalConfig(globalConfig);

        // 2.设置数据源
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        //用来获取Mybatis-Plus generator.properties文件的配置信息 不用加路径和后缀 但是该文件必须位于resources根目录下
        ResourceBundle rb = ResourceBundle.getBundle("generator");
        dataSourceConfig
                .setDbType(DbType.MYSQL)
                .setUrl(rb.getString("jdbc.url"))
                .setDriverName(rb.getString("jdbc.driver"))
                .setUsername(rb.getString("jdbc.username"))
                .setPassword(rb.getString("jdbc.password"));
        // 开启数据库配置
        autoGenerator.setDataSource(dataSourceConfig);

        // 3. 包配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig
                .setParent(rb.getString("parent")) // 父路径
//                .setModuleName("kt") // 模块名称
                .setEntity("pojo")
                .setMapper("mapper")
                .setXml("")
                .setService("service")
                .setController("controller");
        autoGenerator.setPackageInfo(packageConfig);
        // 自定义包配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
            }
        };
        List<FileOutConfig> focList = new ArrayList<>();
        focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return objectPath + "/src/main/resources/mapper/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        autoGenerator.setCfg(cfg);


        // 4. 策略配置
        StrategyConfig strategyConfig = new StrategyConfig();
        // 自动填充配置
        TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
        TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        strategyConfig
                // 表名映射
                .setInclude("user")
                // 命名下划线转驼峰
                .setNaming(NamingStrategy.underline_to_camel)
                .setColumnNaming(NamingStrategy.underline_to_camel)
                // 自动lombok
                .setEntityLombokModel(true)
                // 逻辑删除
                .setLogicDeleteFieldName("deleted")
                // 自动填充
                .setTableFillList(Arrays.asList(createTime, updateTime))
                // 乐观锁
                .setVersionFieldName("version")
                // Rest风格
                .setRestControllerStyle(true)
                .setControllerMappingHyphenStyle(true)
        ;
        autoGenerator.setStrategy(strategyConfig);

        // 执行代码
        autoGenerator.execute();
    }
}

注意生成文件后要手动删除java包下的.xml文件

五、在springboot启动类上加上mapper包扫描

六、代码生成结果 

 七、CRUD测试

注意要先在mapper类上加上@Repository注解

 测试类

 查询成功