Mybatis-Plus-AutoGenerator 最詳細使用方法

更新時間：2020年03月25日 14:13:03 作者：sky豫

這篇文章主要介紹了Mybatis-Plus-AutoGenerator 最詳細使用方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

AutoGenerator 是 MyBatis-Plus 的代碼生成器，通過 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼，極大的提升了開發(fā)效率?？梢酝ㄟ^模版等一系列的方式來生成代碼，⚠️這個比Mybatis-Generator的更加強大，純java代碼。。官方地址：https://mp.baomidou.com/guide/generator.html

package com.cikers.ps;
 
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;
 
public class MysqlGenerator {
	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.isNotEmpty(ipt)) {
				return ipt;
			}
		}
		throw new MybatisPlusException("請輸入正確的" + tip + "！");
	}
	
	public static void main(String[] args) {
		// 代碼生成器
		AutoGenerator mpg = new AutoGenerator();
		
		// 全局配置
		GlobalConfig gc = new GlobalConfig();
		String projectPath = "/Users/syk/Documents/*/*/";
		gc.setOutputDir(projectPath + "/src/main/java");
		gc.setAuthor("syk");
		gc.setOpen(false);
		gc.setBaseResultMap(true);
		gc.setBaseColumnList(true);
		//gc.setControllerName("SSSSScontroller");
		// 是否覆蓋已有文件
		gc.setFileOverride(false);
		mpg.setGlobalConfig(gc);
		
		// 數(shù)據(jù)源配置
		DataSourceConfig dsc = new DataSourceConfig();
		dsc.setUrl("jdbc:mysql://******/newstack_db?useUnicode=true&characterEncoding=UTF-8");
		// dsc.setSchemaName("public");
		dsc.setDriverName("com.mysql.jdbc.Driver");
		dsc.setUsername("root");
		dsc.setPassword("password");
		mpg.setDataSource(dsc);
		
		// 包配置
		PackageConfig pc = new PackageConfig();
		//pc.setModuleName(scanner("模塊名"));
		pc.setParent(null);
    // 這個地址是生成的配置文件的包路徑
		pc.setEntity("com.cikers.ps.model.entity");
		
		//pc.setController("com.cikers.ps.controller");
		pc.setMapper("com.cikers.ps.mapper");
		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<>();
		// 自定義配置會被優(yōu)先輸出
		focList.add(new FileOutConfig(templatePath) {
			@Override
			public String outputFile(TableInfo tableInfo) {
				// 自定義輸出文件名
				return projectPath + "/src/main/resources/mapper/entity"
						+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
			}
		});
		
		cfg.setFileOutConfigList(focList);
		mpg.setCfg(cfg);
		
		// 配置模板
		TemplateConfig templateConfig = new TemplateConfig();
		
//		 //配置自定義輸出模板
     // 不需要其他的類型時，直接設(shè)置為null就不會成對應的模版了
		 //templateConfig.setEntity("...");
		 templateConfig.setService(null);
		 templateConfig.setController(null);
		 templateConfig.setServiceImpl(null);
// 自定義模板配置，可以 copy 源碼 mybatis-plus/src/main/resources/templates 下面內(nèi)容修改，
    // 放置自己項目的 src/main/resources/templates 目錄下, 默認名稱一下可以不配置，也 
    // 可以自定義模板名稱 只要放到目錄下，名字不變 就會采用這個模版 下面這句有沒有無所謂
     // 模版去github上看地址：
    /**https://github.com/baomidou/mybatis-plus/tree/3.0/mybatis-plus-generator/src/main/resources/templates*/
		 //templateConfig.setEntity("/templates/entity.java");
		templateConfig.setXml(null);
		mpg.setTemplate(templateConfig);
		
		// 策略配置
		StrategyConfig strategy = new StrategyConfig();
		strategy.setNaming(NamingStrategy.underline_to_camel);
		strategy.setColumnNaming(NamingStrategy.underline_to_camel);
		strategy.setSuperEntityClass("com.cikers.ps.model.BaseEntity");
		strategy.setSuperMapperClass("com.cikers.ps.util.IMapper");
		strategy.setEntityLombokModel(false);
		//strategy.setRestControllerStyle(false);
		//strategy.setSuperControllerClass("com.cikers.ps.controller.MysqlController");
		strategy.setInclude(scanner("表名"));
		// 設(shè)置繼承的父類字段
		strategy.setSuperEntityColumns("id","modifiedBy","modifiedOn","createdBy","createdOn");
		//strategy.setControllerMappingHyphenStyle(true);
		//strategy.setTablePrefix(pc.getModuleName() + "_");
		mpg.setStrategy(strategy);
		mpg.setTemplateEngine(new FreemarkerTemplateEngine());
		mpg.execute();
	}	
}

其中需要的maven依賴

<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.0-RELEASE</version>
		</dependency>
		<!-- mp自動代碼生成-->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-generator</artifactId>
			<version>3.0.7.1</version>
		</dependency>
		<!-- velocity 模板引擎, 默認 -->
		<dependency>
			<groupId>org.apache.velocity</groupId>
			<artifactId>velocity-engine-core</artifactId>
			<version>2.0</version>
		</dependency>
 
		<!-- freemarker 模板引擎 -->
		<dependency>
			<groupId>org.freemarker</groupId>
			<artifactId>freemarker</artifactId>
			<version>2.3.23</version>
		</dependency>
 
 
		<!-- beetl 模板引擎 -->
		<dependency>
			<groupId>com.ibeetl</groupId>
			<artifactId>beetl</artifactId>
			<version>2.2.5</version>
		</dependency>