【Spring Cloud Alibaba】Mybatis Plus 代碼生成器

文章目錄

【Spring Cloud Alibaba】Mybatis Plus 代碼生成器

1、Mybatis Plus Generator
2、搭建微服務代碼生成器
3、項目代碼格式化

微信公衆号

【Spring Cloud Alibaba】Mybatis Plus 代碼生成器

1、Mybatis Plus Generator

在編寫微服務的時候，突然發現每個子產品都需要使用到 Mybatis Plus，我又在每個服務中使用了代碼生成器，複制粘貼太麻煩了，是以我就直接設計了一個獨立的子產品，用于專門處理 Mybatis Plus 的代碼生成，這個子產品沒有使用 Spring Boot 的形式，直接使用的是 Main 方法運作，即可生成配置

Mybatis Plus 官網：https://baomidou.com/

由于我是用了 Swagger 生成接口，是以子子產品需要增加相關的依賴

${swagger-spring-boot-starter.version}

的版本為

<swagger-spring-boot-starter.version>1.9.0.RELEASE</swagger-spring-boot-starter.version>

<dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>${swagger-spring-boot-starter.version}</version>
        </dependency>

2、搭建微服務代碼生成器

建立 spring-cloud-alibaba-mybatis-plus-generator 子產品，主要增加生成器子產品

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus-boot-starter.version}</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!-- mybatis plus 代碼生成器 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatis-plus-generator.version}</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>${freemarker.version}</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </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>

接下來就直接是代碼生成器的 Main 方法了，代碼生成器是可以随便定制模闆的，因為我寫的微服務是最基本的方法就夠了，是以這裡使用預設的形式就可以了

使用方法，修改以下兩點就可以了

修改資料庫名稱、賬号、密碼
修改子產品根路徑

package cn.tellsea.config;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
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 org.apache.commons.lang3.StringUtils;

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

/**
 * @author Tellsea
 * @date 2021/12/31
 */
public class CodeGenerator {

    /**
     * <p>
     * 讀取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("請輸入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("請輸入正确的" + tip + "！");
    }

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

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir") + "/spring-cloud-alibaba-boot-seata-account";
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("Tellsea");
        gc.setOpen(false);
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 資料源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/alibaba-seata-account?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        // pc.setModuleName(scanner("子產品名"));
        pc.setModuleName("");
        pc.setParent("cn.tellsea");
        mpg.setPackageInfo(pc);

        // 自定義配置
        InjectionConfig cfg = 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 projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判斷自定義檔案夾是否需要建立
                checkDir("調用預設方法建立的目錄，自定義目錄用");
                if (fileType == FileType.MAPPER) {
                    // 已經生成 mapper 檔案判斷存在，不想重新生成傳回 false
                    return !new File(filePath).exists();
                }
                // 允許生成模闆檔案
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模闆
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定義輸出模闆
        //指定自定義模闆路徑，注意不要帶上.ftl/.vm, 會根據使用的模闆引擎自動識别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 政策配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // strategy.setSuperEntityClass("你自己的父類實體,沒有就不用設定!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父類
        // strategy.setSuperControllerClass("你自己的父類控制器,沒有就不用設定!");
        // 寫于父類中的公共字段
        // strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多個英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(false);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

執行 Main 方法

【Spring Cloud Alibaba】Mybatis Plus 代碼生成器

生成的效果

如果需要定制方法，直接修改他的定制子產品即可

3、項目代碼格式化

代碼生成之後，由于個人有強迫症，所有代碼必須格式化，按照标準格式書寫空格等，是以這裡使用 IDEA 的代碼批量格式化功能，我的 IDEA 使用的是 Eclipse 的代碼快捷鍵

Ctrl + Alt + L

一鍵格式化

【Spring Cloud Alibaba】Mybatis Plus 代碼生成器

文章目錄

【Spring Cloud Alibaba】Mybatis Plus 代碼生成器

1、Mybatis Plus Generator

2、搭建微服務代碼生成器

3、項目代碼格式化

微信公衆号

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method