快捷導(dǎo)航

mybatisX插件的使用及打包成配置

更新時(shí)間：2025年05月12日 11:23:35 作者：錢多多_qdd

本文主要介紹了mybatisX插件的使用及打包成配置,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

一、使用idea鏈接數(shù)據(jù)庫

在這里插入圖片描述

二、安裝mybatis-X插件

File–>Settings–>Plugins–>Marketplace,=，搜索MyBatisX–>install

在這里插入圖片描述

三、生成代碼內(nèi)容

3.1 配置本地驅(qū)動(dòng)包

在這里插入圖片描述

3.2 側(cè)邊欄打開數(shù)據(jù)庫，選擇要生成代碼的表格，在表名上右擊，點(diǎn)擊MybatisX-Generator

在這里插入圖片描述

3.3 設(shè)置類名生成規(guī)則及生成代碼的路徑

路徑的生成按照物理路徑是： module path --》 base path --》base package
（這里注意如果想實(shí)體類帶Entity后綴，在extra class suffix一欄填上Entity即可）

在這里插入圖片描述

3.4 生成代碼

在這里插入圖片描述

template：

custom-model-swagger：生成實(shí)體文件，屬性上會(huì)自動(dòng)增加swagger的相關(guān)注解，
default-all：生成實(shí)體文件、xml文件和dao層接口文件，默認(rèn)會(huì)生成常用的增刪改查到的方法
mybatis-plus3：生成實(shí)體文件、xml文件、dao層接口文件、 service層接口文件和service層接口實(shí)現(xiàn)文件

3.4.1 mybatis-plus3案例

在這里插入圖片描述

3.4.2 效果代碼

實(shí)體類：

在這里插入圖片描述

mapper接口：

在這里插入圖片描述

service層：

在這里插入圖片描述

xml文件：

在這里插入圖片描述

四、配置文件

4.1 默認(rèn)的mybatis-plus3模板

模板文件包含：

在這里插入圖片描述

4.1.1 .meta.xml以及xx.ftl概覽

在這里插入圖片描述

從上圖中可以看到，此模板生成了四個(gè)文件，加上我們的entity，一共是5個(gè)。

serviceInterface.ftl：

在這里插入圖片描述

serviceImpl.ftl：

package ${baseInfo.packageName};

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import ${tableClass.fullClassName};
import ${serviceInterface.packageName}.${serviceInterface.fileName};
import ${mapperInterface.packageName}.${mapperInterface.fileName};
<#if baseService??&&baseService!="">
import ${baseService};
    <#list baseService?split(".") as simpleName>
        <#if !simpleName_has_next>
            <#assign serviceSimpleName>${simpleName}</#assign>
        </#if>
    </#list>
</#if>
import org.springframework.stereotype.Service;

/**
* @author ${author!}
* @description 針對(duì)表【${tableClass.tableName}<#if tableClass.remark?has_content>(${tableClass.remark!})</#if>】的數(shù)據(jù)庫操作Service實(shí)現(xiàn)
* @createDate ${.now?string('yyyy-MM-dd HH:mm:ss')}
*/
@Service
public class ${baseInfo.fileName} extends ServiceImpl<${mapperInterface.fileName}, ${tableClass.shortClassName}>
    implements ${serviceInterface.fileName}{

}

mapperInterface.ftl：

package ${mapperInterface.packageName};

import ${tableClass.fullClassName};
<#if tableClass.pkFields??>
    <#list tableClass.pkFields as field><#assign pkName>${field.shortTypeName}</#assign></#list>
</#if>
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

/**
* @author ${author!}
* @description 針對(duì)表【${tableClass.tableName}<#if tableClass.remark?has_content>(${tableClass.remark!})</#if>】的數(shù)據(jù)庫操作Mapper
* @createDate ${.now?string('yyyy-MM-dd HH:mm:ss')}
* @Entity ${tableClass.fullClassName}
*/
public interface ${mapperInterface.fileName} extends BaseMapper<${tableClass.shortClassName}> {

}

mapperXml.ftl：

在這里插入圖片描述

4.2 我的mybatis-plus3模板

要點(diǎn)：把service改為repository，作為倉儲(chǔ)層，而不是業(yè)務(wù)層。

在這里插入圖片描述

.meta.xml:

<?xml version="1.0" encoding="utf-8" ?>
<templates>
    <template>
        <property name="configName" value="repositoryInterface"/>
        <property name="configFile" value="repositoryInterface.ftl"/>
        <property name="fileName" value="${domain.fileName}Repository"/>
        <property name="suffix" value=".java"/>
        <property name="packageName" value="${domain.basePackage}.domain.gateway.db"/>
        <property name="encoding" value="${domain.encoding}"/>
        <property name="basePath" value="${domain.basePath}"/>
    </template>
    <template>
        <property name="configName" value="repositoryImpl"/>
        <property name="configFile" value="repositoryImpl.ftl"/>
        <property name="fileName" value="${domain.fileName}RepositoryImpl"/>
        <property name="suffix" value=".java"/>
        <property name="packageName" value="${domain.basePackage}.infrastructure.repository"/>
        <property name="encoding" value="${domain.encoding}"/>
        <property name="basePath" value="${domain.basePath}"/>
    </template>
    <template>
        <property name="configName" value="mapperInterface"/>
        <property name="configFile" value="mapperInterface.ftl"/>
        <property name="fileName" value="${domain.fileName}Mapper"/>
        <property name="suffix" value=".java"/>
        <property name="packageName" value="${domain.basePackage}.infrastructure.repository.mybatis.mapper"/>
        <property name="encoding" value="${domain.encoding}"/>
        <property name="basePath" value="${domain.basePath}"/>
    </template>
    <template>
        <property name="configName" value="mapperXml"/>
        <property name="configFile" value="mapperXml.ftl"/>
        <property name="fileName" value="${domain.fileName}Mapper"/>
        <property name="suffix" value=".xml"/>
        <property name="packageName" value="mapper"/>
        <property name="encoding" value="${domain.encoding}"/>
        <property name="basePath" value="src/main/resources"/>
    </template>
</templates>

mapperInterface.ftl：略，和4.1相同；

mapperXml.ftl：略，和4.1相同；

repositoryInterface.ftl：

package ${baseInfo.packageName};

import ${tableClass.fullClassName};
<#if baseService??&&baseService!="">
import ${baseService};
    <#list baseService?split(".") as simpleName>
        <#if !simpleName_has_next>
            <#assign serviceSimpleName>${simpleName}</#assign>
        </#if>
    </#list>
</#if>
import com.baomidou.mybatisplus.extension.service.IService;

/**
* @author ${author!}
* @description 針對(duì)表【${tableClass.tableName}<#if tableClass.remark?has_content>(${tableClass.remark!})</#if>】的數(shù)據(jù)庫操作Service
* @createDate ${.now?string('yyyy-MM-dd HH:mm:ss')}
*/
public interface ${baseInfo.fileName} extends IService<${tableClass.shortClassName}> {

}

其實(shí)和4.1也是一樣的，不同的是.meta.xml里的參數(shù)變了：

在這里插入圖片描述

repositoryImpl.ftl：

package ${baseInfo.packageName};

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import ${tableClass.fullClassName};
import ${repositoryInterface.packageName}.${repositoryInterface.fileName};
import ${mapperInterface.packageName}.${mapperInterface.fileName};
<#if baseService??&&baseService!="">
import ${baseService};
    <#list baseService?split(".") as simpleName>
        <#if !simpleName_has_next>
            <#assign serviceSimpleName>${simpleName}</#assign>
        </#if>
    </#list>
</#if>
import org.springframework.stereotype.Service;

/**
* @author ${author!}
* @description 針對(duì)表【${tableClass.tableName}<#if tableClass.remark?has_content>(${tableClass.remark!})</#if>】的數(shù)據(jù)庫操作Service實(shí)現(xiàn)
* @createDate ${.now?string('yyyy-MM-dd HH:mm:ss')}
*/
@Service
public class ${baseInfo.fileName} extends ServiceImpl<${mapperInterface.fileName}, ${tableClass.shortClassName}> implements ${repositoryInterface.fileName}{

}

同上，和4.1也是一樣的，不同的兩點(diǎn)：