【JaveEE】—— 修改若依框架代码生成模板（使其支持Lombok、Swagger、Mybatis-Plus）

最新推荐文章于 2025-04-08 14:27:33 发布

四月天行健

最新推荐文章于 2025-04-08 14:27:33 发布

阅读量1.9k

点赞数 27

CC 4.0 BY-SA版权

分类专栏： JavaEE 文章标签： mybatis java 开发语言若依代码自动生成

本文链接：https://blog.youkuaiyun.com/Tir_zhang/article/details/144816487

2、新增MyMetaObjectHandler类

3、修改模板

四、Swagger集成

1、修改controller.java.vm文件

若依框架默认生成的代码是不支持Lombok、Mybatis-Plus、Swagger的，那么如何根据需求修改代码生成模板，达到我们想要的效果？

我们最终想要改造之后的效果内容，如下：

支持Lombok
支持mybatis-plus
支持自动添加Swagger的注解
支持LocalDateTime

在若依框架中，生成代码的模块是generator模块，vm后缀的文件就是生成主要代码的模板文件。

一、Lombok集成

1、导入依赖

引入lombok的依赖

<dependencies>   
    <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.22</version>
        </dependency>
</dependencies>

2、修改模板

修改的模板为 domain.java.vm，新增代码：

.....
import lombok.Data;  ## 导入lombok的依赖
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;

.....
@Data  ## 添加lombok的注解
@NoArgsConstructor
@AllArgsConstructor

.....

将模板中默认的生成get/set和toString方法删掉就可以了

最终代码大致如下：自己修改一下包名

package ${packageName}.domain;

#foreach ($import in $importList)
import ${import};
#end
import lombok.Data;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import com.xxx.common.annotation.Excel;
#if($table.crud || $table.sub)
import com.xxx.common.core.domain.BaseEntity;
#elseif($table.tree)
import com.xxx.common.core.domain.TreeEntity;
#end

/**
 * ${functionName}对象 ${tableName}
 *
 * @author ${author}
 * @date ${datetime}
 */
#if($table.crud || $table.sub)
#set($Entity="BaseEntity")
#elseif($table.tree)
#set($Entity="TreeEntity")
#end
@Data
@NoArgsConstructor
@AllArgsConstructor
public class ${ClassName} extends ${Entity}
{
    private static final long serialVersionUID = 1L;

#foreach ($column in $columns)
    #if(!$table.isSuperColumn($column.javaField))
    /** $column.columnComment */
#if($column.list)
    #set($parentheseIndex=$column.columnComment.indexOf("（"))
    #if($parentheseIndex != -1)
        #set($comment=$column.columnComment.substring(0, $parentheseIndex))
    #else
        #set($comment=$column.columnComment)
    #end
    #if($parentheseIndex != -1)
    @Excel(name = "${comment}", readConverterExp = "$column.readConverterExp()")
    #elseif($column.javaType == 'Date')
    @JsonFormat(pattern = "yyyy-MM-dd")
    @Excel(name = "${comment}", width = 30, dateFormat = "yyyy-MM-dd")
    #else
    @Excel(name = "${comment}")
    #end
#end
    private $column.javaType $column.javaField;

    #end
    #end
    #if($table.sub)
        /** $table.subTable.functionName信息 */
        private List<${subClassName}> ${subclassName}List;

    #end
}

二、Mybatis-Plus集成

1、导入依赖

<dependencies>  
     <!--MyBatisPlus-->
       <dependency>
           <groupId>com.baomidou</groupId>
           <artifactId>mybatis-plus-boot-starter</artifactId>
           <version>3.5.2</version>
       </dependency>
       <dependency>
           <groupId>com.baomidou</groupId>
           <artifactId>mybatis-plus-annotation</artifactId>
           <version>3.5.2</version>
        </dependency>
</dependencies>

2、修改配置文件

appliation.yml文件中新增MyBatisPlus配置，同时删除Mybatis相关的配置

# MyBatisPlus配置
mybatis-plus:
  # 搜索指定包别名
  typeAliasesPackage: com.zzyl.**.domain
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapperLocations: classpath*:mapper/**/*Mapper.xml
  # 全局配置
  global-config:
    db-config:
      id-type: auto   #id生成策略为自增
  configuration:
    map-underscore-to-camel-case: true    #字段与属性，自动转换为驼峰命名

3、新增核心配置类

新建MybatisPlusConfig配置类，删除MyBatisConfig

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.BlockAttackInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**
 * Mybatis Plus 配置
 *
 * @author ruoyi
 */
@EnableTransactionManagement(proxyTargetClass = true)
@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 分页插件
        interceptor.addInnerInterceptor(paginationInnerInterceptor());
        // 乐观锁插件
        interceptor.addInnerInterceptor(optimisticLockerInnerInterceptor());
        // 阻断插件
        interceptor.addInnerInterceptor(blockAttackInnerInterceptor());
        return interceptor;
    }

    /**
     * 分页插件，自动识别数据库类型 https://baomidou.com/guide/interceptor-pagination.html
     */
    public PaginationInnerInterceptor paginationInnerInterceptor() {
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        // 设置数据库类型为mysql
        paginationInnerIntercept