com.github.xiaoymin.maven.MybatisPlusGenMavenMojo Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2017-2023 TemplateFactory([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.github.xiaoymin.maven;

import cn.hutool.system.SystemUtil;
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 com.github.xiaoymin.plus.MyBatisPlusConfiguration;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

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

/**
 * @author [email protected]
 * 2021/05/28 14:03
 * @since:template-factory 1.0
 */
@Mojo(name = "template-mybatis-plus", defaultPhase = LifecyclePhase.NONE, requiresDependencyResolution = ResolutionScope.NONE)
public class MybatisPlusGenMavenMojo extends AbstractMojo {
    
    Logger logger = LoggerFactory.getLogger(MybatisPlusGenMavenMojo.class);
    
    /**
     * Maven Project.
     *
     */
    @Parameter(property = "project", required = true, readonly = true)
    private MavenProject project;
    
    @Parameter(property = "myBatisPlusConfiguration", required = true)
    private MyBatisPlusConfiguration myBatisPlusConfiguration;
    
    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        logger.info("mybatis-plus generator start working...");
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
        
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        // String projectPath = System.getProperty("user.dir");
        String projectPath = project.getBasedir().getAbsolutePath();
        logger.info("projectPath:{}", projectPath);
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor(myBatisPlusConfiguration.getAuthor());
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);
        
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(myBatisPlusConfiguration.getDataSourceConfig().getUrl());
        // dsc.setSchemaName("public");
        dsc.setDriverName(myBatisPlusConfiguration.getDataSourceConfig().getDriverName());
        String envUser = SystemUtil.get(myBatisPlusConfiguration.getDataSourceConfig().getUsername(), myBatisPlusConfiguration.getDataSourceConfig().getUsername());
        logger.info("envUser:{}", envUser);
        dsc.setUsername(envUser);
        String envPwd = SystemUtil.get(myBatisPlusConfiguration.getDataSourceConfig().getPassword(), myBatisPlusConfiguration.getDataSourceConfig().getPassword());
        dsc.setPassword(envPwd);
        mpg.setDataSource(dsc);
        
        // 包配置
        final PackageConfig pc = new PackageConfig();
        pc.setModuleName(myBatisPlusConfiguration.getModuleName());
        pc.setParent(myBatisPlusConfiguration.getParentPackage());
        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 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.disable(TemplateType.CONTROLLER, TemplateType.SERVICE);
        
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);
        
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setSkipView(true);
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(false);
        
        strategy.setRestControllerStyle(false);
        // 公共父类
        // strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        // strategy.setSuperEntityColumns("id");
        strategy.setInclude(myBatisPlusConfiguration.getTables().toArray(new String[]{}));
        strategy.setControllerMappingHyphenStyle(true);
        // 不指定前缀
        // strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
        logger.info("mybatis-plus generator finished...");
    }
}