#mybatis-plus自動生成代碼

一、介紹

本教程將介紹如何使用 mybatis-plus 工具自動給我們生成 Controller、Service、Entity、Mapper、Mapper.xml 層代碼

要求:

① 生成的Mapper接口，需要繼承 BaseMapper

② 生成的Entity 類，需要繼承 Model

③ 生成的 Service，默認名稱下是以 I 開頭的接口, 在生成Service層代碼中需要把這個 I 去掉

二、實現(xiàn)步驟

① 在數(shù)據(jù)庫中創(chuàng)建好 數(shù)據(jù)庫 與 要生成代碼對應(yīng)的表

這里拿 sys_dict 表舉例

/*==============================================================*/
/* DBMS name:      MySQL 5.0                                    */
/* Created on:     2020/9/25 9:34:58                            */
/*==============================================================*/


drop table if exists sys_dict;
/*==============================================================*/
/* Table: sys_dict                                              */
/*==============================================================*/
create table sys_dict
(
   id                   int not null auto_increment comment '主鍵',
   name                 varchar(50) comment '名稱',
   parent_id            int comment '父級ID',
   sort                 int comment '排序',
   type                 int comment '類型',
   create_by            int comment '創(chuàng)建人',
   create_date          datetime comment '創(chuàng)建時間',
   primary key (id)
);

alter table sys_dict comment '數(shù)據(jù)字典';

② 創(chuàng)建 一個SpringBoot 項目，其中 pom.xml 內(nèi)容如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.hytc.mall</groupId>
    <artifactId>hytcmall</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>hytcmall</name>
    <description>弘毅天承商城</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 動態(tài)數(shù)據(jù)源 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>2.5.4</version>
        </dependency>

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

        <!-- mybatis MVC -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>3.3.2</version>
        </dependency>

        <!-- mybatisPlus 代碼生成-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.3.2</version>
        </dependency>

        <!--執(zhí)行main方法前請注意，在生成文件的時候需要有一個模板引擎的選擇，MyBatis Plus的默認模板引擎是velocity。我們可以使用freemarker-->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
        </dependency>

        <!--數(shù)據(jù)庫鏈接    -->
        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>

        <!-- 非關(guān)系型數(shù)據(jù)庫Redis -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <!-- https://mvnrepository.com/artifact/redis.clients/jedis -->
        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
            <version>3.2.0</version>
        </dependency>

        <!-- 阿里巴巴連接池 -->
        <!-- https://mvnrepository.com/artifact/com.alibaba/druid-spring-boot-starter -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.22</version>
        </dependency>
        <!-- 阿里巴巴fastjson序列化 -->
        <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.58</version>
        </dependency>


        <!-- JWT -->
        <!-- https://mvnrepository.com/artifact/com.auth0/java-jwt -->
        <dependency>
            <groupId>com.auth0</groupId>
            <artifactId>java-jwt</artifactId>
            <version>3.10.2</version>
        </dependency>

        <!-- 常用工具類 -->
        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.10</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/cn.hutool/hutool-all -->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.3.0</version>
        </dependency>

        <!--工具類-->
        <dependency>
            <groupId>com.xiaoleilu</groupId>
            <artifactId>hutool-all</artifactId>
            <version>3.3.0</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

        <!-- swagger2 -->
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!--防止進入swagger頁面報類型轉(zhuǎn)換錯誤，排除2.9.2中的引用，手動增加1.5.21版本-->
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>1.5.21</version>
        </dependency>

        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.5.21</version>
        </dependency>


        <!-- 這里使用 swagger-bootstrap-ui 替代了原有丑陋的ui，拯救處女座~ -->
        <!-- https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>


        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
            <version>3.9</version>
        </dependency>

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml</artifactId>
            <version>3.7</version>
        </dependency>

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml-schemas</artifactId>
            <version>3.9</version>
        </dependency>



        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

③ 創(chuàng)建代碼生成類

package com.hytc.mall.hytcmall.generator;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @ClassName: MysqlGenerator
 * @Description:https://blog.csdn.net/u010559460/article/details/103945985/
 * https://www.cnblogs.com/wyrlzy/p/12033912.html
 * @Author: BYP <502955177@qq.com>
 * @Date: 2020/9/24 14:36
 * @Copyright: 2019 www.tydic.com Inc. All rights reserved.
 * 注意：本內(nèi)容僅限于弘毅天承信息技術(shù)股份有限公司內(nèi)部傳閱，禁止外泄以及用于其他的商業(yè)目
 */
public class MysqlGenerator {

    final static String  dirPath = "E://HYTC//project//mall//font//src//main//java";

    /**
     * <p>
     * MySQL 生成演示
     * </p>
     */
    public static void main(String[] args) {
        AutoGenerator mpg = new AutoGenerator();
        // 選擇 freemarker 引擎，默認 Veloctiy
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        gc.setOutputDir(dirPath);
        gc.setAuthor("baiYP");
        gc.setFileOverride(true); //是否覆蓋
        gc.setActiveRecord(true);// 不需要ActiveRecord特性的請改為false
        gc.setEnableCache(false);// XML 二級緩存
        gc.setBaseResultMap(true);// XML ResultMap
        gc.setBaseColumnList(true);// XML columList

        // 自定義文件命名，注意 %s 會自動填充表實體屬性！
        // gc.setMapperName("%sDao");
        // gc.setXmlName("%sMapper");
        // gc.setServiceName("MP%sService");
        // gc.setServiceImplName("%sServiceDiy");
        // gc.setControllerName("%sAction");
        mpg.setGlobalConfig(gc);

        // 數(shù)據(jù)源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setTypeConvert(new MySqlTypeConvert(){
            // 自定義數(shù)據(jù)庫表字段類型轉(zhuǎn)換【可選】
//            public DbColumnType processTypeConvert(String fieldType) {
//                System.out.println("轉(zhuǎn)換類型：" + fieldType);
//                // 注意?。rocessTypeConvert 存在默認類型轉(zhuǎn)換，如果不是你要的效果請自定義返回、非如下直接返回。
//                return super.processTypeConvert(fieldType);
//            }
        });
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setUrl("jdbc:mysql://localhost:3306/hytcmall_20200923?serverTimezone=UTC&characterEncoding=utf8&useUnicode=true&useSSL=false");
        mpg.setDataSource(dsc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        // strategy.setCapitalMode(true);// 全局大寫命名 ORACLE 注意


        //strategy.setTablePrefix(new String[] { "tb_", "sys_" });// 此處可以修改為您的表前綴


        strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
        // strategy.setInclude(new String[] { "user" }); // 需要生成的表
         strategy.setExclude(new String[]{"sys_dict","tb_goods"}); // 排除生成的表
        // 自定義實體父類
        // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
        // 自定義實體，公共字段
        // strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
        // 自定義 mapper 父類
        // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
        // 自定義 service 父類
        // strategy.setSuperServiceClass("com.baomidou.demo.TestService");
        // 自定義 service 實現(xiàn)類父類
        // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
        // 自定義 controller 父類
        // strategy.setSuperControllerClass("com.baomidou.demo.TestController");
        // 【實體】是否生成字段常量（默認 false）
        // public static final String ID = "test_id";
        // strategy.setEntityColumnConstant(true);
        // 【實體】是否為構(gòu)建者模型（默認 false）
        // public User setName(String name) {this.name = name; return this;}
        strategy.setEntityBuilderModel(true);
        mpg.setStrategy(strategy);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.hytc.mall.hytcmall");
        //pc.setModuleName("good");
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setServiceImpl("service.mpl");
        pc.setXml("xml");

        mpg.setPackageInfo(pc);

        // 注入自定義配置，可以在 VM 中使用 cfg.abc 【可無】
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                Map<String, Object> map = new HashMap<String, Object>();
                map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
                this.setMap(map);
            }
        };

        // 自定義 xxList.jsp 生成
        List<FileOutConfig> focList = new ArrayList<FileOutConfig>();
/*        focList.add(new FileOutConfig("/template/list.jsp.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸入文件名稱
                return "D://my_" + tableInfo.getEntityName() + ".jsp";
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);*/

        // 調(diào)整 xml 生成目錄演示
/*        focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return dirPath + tableInfo.getEntityName() + "Mapper.xml";
            }
        });
        cfg.setFileOutConfigList(focList);
        */
        mpg.setCfg(cfg);

        // 關(guān)閉默認 xml 生成，調(diào)整生成 至 根目錄
/*        TemplateConfig tc = new TemplateConfig();
        tc.setXml(null);
        mpg.setTemplate(tc);*/

        // 自定義模板配置，可以 copy 源碼 mybatis-plus/src/main/resources/templates 下面內(nèi)容修改，
        // 放置自己項目的 src/main/resources/templates 目錄下, 默認名稱一下可以不配置，也可以自定義模板名稱
        // TemplateConfig tc = new TemplateConfig();
        // tc.setController("...");
        // tc.setEntity("...");
        // tc.setMapper("...");
        // tc.setXml("...");
        // tc.setService("...");
        // tc.setServiceImpl("...");
        // 如上任何一個模塊如果設(shè)置 空 OR Null 將不生成該模塊。
        // mpg.setTemplate(tc);

        // 執(zhí)行生成
        mpg.execute();

        // 打印注入設(shè)置【可無】
        System.err.println(mpg.getCfg().getMap().get("abc"));
    }

}

三、項目生成后的存放地址以及代碼如下

① 項目的包結(jié)構(gòu)如下：


項目層級如圖所示：

②controller代碼如下：

package com.hytc.mall.hytcmall.controller;


import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.stereotype.Controller;

/**
 * <p>
 * 數(shù)據(jù)字典 前端控制器
 * </p>
 *
 * @author baiYP
 * @since 2020-09-24
 */
@Controller
@RequestMapping("sysDict")
public class SysDictController {

}
控制器如圖所示

③service代碼如下：

package com.hytc.mall.hytcmall.service;

import com.hytc.mall.hytcmall.entity.SysDict;
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * <p>
 * 數(shù)據(jù)字典 服務(wù)類
 * </p>
 *
 * @author baiYP
 * @since 2020-09-24
 */
public interface ISysDictService extends IService<SysDict> {

}
業(yè)務(wù)類如圖所示：

④serviceImpl實現(xiàn)類如下：

package com.hytc.mall.hytcmall.service.mpl;

import com.hytc.mall.hytcmall.entity.SysDict;
import com.hytc.mall.hytcmall.mapper.SysDictMapper;
import com.hytc.mall.hytcmall.service.ISysDictService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

/**
 * <p>
 * 數(shù)據(jù)字典 服務(wù)實現(xiàn)類
 * </p>
 *
 * @author baiYP
 * @since 2020-09-24
 */
@Service
public class SysDictServiceImpl extends ServiceImpl<SysDictMapper, SysDict> implements ISysDictService {

}
業(yè)務(wù)類實現(xiàn)如圖所示：

⑤entity實體如下：

package com.hytc.mall.hytcmall.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import com.baomidou.mybatisplus.annotation.TableId;
import java.time.LocalDateTime;
import java.io.Serializable;

/**
 * <p>
 * 數(shù)據(jù)字典
 * </p>
 *
 * @author baiYP
 * @since 2020-09-24
 */
public class SysDict extends Model<SysDict> {

    private static final long serialVersionUID = 1L;

    /**
     * 主鍵
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    /**
     * 名稱
     */
    private String name;

    /**
     * 父級ID
     */
    private Integer parentId;

    /**
     * 排序
     */
    private Integer sort;

    /**
     * 類型
     */
    private Integer type;

    /**
     * 創(chuàng)建人
     */
    private Integer createBy;

    /**
     * 創(chuàng)建時間
     */
    private LocalDateTime createDate;

    public Integer getId() {
        return id;
    }

    public SysDict setId(Integer id) {
        this.id = id;
        return this;
    }
    public String getName() {
        return name;
    }

    public SysDict setName(String name) {
        this.name = name;
        return this;
    }
    public Integer getParentId() {
        return parentId;
    }

    public SysDict setParentId(Integer parentId) {
        this.parentId = parentId;
        return this;
    }
    public Integer getSort() {
        return sort;
    }

    public SysDict setSort(Integer sort) {
        this.sort = sort;
        return this;
    }
    public Integer getType() {
        return type;
    }

    public SysDict setType(Integer type) {
        this.type = type;
        return this;
    }
    public Integer getCreateBy() {
        return createBy;
    }

    public SysDict setCreateBy(Integer createBy) {
        this.createBy = createBy;
        return this;
    }
    public LocalDateTime getCreateDate() {
        return createDate;
    }

    public SysDict setCreateDate(LocalDateTime createDate) {
        this.createDate = createDate;
        return this;
    }

    @Override
    protected Serializable pkVal() {
        return this.id;
    }

    @Override
    public String toString() {
        return "SysDict{" +
            "id=" + id +
            ", name=" + name +
            ", parentId=" + parentId +
            ", sort=" + sort +
            ", type=" + type +
            ", createBy=" + createBy +
            ", createDate=" + createDate +
        "}";
    }
}
實體如圖所示：

⑥mapper接口如下：

package com.hytc.mall.hytcmall.mapper;

import com.hytc.mall.hytcmall.entity.SysDict;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

/**
 * <p>
 * 數(shù)據(jù)字典 Mapper 接口
 * </p>
 *
 * @author baiYP
 * @since 2020-09-24
 */
public interface SysDictMapper extends BaseMapper<SysDict> {

}
mapper接口如圖所示：

⑦mapper.xml如下

<?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="com.hytc.mall.hytcmall.mapper.SysDictMapper">

    <!-- 通用查詢映射結(jié)果 -->
    <resultMap id="BaseResultMap" type="com.hytc.mall.hytcmall.entity.SysDict">
        <id column="id" property="id" />
        <result column="name" property="name" />
        <result column="parent_id" property="parentId" />
        <result column="sort" property="sort" />
        <result column="type" property="type" />
        <result column="create_by" property="createBy" />
        <result column="create_date" property="createDate" />
    </resultMap>

    <!-- 通用查詢結(jié)果列 -->
    <sql id="Base_Column_List">
        id, name, parent_id, sort, type, create_by, create_date
    </sql>

</mapper>
mapper.xml如圖所示：
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容