【Springboot】【Mybatis-Plus】AutoGenerator 代码生成器使用

前言

本节讲述 mybatis-plus 的 AutoGenerator 代码生成器的使用。

内容包括项目创建，依赖配置，数据库创建，和编码。

前置准备

我这里随便用一个untitled项目，新创建一个Module：

module 命名为 mybatis-plus-generator

创建 application.properties：

server.port=8080

## if savebatch, could try rewriteBatchedStatements=true setting postgres/123456
spring.datasource.platform=postgres
spring.datasource.url=jdbc:postgresql://127.0.0.1:5432/postgres?stringtype=unspecified  # 我这里用本地数据库
spring.datasource.username=你的数据库账号
spring.datasource.password=你的数据库密码
spring.datasource.driver-class-name=org.postgresql.Driver
#spring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialect

#
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

#
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

创建 MainApplication.java

package org.example;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;

@EnableAsync
@SpringBootApplication
@MapperScan("org.sample.dao.mapper")
public class MainApplication {

    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }
}

打开某个数据库平台（我这里是DBeaver），连接本地数据库，创建一个新scheme：

我命名为generator：

创建一个名为 image_info 的数据表：

CREATE TABLE generator.image_info (
	id serial NOT NULL,
	image_name text NOT NULL,
	image_uuid_address text NOT NULL,
	encoded_image text NOT NULL,
	image_owner text NOT NULL,
	allow_download_times int8 NULL DEFAULT 10,
	authorized_user _varchar NULL,
	is_deleted int8 NOT NULL,
	"version" int8 NOT NULL DEFAULT 0,
	create_time timestamptz NULL,
	create_user text NULL,
	update_time timestamptz NULL DEFAULT now(),
	update_user text NULL,
	CONSTRAINT image_info_pkey PRIMARY KEY (id)
);

-- Column comments

COMMENT ON COLUMN generator.image_info.image_name IS '图片文件全名';
COMMENT ON COLUMN generator.image_info.image_uuid_address IS '图片UUID地址(加密)';
COMMENT ON COLUMN generator.image_info.encoded_image IS '图片MD5编码';
COMMENT ON COLUMN generator.image_info.image_owner IS '图片所有人';
COMMENT ON COLUMN generator.image_info.allow_download_times IS '图片允许的下载次数';
COMMENT ON COLUMN generator.image_info.authorized_user IS '下载或预览的授权用户';
COMMENT ON COLUMN generator.image_info."version" IS '乐观锁版本号';
COMMENT ON COLUMN generator.image_info.create_time IS '创建时间';
COMMENT ON COLUMN generator.image_info.create_user IS '创建人';
COMMENT ON COLUMN generator.image_info.update_time IS '修改时间';
COMMENT ON COLUMN generator.image_info.update_user IS '修改人';

项目实现

创建一个名为 config 的目录

在config目录中创建CodeGenerator.java

package org.sample.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
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.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.Scanner;

public class CodeGenerator {

    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator autoGenerator = new AutoGenerator();

        // 全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        // 代码生成路径
        globalConfig.setOutputDir(projectPath + "/mybatis-plus-generator" + "/src/main/java");
        // 是否覆盖以前文件
        globalConfig.setFileOverride(false);
        // 是否打开生成目录
        globalConfig.setOpen(false);
        // 设置项目作者
        globalConfig.setAuthor("test");
        // 主键策略
        globalConfig.setIdType(IdType.AUTO);
        // 生成基本ResultMap
        globalConfig.setBaseResultMap(true);
        // 生成基本ColumeList
        globalConfig.setBaseColumnList(true);
        // 去掉服务默认前缀
        globalConfig.setServiceName("%sService");
        // 设置时间类型
        globalConfig.setDateType(DateType.ONLY_DATE);
        autoGenerator.setGlobalConfig(globalConfig);

        // 数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        // 数据库类型
        dataSourceConfig.setDbType(DbType.POSTGRE_SQL);
        dataSourceConfig.setUrl("jdbc:postgresql://127.0.0.1:5432/postgres?stringtype=unspecified&useUnicode=true&characterEncoding=utf8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8");
        dataSourceConfig.setDriverName("org.postgresql.Driver");
        dataSourceConfig.setUsername("你的账号");
        dataSourceConfig.setPassword("你的密码");
        dataSourceConfig.setSchemaName("generator");
        autoGenerator.setDataSource(dataSourceConfig);

        // 包配置
        PackageConfig packageConfig = new PackageConfig();
//        packageConfig.setModuleName("xxxx");
        packageConfig.setParent("org.sample");
        packageConfig.setMapper("dao.mapper");
        packageConfig.setXml("mapper");
        packageConfig.setEntity("dao.entity");
        packageConfig.setService("service");
        packageConfig.setServiceImpl("service.impl");
        packageConfig.setController("controller");
        autoGenerator.setPackageInfo(packageConfig);

        // 策略配置
        StrategyConfig strategyConfig = new StrategyConfig();
        // 包的命名规则，使用驼峰规则
        strategyConfig.setNaming(NamingStrategy.underline_to_camel);
        // 列的名称，使用驼峰规则
        strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
        // 自动lombok
        strategyConfig.setEntityLombokModel(true);
        strategyConfig.setRestControllerStyle(true);
        // 驼峰命名
        strategyConfig.setControllerMappingHyphenStyle(true);
        // 设置逻辑删除，前提是表中有"deleted"字段
        strategyConfig.setLogicDeleteFieldName("deleted");
        // 设置自动填充配置,在项目开发过程中,例如创建时间，修改时间,每次，都需要我们来指定，太麻烦了,设置为自动填充规则，就不需要我们赋值
        // 前提是表中有"create_time"字段， 有"update_time"字段
        TableFill create_time = new TableFill("create_time", FieldFill.INSERT);
        TableFill update_time = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        ArrayList tableFills = new ArrayList<>();
        tableFills.add(create_time);
        tableFills.add(update_time);
        strategyConfig.setTableFillList(tableFills);
        // 乐观锁, 前提是表中有"version"字段
        strategyConfig.setVersionFieldName("version");
        // 设置表名前缀
        strategyConfig.setInclude(scanner("表名，多个英文逗号分割").split(","));
        // 给 entity 添加 TableField 注解
        strategyConfig.setEntityTableFieldAnnotationEnable(true);
        autoGenerator.setStrategy(strategyConfig);


        // 生成代码
        autoGenerator.execute();
    }
}

运行CodeGenerator.java

在命令行中输入表名 image_info，键入：

在dao.entity.ImageInfo中，可以看到自增id主键

乐观锁

时间插入设置

可以注意到，表名不包含前面的scheme，我们可以手动修改image_info为generator.image_info：