【MyBatisPlus】MyBatisPlus 代码生成器 (二)

1. 概述

1.1 官网

• 代码生成器教程：https://mybatis.plus/guide/generator.html

1.2 特点

• AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率

2. CodeGenerator 源码

• 指定要生成的表(每次执行前都要再次确认)
• 配置数据源
• 设置生成文件存放的路径
• 设置父包名，会放到controller丶service丶mapper包的前面
• 设置作者,不可为null，否则会报错
• 设置是否添加@RestController注解
• 其他属性大部分有默认值，如非必要可以不用管

package com.xxx.generator;


import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.ArrayList;
import java.util.List;

public class CodeGenerator {

    //要生成文件对应的表，多个表用逗号隔开
    // 星号*开头表示生成所有数据库中所有表
    // 减号-开头表示要排除的表
    // 不以任何符号开头表示要包含的表
    private static  String tables ="*";

    /* 数据源配置 */
    private  static String db_url="jdbc:mysql://localhost:3306/bookshop?useUnicode=true&useSSL=false&characterEncoding=utf8";
    private  static String db_driver ="com.mysql.jdbc.Driver";
    private  static  String  db_username="root";
    private  static  String db_password="root";

    //代码生成文件存放的位置
    private static  String outputDir=System.getProperty("user.dir")+"/src/main/test/code";

    // 表前缀
    private static String tablePrefix="";

    //作者，@author
    private  static  String author="duson";

    //父包名
    private static  String parentPackage="com";
    
    //模块名
    // 1.会在parentPackage后面加上模块名
    // 2.控制器类上的@RequestMapping会加上模块名前缀
    private static String moduleName=null;

    //是否添加@RestController注解
    private static boolean isAddRestController=true;

    //是否使用Lombok
    private static boolean isUseLombok=true;

    //是否使用Swagger
    private  static boolean isUseSwagger=true;

    //是否使用AR模式
    private  static boolean isUseAR=false;
    
    // 主键生成策略
    private  static IdType idType=IdType.AUTO;

    // 数据源配置
    private  static DataSourceConfig dataSourceConfig(){
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(db_url);
        dsc.setDriverName(db_driver);
        dsc.setUsername(db_username);
        dsc.setPassword(db_password);
        return dsc;
    }

    //全局配置
    private  static GlobalConfig globalConfig(){
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig
                .setActiveRecord(isUseAR)        // 是否开启AR模式
                .setAuthor(author)              //生成的文件头@author
                .setOutputDir(outputDir)        //代码文件生成路径
                .setFileOverride(true)          //文件是否覆盖
                .setIdType(idType)              // 主键策略
                .setServiceName("%sService")    //是否去掉Service接口命名开头的I

                .setSwagger2(isUseSwagger)//实体属性 Swagger2 注解
//                .setOpen(false);//生成后是否自动打开文件夹
                .setBaseResultMap(true) // 是否生成基本的sql中的ResultMap
                .setBaseColumnList(true) // 是否生成基本的sql列
        ;
        return globalConfig;
    }

    // 包配置
    private static PackageConfig packageConfig() {
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setParent(parentPackage);     // 总包名
        packageConfig.setModuleName(moduleName);    // 模块名
        packageConfig.setController("controller");  // 控制器包名
        packageConfig.setService("service");        // 业务包名
        packageConfig.setEntity("entity");          // 实体包名
        packageConfig.setMapper("mapper");          // Mapper包名
        packageConfig.setXml("mapper");             // mapper.xml文件
        
        return packageConfig;
    }

    //自定义配置
    private static InjectionConfig injectionConfig() {
        InjectionConfig injectionConfig = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return outputDir+ "/mapper_xml/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录");
                return false;
            }
        });
        */
        injectionConfig.setFileOutConfigList(focList);
        return injectionConfig;
    }


    // 模版配置
    private static TemplateConfig templateConfig() {
        TemplateConfig templateConfig = new TemplateConfig();
        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();
        templateConfig.setXml(null);
        return templateConfig;
    }


    // 策略配置
    private static StrategyConfig strategyConfig() {
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setCapitalMode(true); // 是否大写命名
        // 表前缀
        //strategyConfig.setTablePrefix("");
        strategyConfig.setNaming(NamingStrategy.underline_to_camel); // 从数据库表到文件的命名策略

        if(tables.startsWith("*")) {
            // 全部表
            strategyConfig.setExclude();
        }else  if(tables.startsWith("-")){
            //需要排除的表名
            strategyConfig.setExclude(tables.substring(1).split(","));
        }else{
            //需要包含的表名
            strategyConfig.setInclude(tables.split(","));
        }




        //数据库表字段映射到实体的命名策略,原样输出no_change,下划线转驼峰命underline_to_camel;
        strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
        //自定义继承的Entity类全称，带包名
        //strategyConfig.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
        //是否为lombok模型（默认 false）
        strategyConfig.setEntityLombokModel(isUseLombok);
        //生成 @RestController 控制器注解
        strategyConfig.setRestControllerStyle(isAddRestController);
        //实体是否生成 serialVersionUID
        strategyConfig.setEntitySerialVersionUID(true);
        // 自定义继承的Controller类全称，带包名
        //strategyConfig.setSuperControllerClass("com.baomidou.ant.common.BaseController");
        //自定义基础的Entity类，公共字段
        //strategyConfig.setSuperEntityColumns("id");
        //驼峰转连字符
        //strategyConfig.setControllerMappingHyphenStyle(true);
        //表前缀
        strategyConfig.setTablePrefix(tablePrefix);
        return strategyConfig;
    }



    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        mpg.setGlobalConfig(globalConfig());

        // 数据源配置
        mpg.setDataSource(dataSourceConfig());

        // 包配置
        mpg.setPackageInfo(packageConfig());

        // 自定义配置
        mpg.setCfg(injectionConfig());

        // 模板配置
        mpg.setTemplate(templateConfig());

        // 策略配置
        mpg.setStrategy(strategyConfig());

        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

3. 生成的各层代码

3.1 生成的entity代码

package com.entity;

import java.math.BigDecimal;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import java.time.LocalDateTime;
import java.io.Serializable;

public class Book implements Serializable {
    private static final long serialVersionUID = 1L;
    @TableId(value = "book_id", type = IdType.AUTO)
    private Integer bookId;
    private String bookName;
    private LocalDateTime bookDate;
    private BigDecimal bookPrice;
    private String bookCover;
    private Integer categoryId;
    public Integer getBookId() {
        return bookId;
    }
    public void setBookId(Integer bookId) {
        this.bookId = bookId;
    }
    public String getBookName() {
        return bookName;
    }
    public void setBookName(String bookName) {
        this.bookName = bookName;
    }
    public LocalDateTime getBookDate() {
        return bookDate;
    }
    public void setBookDate(LocalDateTime bookDate) {
        this.bookDate = bookDate;
    }
    public BigDecimal getBookPrice() {
        return bookPrice;
    }
    public void setBookPrice(BigDecimal bookPrice) {
        this.bookPrice = bookPrice;
    }
    public String getBookCover() {
        return bookCover;
    }
    public void setBookCover(String bookCover) {
        this.bookCover = bookCover;
    }
    public Integer getCategoryId() {
        return categoryId;
    }
    public void setCategoryId(Integer categoryId) {
        this.categoryId = categoryId;
    }

    @Override
    public String toString() {
        return "Book{" +
            "bookId=" + bookId +
            ", bookName=" + bookName +
            ", bookDate=" + bookDate +
            ", bookPrice=" + bookPrice +
            ", bookCover=" + bookCover +
            ", categoryId=" + categoryId +
        "}";
    }
}

3.2 生成的mapper代码

package com.mapper;

import com.entity.Book;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
public interface BookMapper extends BaseMapper<Book> {

}

3.3 生成的service接口代码

package com.service;
import com.entity.Book;
import com.baomidou.mybatisplus.extension.service.IService;
public interface IBookService extends IService<Book> {

}

3.4 生成的service实现类代码

package com.service.impl;

import com.entity.Book;
import com.mapper.BookMapper;
import com.service.IBookService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

@Service
public class BookServiceImpl extends ServiceImpl<BookMapper, Book> implements IBookService {

}

3.5 生成的Controller代码

package com.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("//book")
public class BookController {

}

3.6 生成的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.mapper.BookMapper">

    <!-- 通用查询映射结果 -->
    <resultMap id="BaseResultMap" type="com.entity.Book">
        <id column="book_id" property="bookId" />
        <result column="book_name" property="bookName" />
        <result column="book_date" property="bookDate" />
        <result column="book_price" property="bookPrice" />
        <result column="book_cover" property="bookCover" />
        <result column="category_id" property="categoryId" />
    </resultMap>

    <!-- 通用查询结果列 -->
    <sql id="Base_Column_List">
        book_id, book_name, book_date, book_price, book_cover, category_id
    </sql>

</mapper>