使用mybatis-plus-generate插件生成mybatis控制器、实体、服务、xml文件

导语:叶子在一个SpringBoot中使用了mybatis-plus,如果手工来写mybatis的各种控制器、实体、服务、xml文件,工作量非常大,那么mybatis-plus提供了一款mybatis-plus-generate插件可以自动生成,下面是使用方法。

一、修改gradle.build文件的参数

在gradle.build文件中增加mybatis-plus依赖和velocity模板依赖。

dependencies {
  .......
	
	//mybatis
	implementation('com.baomidou:mybatis-plus-boot-starter:2.2.0')

	//mybatis-plus 模板
	implementation('org.apache.velocity:velocity-engine-core:2.0')
	.......

}

二、在你的项目中创建一个模板生成的类

插件默认使用volecity生成,可以自己设置模板引擎,模板文件可以从代码包的templates目录拷贝修改。

mybatis-plus代码下载地址,选择2.x版本,叶子这个项目使用的2.x版本,官方的github下载地址。

https://github.com/baomidou/mybatis-plus/tree/2.x

下载后解压,将mybatis-plus-2.x\mybatis-plus-generate\src\main\resources\templates中的文件,复制到自己项目的\src\main\resources\templates。

然后在自己的项目中创建一个模板生成的类MpGenerator.java,代码如下。

package com.xxxx.hx.mpgenerator;

import java.util.HashMap;
import java.util.Map;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.converts.OracleTypeConvert;
import com.baomidou.mybatisplus.generator.config.rules.DbType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

/**
 * <p>
 * 代码生成器演示
 * </p>
 */
public class MpGenerator {

	/**
	 * <p>
	 * ORACLE 生成演示
	 * </p>
	 */
	public static void main(String[] args) {
		AutoGenerator mpg = new AutoGenerator();
		// 选择 freemarker 引擎,默认 Veloctiy
		// mpg.setTemplateEngine(new FreemarkerTemplateEngine());

		// 全局配置
		GlobalConfig gc = new GlobalConfig();
		gc.setOutputDir("F:\\");
		gc.setFileOverride(true);
		gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false
		gc.setEnableCache(false);// XML 二级缓存
		gc.setBaseResultMap(true);// XML ResultMap
		gc.setBaseColumnList(false);// XML columList
		// .setKotlin(true) 是否生成 kotlin 代码
		gc.setAuthor("wordpressleaf"); // 设置作者

		// 自定义文件命名,注意 %s 会自动填充表实体属性!
		// gc.setMapperName("%sDao");
		// gc.setXmlName("%sDao");
		// gc.setServiceName("MP%sService");
		// gc.setServiceImplName("%sServiceDiy");
		// gc.setControllerName("%sAction");
		mpg.setGlobalConfig(gc);

		// 数据源配置
		DataSourceConfig dsc = new DataSourceConfig();
		dsc.setDbType(DbType.ORACLE);
		dsc.setTypeConvert(new OracleTypeConvert());
		dsc.setDriverName("oracle.jdbc.OracleDriver"); // 驱动名称
		dsc.setUsername("yonghu"); // 数据库用户名
		dsc.setPassword("mima"); // 数据库密码
		dsc.setUrl("jdbc:oracle:thin:@127.0.0.1:1521:yezi"); // 数据库链接串
		mpg.setDataSource(dsc);

		// 策略配置
		StrategyConfig strategy = new StrategyConfig();
		// strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
		// strategy.setTablePrefix(new String[] { "tlog_", "tsys_" });//
		// 此处可以修改为您的表前缀
		strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
		// strategy.setInclude(tables); // 需要生成的表
		strategy.setInclude(new String[] { "hx_order" }); // 需要生成的表
		// strategy.setExclude(new String[]{"test"}); // 排除生成的表
		// 自定义实体父类
		// 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 实现类父类
		// strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
		// 自定义 controller 父类
		// strategy.setSuperControllerClass("com.baomidou.demo.TestController");
		// 【实体】是否生成字段常量(默认 false)
		// public static final String ID = "test_id";
		// strategy.setEntityColumnConstant(true);
		// 【实体】是否为构建者模型(默认 false)
		// public User setName(String name) {this.name = name; return this;}
		// strategy.setEntityBuilderModel(true);
		mpg.setStrategy(strategy);

		// 包配置
		PackageConfig pc = new PackageConfig();
		pc.setParent("com.xxxx");
		pc.setModuleName("hx");
		mpg.setPackageInfo(pc);

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

		// 关闭默认 xml 生成,调整生成 至 根目录
		TemplateConfig tc = new TemplateConfig();
		tc.setController("/templates/controller.java.vm");
		tc.setEntity("/templates/entity.java.vm");
		tc.setMapper("/templates/mapper.java.vm");
		tc.setXml("/templates/mapper.xml.vm");
		tc.setService("/templates/service.java.vm");
		tc.setServiceImpl("/templates/serviceImpl.java.vm");

		mpg.setTemplate(tc);

		// 自定义模板配置,可以 copy 源码 /mybatis-plus-generate/src/main/resources/templates 下面内容修改,
		// 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置,也可以自定义模板名称
		// TemplateConfig tc = new TemplateConfig();
		// tc.setController("...");
		// tc.setEntity("...");
		// tc.setMapper("...");
		// tc.setXml("...");
		// tc.setService("...");
		// tc.setServiceImpl("...");
		// 如上任何一个模块如果设置 空 OR Null 将不生成该模块。
		// mpg.setTemplate(tc);

		// 执行生成
		mpg.execute();

	}

}

有几个需要修改的地方,输出的目录、数据库的配置、需要生成的表、包配置,这些按照你的项目实际来修改。

gc.setOutputDir("F:\\");

gc.setAuthor("wordpressleaf"); // 设置作者

dsc.setDbType(DbType.ORACLE);
dsc.setTypeConvert(new OracleTypeConvert());
dsc.setDriverName("oracle.jdbc.OracleDriver"); // 驱动名称
dsc.setUsername("yonghu"); // 数据库用户名
dsc.setPassword("mima"); // 数据库密码
dsc.setUrl("jdbc:oracle:thin:@127.0.0.1:1521:yezi"); // 数据库链接串

strategy.setInclude(new String[] { "hx_order" }); // 需要生成的表
		
pc.setParent("com.xxxx");
pc.setModuleName("hx");	

修改完成后,直接运行MpGenerator.main{},执行完成后,会弹出资源管理器,你能看到在F盘的根目录下生成com.xxxx.hx的包,里面包含了各种文件。

然后,你再将这些文件复制到自己的项目中。

或者在设置输出文件路径的时候,直接设置为自己的项目路径,那么输出的文件就直接在你的项目中了。

注意,叶子连接的数据库其实是ORACLE。

发表评论

电子邮件地址不会被公开。 必填项已用*标注