若依 MyBatis改为MyBatis-Plus

客官°小女子只卖身不卖艺 2023-09-24 20:07 9阅读 0赞

### **主要内容：升级成mybatis-plus，代码生成也是mybatis-plus版本** ###

**跟着我一步一步来，就可完成升级！**

**检查：启动程序，先保证若依能启动**

#### **第一步：添加依赖** ####

##### 这里需要在两个地方添加，一个是最外面的父工程的pom.xml，一个是ruoyi-common的pom.xml。 #####

最外面的父工程的pom.xml：

1.添加版本信息

![cf7d1f409863410b902861f49b78dfba.png][]

代码：
    
            <mybatis-pluc.version>3.4.2</mybatis-pluc.version>

2.添加mybatis-plus依赖

![6096c4bd847f441e9293a9b0e2b4f134.png][]

代码：

<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.2</version>
    </dependency>

ruoyi-common的pom.xml：

1.直接继承父工程的依赖

![06385196265f42aebe2f8ca53dfacc3c.png][]

第一步验证：

admin的包中的application.yml文件有mybatis-plus的提示，说明依赖弄好啦！

![3f05e091aade40b8ad341cb9af46fffe.png][]

第二步：修改application.yml文件

1.删除旧的mybatis配置

![39b279cf0aa84700905fbcb4aadc6e2b.png][]

2.写入新配置

![1ee70bff179a4495be80b296764e9d6b.png][]

代码：

# MyBatis Plus配置
    mybatis-plus:
      # 搜索指定包别名   根据自己的项目来
      typeAliasesPackage: com.rchuing.sis.**.domain 
      # 配置mapper的扫描，找到所有的mapper.xml映射文件
      mapperLocations: classpath*:mapper/**/*Mapper.xml
      # 加载全局的配置文件
      configLocation: classpath:mybatis/mybatis-config.xml
      global-config:
        enable-sql-runner: true
        db-config:
          id-type: auto

第三步：重写mybatis配置文件

1.在framework中，找到MybatisConfig文件，然后删除。

![07a1cce820254e0cad11d459eca3e136.png][]

2.在刚删除的文件夹下，新建一个MybatisPlus的java文件

复制已下内容到java文件中：

/**
     * 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
            paginationInnerInterceptor.setDbType(DbType.MYSQL);
            // 设置最大单页限制数量，默认 500 条，-1 不受限制
            paginationInnerInterceptor.setMaxLimit(-1L);
            return paginationInnerInterceptor;
        }
    
        /**
         * 乐观锁插件 https://baomidou.com/guide/interceptor-optimistic-locker.html
         */
        public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor()
        {
            return new OptimisticLockerInnerInterceptor();
        }
    
        /**
         * 如果是对全表的删除或更新操作，就会终止该操作 https://baomidou.com/guide/interceptor-block-attack.html
         */
        public BlockAttackInnerInterceptor blockAttackInnerInterceptor()
        {
            return new BlockAttackInnerInterceptor();
        }
    }

如图：

![6013c190dabd48cb94edb12070eaa507.png][]

到这里Mybatis-plus就升级完成了。但代码生成里面还是以前mybatis的，这里也需要升级一下，方便代码生成。

#### 第四步:把代码生成修改为mybatis-plus版本 ####

1.在generator找到vm中的java文件夹

![295b16675cc446e9a73bf58dd0bfd2a3.png][]

**2.修改里面内容：这里直接上代码了，找到对应的直接复制粘贴就行**。

#### 2.1:domain.java.vm ####

package ${packageName}.domain;
    
    #foreach ($import in $importList)
    import ${import};
    #end
    import com.baomidou.mybatisplus.annotation.IdType;
    import com.baomidou.mybatisplus.annotation.TableId;
    import com.baomidou.mybatisplus.annotation.TableName;
    import org.apache.commons.lang3.builder.ToStringBuilder;
    import org.apache.commons.lang3.builder.ToStringStyle;
    import com.rchuing.sis.common.annotation.Excel;
    #if($table.crud || $table.sub)
    import com.rchuing.sis.common.core.domain.BaseEntity;
    #elseif($table.tree)
    import com.fenghuang.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
    @TableName(resultMap = "${packageName}.mapper.${ClassName}Mapper.${ClassName}Result")
    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.AUTO)
            #end
        private $column.javaType $column.javaField;
    
        #end
    #end
    #if($table.sub)
    /** $table.subTable.functionName信息 */
    private List<${subClassName}> ${subclassName}List;
    
    #end
    #foreach ($column in $columns)
        #if(!$table.isSuperColumn($column.javaField))
            #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
        public void set${AttrName}($column.javaType $column.javaField)
                {
                this.$column.javaField = $column.javaField;
                }
    
        public $column.javaType get${AttrName}()
                {
                return $column.javaField;
                }
        #end
    #end
    
    #if($table.sub)
    public List<${subClassName}> get${subClassName}List()
            {
            return ${subclassName}List;
            }
    
    public void set${subClassName}List(List<${subClassName}> ${subclassName}List)
            {
            this.${subclassName}List = ${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();
            }
            }

#### 2.2:mapper.java.vm ####

package ${packageName}.mapper;
    
    import java.util.List;
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import ${packageName}.domain.${ClassName};
    #if($table.sub)
    import ${packageName}.domain.${subClassName};
    #end
    
    /**
     * ${functionName}Mapper接口
     *
     * @author ${author}
     * @date ${datetime}
     */
    public interface ${ClassName}Mapper extends BaseMapper<${ClassName}> {
        /**
         * 查询${functionName}
         *
         * @param ${pkColumn.javaField} ${functionName}主键
         * @return ${functionName}
         */
        public ${ClassName} select${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaType} ${pkColumn.javaField});
    
        /**
         * 查询${functionName}列表
         *
         * @param ${className} ${functionName}
         * @return ${functionName}集合
         */
        public List<${ClassName}> select${ClassName}List(${ClassName} ${className});
    
        /**
         * 新增${functionName}
         *
         * @param ${className} ${functionName}
         * @return 结果
         */
        public int insert${ClassName}(${ClassName} ${className});
    
        /**
         * 修改${functionName}
         *
         * @param ${className} ${functionName}
         * @return 结果
         */
        public int update${ClassName}(${ClassName} ${className});
    
        /**
         * 删除${functionName}
         *
         * @param ${pkColumn.javaField} ${functionName}主键
         * @return 结果
         */
        public int delete${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaType} ${pkColumn.javaField});
    
        /**
         * 批量删除${functionName}
         *
         * @param ${pkColumn.javaField}s 需要删除的数据主键集合
         * @return 结果
         */
        public int delete${ClassName}By${pkColumn.capJavaField}s(${pkColumn.javaType}[] ${pkColumn.javaField}s);
    #if($table.sub)
    
        /**
         * 批量删除${subTable.functionName}
         *
         * @param ${pkColumn.javaField}s 需要删除的数据主键集合
         * @return 结果
         */
        public int delete${subClassName}By${subTableFkClassName}s(${pkColumn.javaType}[] ${pkColumn.javaField}s);
    
        /**
         * 批量新增${subTable.functionName}
         *
         * @param ${subclassName}List ${subTable.functionName}列表
         * @return 结果
         */
        public int batch${subClassName}(List<${subClassName}> ${subclassName}List);
    
    
        /**
         * 通过${functionName}主键删除${subTable.functionName}信息
         *
         * @param ${pkColumn.javaField} ${functionName}ID
         * @return 结果
         */
        public int delete${subClassName}By${subTableFkClassName}(${pkColumn.javaType} ${pkColumn.javaField});
    #end
    }

#### 2.3:service.java.vm ####

package ${packageName}.service;
    
    import java.util.List;
    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}> {
        /**
         * 查询${functionName}
         *
         * @param ${pkColumn.javaField} ${functionName}主键
         * @return ${functionName}
         */
        public ${ClassName} select${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaType} ${pkColumn.javaField});
    
        /**
         * 查询${functionName}列表
         *
         * @param ${className} ${functionName}
         * @return ${functionName}集合
         */
        public List<${ClassName}> select${ClassName}List(${ClassName} ${className});
    
        /**
         * 新增${functionName}
         *
         * @param ${className} ${functionName}
         * @return 结果
         */
        public int insert${ClassName}(${ClassName} ${className});
    
        /**
         * 修改${functionName}
         *
         * @param ${className} ${functionName}
         * @return 结果
         */
        public int update${ClassName}(${ClassName} ${className});
    
        /**
         * 批量删除${functionName}
         *
         * @param ${pkColumn.javaField}s 需要删除的${functionName}主键集合
         * @return 结果
         */
        public int delete${ClassName}By${pkColumn.capJavaField}s(${pkColumn.javaType}[] ${pkColumn.javaField}s);
    
        /**
         * 删除${functionName}信息
         *
         * @param ${pkColumn.javaField} ${functionName}主键
         * @return 结果
         */
        public int delete${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaType} ${pkColumn.javaField});
    }

#### 2.4:serviceimpl.java.vm ####

package ${packageName}.service.impl;
    
    import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
    import java.util.List;
    #foreach ($column in $columns)
    #if($column.javaField == 'createTime' || $column.javaField == 'updateTime')
    import com.rchuing.common.utils.DateUtils;
    #break
    #end
    #end
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    #if($table.sub)
    import java.util.ArrayList;
    import com.rchuing.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 {
        @Autowired
        private ${ClassName}Mapper ${className}Mapper;
    
        /**
         * 查询${functionName}
         *
         * @param ${pkColumn.javaField} ${functionName}主键
         * @return ${functionName}
         */
        @Override
        public ${ClassName} select${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaType} ${pkColumn.javaField}) {
            return ${className}Mapper.select${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaField});
        }
    
        /**
         * 查询${functionName}列表
         *
         * @param ${className} ${functionName}
         * @return ${functionName}
         */
        @Override
        public List<${ClassName}> select${ClassName}List(${ClassName} ${className}) {
            return ${className}Mapper.select${ClassName}List(${className});
        }
    
        /**
         * 新增${functionName}
         *
         * @param ${className} ${functionName}
         * @return 结果
         */
    #if($table.sub)
        @Transactional
    #end
        @Override
        public int insert${ClassName}(${ClassName} ${className}) {
    #foreach ($column in $columns)
    #if($column.javaField == 'createTime')
            ${className}.setCreateTime(DateUtils.getNowDate());
    #end
    #end
    #if($table.sub)
            int rows = ${className}Mapper.insert${ClassName}(${className});
            insert${subClassName}(${className});
            return rows;
    #else
            return ${className}Mapper.insert${ClassName}(${className});
    #end
        }
    
        /**
         * 修改${functionName}
         *
         * @param ${className} ${functionName}
         * @return 结果
         */
    #if($table.sub)
        @Transactional
    #end
        @Override
        public int update${ClassName}(${ClassName} ${className}) {
    #foreach ($column in $columns)
    #if($column.javaField == 'updateTime')
            ${className}.setUpdateTime(DateUtils.getNowDate());
    #end
    #end
    #if($table.sub)
            ${className}Mapper.delete${subClassName}By${subTableFkClassName}(${className}.get${pkColumn.capJavaField}());
            insert${subClassName}(${className});
    #end
            return ${className}Mapper.update${ClassName}(${className});
        }
    
        /**
         * 批量删除${functionName}
         *
         * @param ${pkColumn.javaField}s 需要删除的${functionName}主键
         * @return 结果
         */
    #if($table.sub)
        @Transactional
    #end
        @Override
        public int delete${ClassName}By${pkColumn.capJavaField}s(${pkColumn.javaType}[] ${pkColumn.javaField}s) {
    #if($table.sub)
            ${className}Mapper.delete${subClassName}By${subTableFkClassName}s(${pkColumn.javaField}s);
    #end
            return ${className}Mapper.delete${ClassName}By${pkColumn.capJavaField}s(${pkColumn.javaField}s);
        }
    
        /**
         * 删除${functionName}信息
         *
         * @param ${pkColumn.javaField} ${functionName}主键
         * @return 结果
         */
    #if($table.sub)
        @Transactional
    #end
        @Override
        public int delete${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaType} ${pkColumn.javaField}) {
    #if($table.sub)
            ${className}Mapper.delete${subClassName}By${subTableFkClassName}(${pkColumn.javaField});
    #end
            return ${className}Mapper.delete${ClassName}By${pkColumn.capJavaField}(${pkColumn.javaField});
        }
    #if($table.sub)
    
        /**
         * 新增${subTable.functionName}信息
         *
         * @param ${className} ${functionName}对象
         */
        public void insert${subClassName}(${ClassName} ${className}) {
            List<${subClassName}> ${subclassName}List = ${className}.get${subClassName}List();
            ${pkColumn.javaType} ${pkColumn.javaField} = ${className}.get${pkColumn.capJavaField}();
            if (StringUtils.isNotNull(${subclassName}List))
            {
                List<${subClassName}> list = new ArrayList<${subClassName}>();
                for (${subClassName} ${subclassName} : ${subclassName}List)
                {
                    ${subclassName}.set${subTableFkClassName}(${pkColumn.javaField});
                    list.add(${subclassName});
                }
                if (list.size() > 0)
                {
                    ${className}Mapper.batch${subClassName}(list);
                }
            }
        }
    #end
    }

#### 2.5:sub-domain.java.vm ####

package ${packageName}.domain;
    
    #foreach ($import in $subImportList)
    import ${import};
    #end
    import org.apache.commons.lang3.builder.ToStringBuilder;
    import org.apache.commons.lang3.builder.ToStringStyle;
    import com.rchuing.common.annotation.Excel;
    import com.rchuing.common.core.domain.BaseEntity;
    
    /**
     * ${subTable.functionName}对象 ${subTableName}
     *
     * @author ${author}
     * @date ${datetime}
     */
    public class ${subClassName} extends BaseEntity {
        private static final long serialVersionUID = 1L;
    
    #foreach ($column in $subTable.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
    #foreach ($column in $subTable.columns)
    #if(!$table.isSuperColumn($column.javaField))
    #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
        public void set${AttrName}($column.javaType $column.javaField) {
            this.$column.javaField = $column.javaField;
        }
    
        public $column.javaType get${AttrName}() {
            return $column.javaField;
        }
    #end
    #end
    
        @Override
        public String toString() {
            return new ToStringBuilder(this,ToStringStyle.MULTI_LINE_STYLE)
    #foreach ($column in $subTable.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
                .toString();
        }
    }

**到这里就升级完成。**

**下面进行测试：**

![d8265481387044c4a9a94c8603ca474d.png][]

![4403f6778a784138a8e9df57893fce51.png][]

3.如果看到mybatis的东西，说明升级成功！

![32742c36f25c4422afc86eb5c0007554.png][]

## **注意：** ##

**1.这里可能有些包的路径不对，把爆红的包删除，重新导入就可！**

**2.因为实际项目路径不同，这里****可能****需要手动修改！**

**![73a4174b95af4494b0bbd3fdc87fc041.png][]**

**3.在BaseEntity类中**

![1a7da61b05c54e6e927ff908ebe9a880.png][]

[cf7d1f409863410b902861f49b78dfba.png]: https://img-blog.csdnimg.cn/cf7d1f409863410b902861f49b78dfba.png
[6096c4bd847f441e9293a9b0e2b4f134.png]: https://img-blog.csdnimg.cn/6096c4bd847f441e9293a9b0e2b4f134.png
[06385196265f42aebe2f8ca53dfacc3c.png]: https://img-blog.csdnimg.cn/06385196265f42aebe2f8ca53dfacc3c.png
[3f05e091aade40b8ad341cb9af46fffe.png]: https://img-blog.csdnimg.cn/3f05e091aade40b8ad341cb9af46fffe.png
[39b279cf0aa84700905fbcb4aadc6e2b.png]: https://img-blog.csdnimg.cn/39b279cf0aa84700905fbcb4aadc6e2b.png
[1ee70bff179a4495be80b296764e9d6b.png]: https://img-blog.csdnimg.cn/1ee70bff179a4495be80b296764e9d6b.png
[07a1cce820254e0cad11d459eca3e136.png]: https://img-blog.csdnimg.cn/07a1cce820254e0cad11d459eca3e136.png
[6013c190dabd48cb94edb12070eaa507.png]: https://img-blog.csdnimg.cn/6013c190dabd48cb94edb12070eaa507.png
[295b16675cc446e9a73bf58dd0bfd2a3.png]: https://img-blog.csdnimg.cn/295b16675cc446e9a73bf58dd0bfd2a3.png
[d8265481387044c4a9a94c8603ca474d.png]: https://img-blog.csdnimg.cn/d8265481387044c4a9a94c8603ca474d.png
[4403f6778a784138a8e9df57893fce51.png]: https://img-blog.csdnimg.cn/4403f6778a784138a8e9df57893fce51.png
[32742c36f25c4422afc86eb5c0007554.png]: https://img-blog.csdnimg.cn/32742c36f25c4422afc86eb5c0007554.png
[73a4174b95af4494b0bbd3fdc87fc041.png]: https://img-blog.csdnimg.cn/73a4174b95af4494b0bbd3fdc87fc041.png
[1a7da61b05c54e6e927ff908ebe9a880.png]: https://img-blog.csdnimg.cn/1a7da61b05c54e6e927ff908ebe9a880.png