oracle 自定义模板,Mybatis-plus自定义模板生成

所有文章已迁移至csdn，csdn个人主页https://blog.csdn.net/chaitoudaren

下方代码引用自mybatis-plus的代码生成模块，点击运行即可生成代码。本篇第一部分将介绍代码生成的使用，第二部分介绍如何自定义自己的模板。

一、代码模板使用

生成后的效果如下：

代码生成.png

1.引入maven，共提供3类模板，本次只以freemarker 为例

org.freemarker

freemarker

2.3.28

2.引入代码生成模块

全局配置：主要是配置文件命名方式

数据源配置：数据库的相关信息，用户密码连接驱动等

包配置：包名

模板引擎：本次使用freemarker，无需修改

自定义模板：下方详解

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;

import com.baomidou.mybatisplus.core.toolkit.StringPool;

import com.baomidou.mybatisplus.core.toolkit.StringUtils;

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;

import java.util.Scanner;

/**

* mybatis代码生成器

*/

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中

public class CodeGenerator {

/**

*

* 读取控制台内容

*

*/

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 = System.getProperty("user.dir");

gc.setOutputDir(projectPath + "/src/main/java");

gc.setServiceName("%sService");//service 命名方式

gc.setServiceImplName("%sServiceImpl");//service impl 命名方式

// 自定义文件命名，注意 %s 会自动填充表实体属性！

gc.setMapperName("%sMapper");

gc.setXmlName("%sMapper");

gc.setAuthor("cmx");

gc.setOpen(false);

// gc.setSwagger2(true); 实体属性 Swagger2 注解

mpg.setGlobalConfig(gc);

// 数据源配置

DataSourceConfig dsc = new DataSourceConfig();

dsc.setUrl("jdbc:oracle:thin:@xxx:xxx");

// dsc.setSchemaName("public");

dsc.setDriverName("oracle.jdbc.OracleDriver");

dsc.setUsername("xxx");dsc.setPassword("xxx");

mpg.setDataSource(dsc);

// 包配置

PackageConfig pc = new PackageConfig();

pc.setModuleName(scanner("模块名"));

pc.setParent("com.cmx.tcn");

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("调用默认方法创建的目录");

return false;

}

});

*/

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("com.baomidou.ant.common.BaseEntity");

strategy.setEntityLombokModel(true);

strategy.setRestControllerStyle(true);

// strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");

strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));

// strategy.setSuperEntityColumns("id");

strategy.setControllerMappingHyphenStyle(true);

strategy.setTablePrefix(pc.getModuleName() + "_");

mpg.setStrategy(strategy);

mpg.setTemplateEngine(new FreemarkerTemplateEngine());

mpg.execute();

}

}

直接运行即可生成对应表的相关代码

二、自定义模板

生成的PO模板如下，由于作者使用的是oracle，主键策略为序列，故需要修改原本模板，使其在类上方自动生成@KeySequence("SEQ_ST_USER")

@Data

@EqualsAndHashCode(callSuper = false)

@Accessors(chain = true)

@TableName("ST_USER")

// 缺少@KeySequence("SEQ_ST_USER")的主键策略

public class StUser implements Serializable {

private static final long serialVersionUID = 1L;

/**

* 主键

*/

@TableId("PKID")

private Long pkid;

1.获取原模板，在原模板基础上进行修改

查找模板文件.gif

2.本次要修改PO，故拷贝一份entity.java.ftl文件至/main/resources/templates文件下方，重命名为entity2.java.ftl(ftl文件为freemarker模板)，并在类上方加入相关代码

image.png

3.在模板模块，也就是CodeGenerator中，打开自定义模板，并设置读取的路径

image.png

4.点击运行即可生成自定义模板