0

0

MyBatisPlus代码生成器的配置与使用详细教程

爱谁谁

爱谁谁

发布时间:2025-07-04 09:41:01

|

999人浏览过

|

来源于php中文网

原创

使用mybatisplus代码生成器可大幅提升开发效率。1. 引入相关依赖,包括mybatis-plus-generator、freemarker及数据库驱动;2. 编写配置类设置数据源、全局配置、包名及策略,用于生成实体类、mapper、service和controller;3. 可选自定义模板以满足编码风格需求;4. 注意常见问题如数据库连接、字段映射、注释生成等,确保配置准确以提升代码生成效果。

MyBatisPlus代码生成器的配置与使用详细教程

使用MyBatisPlus代码生成器可以大幅提升开发效率,尤其在项目初期搭建阶段。它能根据数据库表结构自动生成实体类、Mapper接口、Service层、Controller层等基础代码,省去了大量重复劳动。

MyBatisPlus代码生成器的配置与使用详细教程

1. 引入依赖

要使用MyBatisPlus的代码生成器,首先要在项目中引入相关依赖。如果你用的是Maven项目,可以在pom.xml中添加以下内容:

MyBatisPlus代码生成器的配置与使用详细教程

    com.baomidou
    mybatis-plus-generator
    3.5.2


    org.freemarker
    freemarker
    2.3.31

注意:不同版本的MyBatisPlus Generator可能对FreeMarker或其他模板引擎有不同要求,确保版本兼容性。

另外,还需要数据库驱动依赖,比如MySQL:

MyBatisPlus代码生成器的配置与使用详细教程

    mysql
    mysql-connector-java
    8.0.26

2. 编写配置类

接下来是编写一个Java类来配置代码生成器。你可以创建一个main方法运行这个类,也可以集成到Spring Boot项目中作为启动任务。

核心配置如下:

《PHP程序设计》第二版
《PHP程序设计》第二版

本书图文并茂,详细讲解了使用LAMP(PHP)脚本语言开发动态Web程序的方法,如架设WAMP平台,安装与配置开源Moodle平台,PHP程序设计技术,开发用户注册与验证模块,架设LAMP平台。 本书适合计算机及其相关专业本、专科学生作为学习LAMP(PHP)程序设计或动态Web编程的教材使用,也适合对动态Web编程感兴趣的读者自觉使用,对LAMP(PHP)程序设计人员也具有一定的参考价值。

下载
AutoGenerator generator = new AutoGenerator();

// 数据源配置
DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/your_db?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai");
dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
dataSourceConfig.setUsername("root");
dataSourceConfig.setPassword("123456");
generator.setDataSource(dataSourceConfig);

// 全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
globalConfig.setAuthor("your_name");
globalConfig.setOpen(false);
globalConfig.setServiceName("%sService"); // 去掉IService前缀
generator.setGlobalConfig(globalConfig);

// 包名配置
PackageConfig packageConfig = new PackageConfig();
packageConfig.setParent("com.example.demo");
packageConfig.setModuleName("system");
generator.setPackageInfo(packageConfig);

// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel); // 表转类名策略
strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 字段转属性名策略
strategy.setEntityLombokModel(true); // 使用Lombok
strategy.setRestControllerStyle(true); // Controller为RestController风格
strategy.setInclude("user", "role"); // 需要生成的表名
generator.setStrategy(strategy);

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

几点说明:

  • outputDir建议设置成项目的src/main/java目录下,这样生成的代码可以直接使用。
  • setServiceName("%sService")去掉默认的I前缀,更符合多数团队命名习惯。
  • 如果你使用Lombok,记得加上依赖,并且IDE安装了Lombok插件。

3. 自定义模板(可选)

如果默认生成的代码风格或结构不符合你的需求,可以通过自定义模板来调整。

步骤如下:

  • 下载官方默认模板(通常是以.ftl结尾的Freemarker文件)
  • 修改模板内容,比如Controller加注解、字段描述格式化等
  • 在配置中指定模板路径:
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setController("templates/controller.java.ftl");
generator.setTemplate(templateConfig);

这种方式适合希望统一编码风格、添加特定注释或字段处理逻辑的团队。


4. 常见问题与注意事项

  • 数据库连接失败:检查url、用户名、密码是否正确,尤其是MySQL 8以上驱动名称应为com.mysql.cj.jdbc.Driver
  • 生成的类没有字段:可能是表字段名和命名策略不匹配,或者未开启自动映射
  • 字段类型不准确:有些数据库类型如tinyint会被识别为布尔值,需要手动调整或修改模板
  • 字段注释没生成:确保数据库字段设置了comment,并在策略中开启字段注释支持:
strategy.setEntityTableFieldAnnotationEnable(true);

基本上就这些。配置一次后,后续新增表只需要改一下strategy.setInclude(...)即可快速生成代码。虽然看起来步骤不少,但每一步都比较直观,关键在于理解各配置项的作用。

相关专题

更多
java
java

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

841

2023.06.15

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

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

742

2023.07.05

java自学难吗
java自学难吗

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

739

2023.07.31

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

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

397

2023.08.01

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

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

399

2023.08.02

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

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

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16926

2023.08.03

AO3中文版入口地址大全
AO3中文版入口地址大全

本专题整合了AO3中文版入口地址大全,阅读专题下面的的文章了解更多详细内容。

1

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.8万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 805人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号