若依框架 MyBatis 改为 MyBatis-Plus 的实现步骤

若依框架从 MyBatis 改 MyBatis-Plus 步骤
原创 已于 2024-08-31 22:25:59 修改 · 1.4k 阅读 · 7 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#若依 #mybatis #mybatis-plus

于 2024-08-31 12:05:54 首次发布

本文只做了简单的实现，具体的细节需根据自己的需求进一步实现。如果实现中遇到问题欢迎留言讨论。

引入 MyBatis-Plus

引入相关依赖（pom.xml）

推荐先直接在顶级 pom.xml 中直接依赖，等调试通过之后，在去按需依赖（细分）。

    <dependencies>
        <!-- lombok 工具-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </dependency>

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

调整配置信息（application.yml）

注释原 mybatis 配置

## MyBatis配置
#mybatis:
#  # 搜索指定包别名
#  typeAliasesPackage: com.ruoyi.**.domain
#  # 配置mapper的扫描，找到所有的mapper.xml映射文件
#  mapperLocations: classpath*:mapper/**/*Mapper.xml
#  # 加载全局的配置文件
#  configLocation: classpath:mybatis/mybatis-config.xml

添加 mybatis-plus 配置 

# MyBatis配置
mybatis-plus:
  # 搜索指定包别名
  typeAliasesPackage: com.ruoyi.**.domain
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapperLocations: classpath*:mapper/**/*Mapper.xml
  configuration:
    cache-enabled: true
    use-generated-keys: true
    default-executor-type: simple
    log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl

调整配置文件（MyBatisConfig.java）

注释原配置文件（MyBatisConfig.java）的 @Configuration 注解

package com.ruoyi.framework.config;

......

/**
 * Mybatis支持*匹配扫描包
 * 
 * @author ruoyi
 */
//@Configuration
public class MyBatisConfig
{
    ......
}

添加新配置文件（MybatisPlusConfiguration.java）

package com.ruoyi.framework.config;

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;

/**
 * @author puff
 * @date 2023/8/30
 * @desc Mybatis-Plus 自动装配
 */
@Configuration
public class MybatisPlusConfiguration {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        //乐观锁插件
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        //sql性能规范
        // interceptor.addInnerInterceptor(new IllegalSQLInnerInterceptor());
        //防止全表更新与删除
        interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());
        return interceptor;
    }
}

排除非数据库表字段（BaseEntity.java、TreeEntity.java）

自动生成的 domain 类会继承 BaseEntity.java 或 TreeEntity.java 类，所以针对这两个类中的非数据库字段需使用 @TableField(exist = false) 进行排除，不然在使用时会出现异常。

修改 .vm 模板文件

.vm 模板文件的位置在 ruoyi-generator 模块的 resources 目录下

domain.java.vm

package ${packageName}.domain;

import lombok.Data;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
#foreach ($import in $importList)
import ${import};
#end
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import com.ruoyi.common.annotation.Excel;
#if($table.crud || $table.sub)
import com.ruoyi.common.core.domain.BaseEntity;
#elseif($table.tree)
import com.ruoyi.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
@TableName("${tableName}")
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
        #if($column.isPk == 1)
        @TableId(value = "$column.columnName" , type = IdType.ASSIGN_ID)
        #else
        @TableField(value = "$column.columnName")
        #end
    private $column.javaType $column.javaField;

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

#end

@Override
public String toString(){
        return new ToStringBuilder(this,ToStringStyle.MULTI_LINE_STYLE)
    #foreach ($column in $columns)
        #if($column.javaField.length() > 2 && $column.javaField.substring(1,2).matches("[A-Z]"))
            #set($AttrName=$column.javaField)
        #else
            #set($AttrName=$column.javaField.substring(0,1).toUpperCase() + ${column.javaField.substring(1)})
        #end
            .append("${column.javaField}" ,get${AttrName}())
    #end
    #if($table.sub)
            .append("${subclassName}List" ,get${subClassName}List())
    #end
        .toString();
        }
        }

 mapper.java.vm

package ${packageName}.mapper;

import ${packageName}.domain.${ClassName};
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
#if($table.sub)
import ${packageName}.domain.${subClassName};
#end

/**
 * ${functionName}Mapper接口
 *
 * @author ${author}
 * @date ${datetime}
 */
public interface ${ClassName}Mapper extends BaseMapper<${ClassName}> {

}

 service.java.vm

package ${packageName}.service;

import ${packageName}.domain.${ClassName};
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * ${functionName}Service接口
 *
 * @author ${author}
 * @date ${datetime}
 */
public interface I${ClassName}Service extends IService<${ClassName}> {

}

 serviceImpl.java.vm

package ${packageName}.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
    #foreach ($column in $columns)
        #if($column.javaField == 'createTime' || $column.javaField == 'updateTime')
        import com.ruoyi.common.utils.DateUtils;
            #break
        #end
    #end
import org.springframework.stereotype.Service;
    #if($table.sub)
    import java.util.ArrayList;
    import com.ruoyi.common.utils.StringUtils;
    import org.springframework.transaction.annotation.Transactional;
    import ${packageName}.domain.${subClassName};
    #end
import ${packageName}.mapper.${ClassName}Mapper;
import ${packageName}.domain.${ClassName};
import ${packageName}.service.I${ClassName}Service;

/**
 * ${functionName}Service业务层处理
 *
 * @author ${author}
 * @date ${datetime}
 */
@Service
public class ${ClassName}ServiceImpl extends ServiceImpl<${ClassName}Mapper, ${ClassName}>
        implements I${ClassName}Service {

}

 controller.java.vm

package ${packageName}.controller;

import java.util.List;
import javax.servlet.http.HttpServletResponse;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.enums.BusinessType;
import ${packageName}.domain.${ClassName};
import ${packageName}.service.I${ClassName}Service;
import com.ruoyi.common.utils.poi.ExcelUtil;
#if($table.crud || $table.sub)
import com.ruoyi.common.core.page.TableDataInfo;
#elseif($table.tree)
#end

/**
 * ${functionName}Controller
 * 
 * @author ${author}
 * @date ${datetime}
 */
@RestController
@RequestMapping("/${moduleName}/${businessName}")
public class ${ClassName}Controller extends BaseController
{
    @Autowired
    private I${ClassName}Service ${className}Service;

    /**
     * 查询${functionName}列表
     */
    @PreAuthorize("@ss.hasPermi('${permissionPrefix}:list')")
    @GetMapping("/list")
#if($table.crud || $table.sub)
    public TableDataInfo list(${ClassName} ${className})
    {
##        startPage();
        List<${ClassName}> list = ${className}Service.list();
        return getDataTable(list);
    }
#elseif($table.tree)
    public AjaxResult list(${ClassName} ${className})
    {
        List<${ClassName}> list = ${className}Service.list();
        return success(list);
    }
#end

    /**
     * 导出${functionName}列表
     */
    @PreAuthorize("@ss.hasPermi('${permissionPrefix}:export')")
    @Log(title = "${functionName}", businessType = BusinessType.EXPORT)
    @PostMapping("/export")
    public void export(HttpServletResponse response, ${ClassName} ${className})
    {
        List<${ClassName}> list = ${className}Service.list();
        ExcelUtil<${ClassName}> util = new ExcelUtil<${ClassName}>(${ClassName}.class);
        util.exportExcel(response, list, "${functionName}数据");
    }

    /**
     * 获取${functionName}详细信息
     */
    @PreAuthorize("@ss.hasPermi('${permissionPrefix}:query')")
    @GetMapping(value = "/{${pkColumn.javaField}}")
    public AjaxResult getInfo(@PathVariable("${pkColumn.javaField}") ${pkColumn.javaType} ${pkColumn.javaField})
    {
        return success(${className}Service.getById(${pkColumn.javaField}));
    }

    /**
     * 新增${functionName}
     */
    @PreAuthorize("@ss.hasPermi('${permissionPrefix}:add')")
    @Log(title = "${functionName}", businessType = BusinessType.INSERT)
    @PostMapping
    public AjaxResult add(@RequestBody ${ClassName} ${className})
    {
        return toAjax(${className}Service.save(${className}));
    }

    /**
     * 修改${functionName}
     */
    @PreAuthorize("@ss.hasPermi('${permissionPrefix}:edit')")
    @Log(title = "${functionName}", businessType = BusinessType.UPDATE)
    @PutMapping
    public AjaxResult edit(@RequestBody ${ClassName} ${className})
    {
        return toAjax(${className}Service.updateById(${className}));
    }

    /**
     * 删除${functionName}
     */
    @PreAuthorize("@ss.hasPermi('${permissionPrefix}:remove')")
    @Log(title = "${functionName}", businessType = BusinessType.DELETE)
	@DeleteMapping("/{${pkColumn.javaField}s}")
    public AjaxResult remove(@PathVariable List<Integer> ${pkColumn.javaField}s)
    {
        return toAjax(${className}Service.removeBatchByIds(${pkColumn.javaField}s));
    }
}

 mapper.xml.vm

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="${packageName}.mapper.${ClassName}Mapper">

    <resultMap type="${packageName}.domain.${ClassName}" id="${ClassName}Result">
        #foreach ($column in $columns)
            <result property="${column.javaField}"    column="${column.columnName}"    />
        #end
    </resultMap>
    #if($table.sub)

        <resultMap id="${ClassName}${subClassName}Result" type="${ClassName}" extends="${ClassName}Result">
            <collection property="${subclassName}List" ofType="${subClassName}" column="${pkColumn.columnName}" select="select${subClassName}List" />
        </resultMap>

        <resultMap type="${subClassName}" id="${subClassName}Result">
            #foreach ($column in $subTable.columns)
                <result property="${column.javaField}"    column="${column.columnName}"    />
            #end
        </resultMap>
    #end

    <sql id="select${ClassName}Vo">
        select#foreach($column in $columns) $column.columnName#if($foreach.count != $columns.size()),#end#end from ${tableName}
    </sql>

</mapper>
在若依Ruoyi-Vue中集成mybatisplus实现mybatis增强
程序员诚哥
04-25 5503
MyBatisPlus是基于MyBatis的一款优秀持久层框架增强工具，它在MyBatis的基础上提供了丰富而强大的CRUD操作、条件构造器、全局通用操作、代码生成器等特性，极大地简化了开发过程，提升了开发效率。MyBatisPlus通过无侵入式的设计理念，使得在享受其带来的便利同时，无需对现有MyBatis项目进行大规模改造。
初始若依项目修改代码模板（二）（MyBatis-Plus篇）
h41256的博客
10-11 1256
本文详细介绍了如何修改若依框架代码模板以实现MyBatis-Plus的自动集成。
Ruoyi项目MyBatis升级MyBatis-Plus指南
qq_40603125的博客
09-01 716
本文介绍了如何将Ruoyi项目中的MyBatis升级到MyBatis-Plus的详细步骤。主要内容包括：在ruoyi-common模块添加MyBatis-Plus依赖；修改application.yml配置文件；创建MybatisPlusConfig配置类并添加分页、乐观锁等插件；以及升级后需要对Service接口、Service实现类和Mapper接口进行的修改。升级后可以继续使用原有功能，同时获得MyBatis-Plus提供的增强CRUD操作能力。
若依框架将Mybatis改成MybatisPlus
weixin_53618357的博客
08-13 2462
ruoyi-admin下src\main\resources\application.yml,注释mybatis的配置，新增plus的配置，这段配置我是从若依官方拷贝过来的，如果跟你实际不一样就修改一下。2.在包下com.ruoyi.framework.config新增MybatisPlusConfig配置类。1.将包下com.ruoyi.framework.config的MybatisConfig配置类注释掉。
若依 MyBatis改为MyBatis-Plus
beenles的博客
07-29 8591
在若依项目【我的若依框架版本号为：3.8.7】的总目录pom.xml文件中，引入MyBatis-Plus相关依赖：代码如下，根据上图将两块代码放入对应位置：-- mybatis-plus 增强CRUD -->
若依框架MyBatis改为MyBatis-Plus
开源福利博客提供源代码、软件、程序等研究学习使用。
12-18 956
ruoyi-admin下src\main\resources\application.yml,注释mybatis的配置，新增plus的配置，这段配置我是从若依官方拷贝过来的，如果跟你实际不一样就修改一下。在framework中，找到MybatisConfig文件，然后删除，在刚删除的文件夹下，新建一个MybatisPlus的java文件，复制已下内容到java文件中。ruoyi-generator下src\main\resources\vm\java 文件夹下面，直接文件内容替换。
若依框架整合mybatis-plus
yao136的专栏
04-06 6191
mybatis-plus会自动生成CURD的一些基础，方便快速开发使用，若依框架本身使用的是mybaits，打算将若依框架升级mybaits-plus.一、Mybaits-Plus（简称 MP）是一个的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。就这样可以了。
三个步骤：若依分离版框架升级Mybatis-Plus
浩方
07-24 1966
本文详细介绍了如何将若依分离版框架(RuoYi v3.9.0)升级集成Mybatis-Plus的完整过程。主要步骤包括：1)修改application.yml配置文件，替换原有Mybatis配置为Mybatis-Plus配置；2)在ruoyi-common模块添加Mybatis-Plus依赖；3)重写MyBatisPlusConfig配置类，集成分页、乐观锁等插件；4)通过SysDeptMapper测试验证功能。文章提供了完整的代码示例和配置说明，并提醒注意SpringBoot版本的兼容性问题。整个升级过程
SpringBoot3(若依框架)集成Mybatis-Plus和单元测试功能,以及问题解决
weixin_43244120的博客
07-25 1618
本文介绍了MyBatis-Plus的集成步骤，主要包括：1.在父级pom.xml中添加MyBatis-Plus相关依赖；2.修改application.yml配置文件，将mybatis配置替换为mybatis-plus；3.配置MybatisPlusConfig类，包含动态表名、分页插件、乐观锁等功能；4.提供了分表功能相关的工具类（MybatisPlusUtils）和拦截器（DynamicCreateTableInterceptor）实现。文章特别提醒注意MyBatis-Plus与MyBatis版本兼容性
若依框架中，mybatis升级mybatis-plus实现多租户插件
最新发布
10-22
首先，用户的问题是：“我想查找在若依框架中将MyBatis升级为MyBatis-Plus并实现多租户插件的方法”。用户指定了参考站内引用，提供了四个引用：[^1], [^2], [^3], [^4]。这些引用讨论了MyBatis-Plus和MyBatis-Flex...
若依vue完美整合mybatisplus
03-04
若依vue完美整合mybatisplus，根据若依官网前后端分离版框架修改，完美整合mybatisplus，便于开发企业管理系统。
若依-mybatisplus框架
03-04
若依官网框架，完美整合mybatis框架，轻松开发管理系统。
MyBatis-Plus详细讲解(整合spring Boot)
qq_42003636的博客
02-20 2796
Piwigo相册，可以分享生活、记录漫漫人生路中的美好时光和感动，希望这个可以陪伴你的美好回忆。强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求。MyBatis-Plus（简称 MP），是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库。
在若依框架中集成和使用MyBatis-Plus
BULLS231的博客
07-03 5580
若依框架集成mybatisplus在Mapper接口下写SQL语句的方法
若依框架集成mybatisplus
qq_41399941的博客
10-30 4335
若依集成mybatisplus
RuoYi-Vue若依框架-如何集成MybatisPlus
来都来了
10-14 2549
ruoyi-vue轻松集成mybatisplus
若依集成MybatisPlus
weixin_42023748的博客
10-17 3129
目录一、依赖变更1. MybatisPlus依赖2. pagehelper依赖修改二、相关配置1. yml配置1.1 注释掉原Mybatis配置1.2 加入MybatisPlus的配置1.3 注释掉原MybatisConfig.class三、其他配置及功能实现1. 自动补全create_time等信息2. 实现MP分页3. 实现MybatisPlus代码生成3.1 方法一：使用MP自带的代码生成方法3.2 方法二：修改若依框架的代码生成部分以实现MP代码生成。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值