Java MyBatis 代码生成器怎么自定义模板与输出路径

冬婷酱_8949

冬婷酱_8949

2026-09-04

691人浏览

原创

mybatis-plus 3.5.15模板配置已整合至strategyconfig,需用/javatemplate("/templates/entity.java")指定classpath相对路径,输出目录由globalconfig.outputdir统一控制;mbg则需在xml中分项配置targetproject及templatefile路径。

java mybatis 代码生成器怎么自定义模板与输出路径

MyBatis 相关代码生成器(包括 MyBatis-Plus 3.5+ 和 MyBatis Generator)支持模板和输出路径的灵活自定义,关键在于区分工具类型、模板存放位置、路径写法及配置入口。

MyBatis-Plus 3.5.15 的模板与路径配置

从 3.5.6 起,模板配置已整合进 StrategyConfig,不再用独立的 TemplateConfig。

  • 模板路径必须以 / 开头,且相对于 classpath(即 src/main/resources)。例如:.javaTemplate("/templates/entity.java") 表示模板文件放在 src/main/resources/templates/entity.java
  • 推荐使用 FastAutoGenerator 链式配置,模板设置直接在对应 builder 中指定:
    strategyConfig(builder -> {
          builder.entityBuilder()
            .javaTemplate("/templates/entity.java")
            .enableLombok();
          builder.controllerBuilder()
            .javaTemplate("/templates/controller.java")
            .formatControllerFileName("%sController");
        })
  • 输出路径统一由 GlobalConfig 控制:.outputDir("src/main/java"),所有生成文件(entity/mapper/service 等)都基于此目录按包结构展开

MyBatis Generator(MBG)的模板与路径配置

MBG 使用 Freemarker 模板,默认模板内置在 jar 包中;自定义需显式指定路径并确保资源可加载。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 模板文件建议放在 src/main/resources/generator/templates/ 下,如 model.ftl
  • 在 XML 配置中通过 <property name="templateFile" value="src/main/resources/generator/templates/model.ftl"></property> 引入(注意:该 property 需在 <context></context> 内,且部分版本需配合插件依赖如 mybatis-generator-plugin
  • 输出路径分项配置:
    • <javamodelgenerator targetpackage="com.example.model" targetproject="src/main/java"></javamodelgenerator>
    • <sqlmapgenerator targetpackage="mapper" targetproject="src/main/resources"></sqlmapgenerator>
    • <javaclientgenerator targetpackage="com.example.mapper" targetproject="src/main/java"></javaclientgenerator>

模板文件注意事项

无论 MP 还是 MBG,自定义模板本质是 Freemarker 文件(.java 或 .ftl),需注意:

  • 变量命名要与生成器上下文一致,如 MP 常用 ${table.name}${field.name};MBG 常用
  • Java 模板中若引用 Lombok 注解,需确保项目已引入 lombok 依赖,且 IDE 支持注解处理
  • 首次使用自定义模板时,建议先复制官方默认模板(如 MP 的源码中 templates 目录或 MBG 的 github 示例)再修改,避免语法错误导致生成失败

常见路径问题排查

生成失败常因路径配置不准确,重点检查:

  • MP:确认 /templates/entity.java 是完整 classpath 路径,不是文件系统绝对路径;IDE 中该文件需在编译后出现在 target/classes/templates/
  • MBG:XML 中 targetProject 必须是 Maven 项目中的有效目录名(如 src/main/java),不能写成 ./src/main/java 或绝对路径
  • 两者都需确保生成器运行时工作目录为项目根目录,否则相对路径易失效

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

8697

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

5922

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5312

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

964

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

808

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1136

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2309

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19651

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1055

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习