返回
从入门到精通:MybatisPlus 代码自动生成器教程
后端
2023-10-04 21:28:25
了解 MybatisPlus 自动代码生成器:新手入门指南
MybatisPlus 是 Java 开发中广泛使用的对象关系映射(ORM)框架。它提供了一个代码生成器模块,使开发人员能够通过简单的代码生成器自动生成持久层代码。在本教程中,我们将逐步了解 MybatisPlus 代码生成器的使用,并探索它的高级功能。
从简单代码开始
首先,让我们从一个简单的代码示例开始,该示例演示了如何生成基本的 CRUD(创建、读取、更新、删除)操作的代码:
// 导入必要的类
import com.baomidou.mybatisplus.annotation.IdType;
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.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
// 主类
public class CodeGenerator {
public static void main(String[] args) {
// 创建 AutoGenerator 对象
AutoGenerator mpg = new AutoGenerator();
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/test");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.example");
mpg.setPackageInfo(pc);
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("MybatisPlus");
gc.setOpen(false);
gc.setDateType(DateType.ONLY_DATE);
mpg.setGlobalConfig(gc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setInclude("user");
mpg.setStrategy(strategy);
// 模板配置
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setEntity("/templates/entity.java");
templateConfig.setMapper("/templates/mapper.java");
templateConfig.setXml("/templates/mapper.xml");
templateConfig.setService("/templates/service.java");
templateConfig.setServiceImpl("/templates/serviceImpl.java");
templateConfig.setController("/templates/controller.java");
mpg.setTemplate(templateConfig);
// 执行生成
mpg.execute();
}
}
通过运行此代码,MybatisPlus 将根据您指定的数据库表(在本例中为“user”)自动生成 CRUD 操作的 Java 代码。生成的文件将包含持久层实体、映射器接口、映射器 XML、服务接口和服务实现。
高级自定义选项
除了基本用法之外,MybatisPlus 代码生成器还提供高级选项,允许您根据自己的需求自定义生成代码:
- 自定义模板: 您可以自定义代码模板,以生成符合您的特定项目风格和约定的代码。
- 配置填充: 填充配置允许您在生成代码时插入其他文件或文本。
- 过滤表: 您可以过滤要生成的表,以仅生成与特定标准匹配的表。
- 配置子生成器: 子生成器用于生成特定类型的代码,例如 Mapper XML 文件或 Service 实现。
实际应用
MybatisPlus 代码生成器在以下场景中特别有用:
- 快速生成 CRUD 操作代码,节省开发时间。
- 维护大型代码库,保持代码一致性和准确性。
- 生成复杂的代码,例如具有复杂继承或关联关系的代码。
结论
MybatisPlus 代码生成器是一个功能强大的工具,使 Java 开发人员能够通过简单的代码自动生成持久层代码。通过理解其核心概念和利用高级功能,您可以创建自己的代码模板,并根据自己的项目需求生成高质量的代码。