MyBatis-plus代码自动生成器（高版本）

码农大使

已于 2024-02-29 23:23:51 修改

阅读量1.5k

点赞数 9

文章标签： mybatis spring boot

于 2024-02-29 23:22:41 首次发布

本文链接：https://blog.csdn.net/m0_74180764/article/details/136383472

版权

SpringBoot版本：3.2.3

MyBatis-plus版本: 3.5.5

swagger版本：2.9.2

velocity版本：2.3

一、导入依赖

              <!--  mybatis-plus 依赖  -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.5</version>
            <exclusions>
<!--    mybatis-plus 中 mybatis 的整合包mybatis-spring 版本不够会导致报错，即要排除它            -->
                <exclusion>
                    <groupId>org.mybatis</groupId>
                    <artifactId>mybatis-spring</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
<!--     手动引入一个高版本得 mybatis-spring依赖   -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>3.0.3</version>
        </dependency>
<!-- 代码生成器 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.5</version>
        </dependency>
        <!--velocity模板-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
        <!--freemarker模板-->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
        </dependency>
<!--   swagger  -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

二、编写MyBatis-plus代码自动生成器


import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.TemplateConfig;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import com.baomidou.mybatisplus.generator.fill.Property;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.function.Consumer;

//代码生成器
public class AutoGeneratorTest {
    public static void main(String[] args) {

         final String url = "jdbc:mysql://localhost:3306/数据库名?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8";
         final String username=用户名;
         final String password=密码;

       List<String> tables = new ArrayList<>();
       //添加 表 到集合中，可以添加多个表
        tables.add("user");

        //全局配置
       FastAutoGenerator.create(url,username,password)
               .globalConfig(builder -> {
                   builder.author("Dragon")  //作者
                           .outputDir(System.getProperty("user.dir")+"\\src\\main\\java") //输出路径(java目录)
                           .enableSwagger()   //开启swagger，要引入依赖，注意版本是2.x
                           .commentDate("yyyy-MM-dd");
               })
               //包配置
               .packageConfig(builder -> {
                   builder.parent("coms")
                           .moduleName("ljh")
                           .entity("bean")
                           .service("service")
                           .serviceImpl("service.impl")
                           .controller("controller")
                           .mapper("mapper")
                           .xml("mapper")
                           .pathInfo(Collections.singletonMap(OutputFile.xml,System.getProperty("user.dir")+"\\src\\main\\resources\\mapper"));
               })
               //策略配置: 所谓策略配置，就是配置策略，配置细节
               .strategyConfig(builder -> {
                   //addInclude(表)就是指定为哪些表生成代码
                   builder.addInclude(tables)  //表明是通过哪个表生成的
                           .serviceBuilder()  //service生成策略配置
                           .formatServiceFileName("%sService")
                           .formatServiceImplFileName("%sServiceImpl")
                           .entityBuilder() //实体类生成策略配置
                           .enableLombok() //开启Lombok
                           .logicDeleteColumnName("deleted")//说明逻辑删除的字段是哪个
                           .enableTableFieldAnnotation() //开启属性上加上说明注解
                           .controllerBuilder()  //controller生成策略配置
                           // 映射路径使用连字符格式，而不是驼峰
//                           .enableHyphenStyle()
                           .formatFileName("%sController")
                           .enableRestStyle() //开启RestController生成策略配置
                           .mapperBuilder()  //mapper生成策略配置
                           //生成通用的resultMap
                           .enableBaseResultMap()
                           .superClass(BaseMapper.class)  //所有mapper类继承BaseMapper
//                           .formatMapperFileName("%sMapper")
                           .enableMapperAnnotation() //开启@mapper注解
                           .formatXmlFileName("%sMapper");

                   new StrategyConfig.Builder()
                           .entityBuilder()
                           .enableLombok() //开启 lombok 模型
                           .versionPropertyName("version")  //乐观锁
                           .logicDeletePropertyName("deleted") //逻辑删除
//                           .naming()  //数据库表映射到实体的命名策略,默认下划线转驼峰命
                           .idType(IdType.AUTO) //全局主键类型
                           .addTableFills(new Column("create_time", FieldFill.INSERT)) //字段填充
                           .addTableFills(new Property("updateTime", FieldFill.INSERT_UPDATE));//属性填充
               }).templateConfig(new Consumer<TemplateConfig.Builder>() {
                   @Override
                   public void accept(TemplateConfig.Builder builder) {
                       // 实体类使用我们自定义模板
                       builder.entity("templates/myentity.java");
                   }
               })
         .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
               .execute();





    }
}

在templates/建一个myentity.java.ftl文件（设置模板）

package ${package.Entity};

<#list table.importPackages as pkg>
import ${pkg};
</#list>
<#if swagger>
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
</#if>
<#if entityLombokModel>
import lombok.Data;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
<#if chainModel>
import lombok.experimental.Accessors;
</#if>
</#if>

/**
* <p>
* ${table.comment!}
* </p>
*
* @author ${author}
* @since ${date}
*/
<#if entityLombokModel>
@Data
@AllArgsConstructor
@NoArgsConstructor
<#if chainModel>
@Accessors(chain = true)
</#if>
</#if>
<#if table.convert>
@TableName("${schemaName}${table.name}")
</#if>
<#if swagger>
@ApiModel(value = "${entity}对象", description = "${table.comment!}")
</#if>
<#if superEntityClass??>
public class ${entity} extends ${superEntityClass}<#if activeRecord><${entity}></#if> {
<#elseif activeRecord>
public class ${entity} extends Model<${entity}> {
<#elseif entitySerialVersionUID>
public class ${entity} implements Serializable {
<#else>
public class ${entity} {
</#if>
<#if entitySerialVersionUID>

private static final long serialVersionUID = 1L;
</#if>
<#-- ----------  BEGIN 字段循环遍历  ---------->
<#list table.fields as field>
<#if field.keyFlag>
<#assign keyPropertyName="${field.propertyName}"/>
</#if>

<#if field.comment!?length gt 0>
<#if swagger>
@ApiModelProperty("${field.comment}")
<#else>
/**
* ${field.comment}
*/
</#if>
</#if>
<#if field.keyFlag>
<#-- 主键 -->
<#if field.keyIdentityFlag>
@TableId(value = "${field.annotationColumnName}", type = IdType.AUTO)
<#elseif idType??>
@TableId(value = "${field.annotationColumnName}", type = IdType.${idType})
<#elseif field.convert>
@TableId("${field.annotationColumnName}")
</#if>
<#-- 普通字段 -->
<#elseif field.fill??>
<#-- -----   存在字段填充设置   ----->
<#if field.convert>
@TableField(value = "${field.annotationColumnName}", fill = FieldFill.${field.fill})
<#else>
@TableField(fill = FieldFill.${field.fill})
</#if>
<#elseif field.convert>
@TableField("${field.annotationColumnName}")
</#if>
<#-- 乐观锁注解 -->
<#if field.versionField>
@Version
</#if>
<#-- 逻辑删除注解 -->
<#if field.logicDeleteField>
@TableLogic
</#if>
private ${field.propertyType} ${field.propertyName};
</#list>
<#------------  END 字段循环遍历  ---------->

<#if !entityLombokModel>
<#list table.fields as field>
<#if field.propertyType == "boolean">
<#assign getprefix="is"/>
<#else>
<#assign getprefix="get"/>
</#if>
public ${field.propertyType} ${getprefix}${field.capitalName}() {
return ${field.propertyName};
}

<#if chainModel>
public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
<#else>
public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
</#if>
this.${field.propertyName} = ${field.propertyName};
<#if chainModel>
return this;
</#if>
}
</#list>
</#if>

<#if entityColumnConstant>
<#list table.fields as field>
public static final String ${field.name?upper_case} = "${field.name}";

</#list>
</#if>
<#if activeRecord>
@Override
public Serializable pkVal() {
<#if keyPropertyName??>
return this.${keyPropertyName};
<#else>
return null;
</#if>
}

</#if>
<#if !entityLombokModel>
@Override
public String toString() {
return "${entity}{" +
<#list table.fields as field>
<#if field_index==0>
"${field.propertyName}=" + ${field.propertyName} +
<#else>
", ${field.propertyName}=" + ${field.propertyName} +
</#if>
</#list>
"}";
}
</#if>
}

三、配置MyBatis-plusConfig

配置插件：乐观锁、分页插件、自动填充、逻辑删除在yaml中配置

自动填充

1.实体类属性

    //使用驼峰命名
    //字段添加填充内容 Date时间
    /*
DEFAULT：表示默认的填充方式
INSERT：表示在插入操作时填充字段
UPDATE：表示在更新操作时填充字段
INSERT_UPDATE：表示在插入和更新操作时都填充字段
     */
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;    //生成某个字段的创建时间，这样我们就知道什么字段什么时候被创建
    @TableField(fill = FieldFill.INSERT_UPDATE)//在执行插入时，也会填充字段updateTime的 时间
    private Date updateTime;    //生成某个字段的修改时间，这样我们就知道什么字段什么时候被修改

2.处理器

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component  //一定不要忘记把处理器加到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {

    //自动填充

    //插入时候的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        //当添加数据的时候，创建时间字段 createTime 和 更新时间字段 updateTime 都会被填充 Date时间
        //即在插入数据时自动设置 createTime 和 updateTime 字段的数值为当前时间。
        //setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject) 
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    //更新时候的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        //当更新数据时，更新时间字段 updateTime 会被填充 更新的 Date时间
        //即在更新数据时自动设置 updateTime 字段的数值为当前时间。
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

乐观锁

1.实体类属性

 @Version//乐观锁version注解
    private int version;

2.插件配置

   //注册乐观锁插件
    @Bean //新版
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }

分页插件

   //添加分页插件
    @Bean //新版
    public MybatisPlusInterceptor mybatisPlusInterceptor1() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();  // DbType.MYSQL : 配置指定的MYSQL数据源
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//如果配置多个插件,切记分页最后添加
        //interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); 如果有多数据源可以不配具体类型 否则都建议配上具体的DbType
        return interceptor;
    }

四、yaml文件配置

#配置jdbc数据源
spring:
  datasource:
    username: #用户名
    password: #密码
    #注意设置时区和编码
    url: jdbc:mysql://localhost:3306/数据库名?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver #支持MySQL8.0

    # ======== MybatisPlus配置 ========
mybatis-plus:
  # 搜索指定包别名
  type-aliases-package: coms.config.bean
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapper-locations: classpath:mapper/**/*xml
  # 配置驼峰
  configuration:
    # 是否开启自动驼峰命名规则（camel case）映射。默认值：true
    map-underscore-to-camel-case: true
    # 开启 Mybatis 二级缓存，默认为 true。
    cache-enabled: true
    # 日志输出实现。StdOutImpl 标准日志控制台输出,可以查看所执行的 sql 语句
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      # 全局默认主键类型
      id-type: AUTO
      # 表名是否使用驼峰转下划线命名,只对表名生效。 默认true
      table-underline: true
      #逻辑删除
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

运行成功即可！