MyBatis-Plus代码生成器

1,340 阅读2分钟

前言:本文主要讲解如何使用MyBatis-Plus的代码生成器,能根据数据库表自动生成相对于的实体类、映射层、服务层、控制器层,使用代码生成器能大大提高工作效率,减少重复工作量。本文与SpringBoot配合使用。

简介

官网:MyBatis-Plus代码生成器文档

AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

添加依赖

 <properties>
     <mybatis-plus.version>3.4.3</mybatis-plus.version>
     <mybatis-plus.generator.vision>3.4.1</mybatis-plus.generator.vision>
     <velocity.version>2.3</velocity.version>
 </properties>
 ​
 <!--Mybatis-Plus-->
 <dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-boot-starter</artifactId>
     <version>${mybatis-plus.version}</version>
 </dependency>
 <!--Mybatis-Plus代码生成器-->
 <dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-generator</artifactId>
     <version>${mybatis-plus.generator.vision}</version>
 </dependency>
 <!--velocity 模板引擎 MP代码生成器需要-->
 <dependency>
     <groupId>org.apache.velocity</groupId>
     <artifactId>velocity-engine-core</artifactId>
     <version>${velocity.version}</version>
 </dependency>

配置文件

application.yml

 spring:
   datasource:
     url: jdbc:mysql://localhost:3306/数据库?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
     driver-class-name: com.mysql.jdbc.Driver
     username: root
     password: 密码

代码

以下代码仅仅需要做简单修改即可使用。

CodeGenerator.java

 public class CodeGenerator {
     public void genCode() {
         // 1.创建代码生成器
         AutoGenerator mpg = new AutoGenerator();
 ​
         // 2.全局配置
         GlobalConfig gc = new GlobalConfig();
         String projectPath = System.getProperty("user.dir"); // 获取当前项目路径
         gc.setOutputDir(projectPath + "/src/main/java");    // 生成文件输出位置
         gc.setAuthor("jobob");      // 设置作者名称
         gc.setOpen(false);          // 生成后是否自动打开资源管理器
         gc.setServiceName("%sService");// 去掉Service接口首字母I,默认IxxxService
         gc.setIdType(IdType.AUTO);  // 主键策略
         // gc.setSwagger2(true);    // 实体属性 Swagger2 注解
         mpg.setGlobalConfig(gc);
 ​
         // 3.数据源配置
         DataSourceConfig dsc = new DataSourceConfig();
         dsc.setUrl("jdbc:mysql://localhost:3306/数据库名?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai");
         dsc.setDriverName("com.mysql.jdbc.Driver");
         dsc.setUsername("root");
         dsc.setPassword("密码");
         dsc.setDbType(DbType.MYSQL);    // 设置数据库类型
         mpg.setDataSource(dsc);
 ​
         // 4.包配置
         PackageConfig pc = new PackageConfig();
         pc.setParent("com.baomidou.ant");   // 设置父包名
         pc.setEntity("pojo.entity");     // 实体类包名,与数据库表结构一一对应
         pc.setMapper("mapper");         // mapper包名
         pc.setXml("mapper.xml");        // mapper xml包名
         pc.setService("service");       // Service包名
         pc.setServiceImpl("service.impl");  // Service Impl包名
         pc.setController("controller");     // Controller包名
         mpg.setPackageInfo(pc);
 ​
         // 5.策略配置
         StrategyConfig strategy = new StrategyConfig();
         strategy.setInclude("user");    // 需要生成的表名
         strategy.setNaming(NamingStrategy.underline_to_camel);// 设置类名,下划线变驼峰
         strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 设置列名,下划线变驼峰
         strategy.setEntityLombokModel(true);                // lombok
         strategy.setLogicDeleteFieldName("is_deleted");     // 设置逻辑删除字段名并加上逻辑删除注解
         strategy.setEntityBooleanColumnRemoveIsPrefix(true); // 去掉Boolean类型字段的is_前缀
         strategy.setRestControllerStyle(true);      // 生成 restful api风格控制器 @RestController
         // strategy.setTablePrefix("m_");       // 表前缀
         // strategy.setControllerMappingHyphenStyle(true);//mapping中驼峰转连字符
         mpg.setStrategy(strategy);
 ​
         // 6.执行
         mpg.execute();
     }
 }

参考资料来源:

【狂神说Java】MyBatisPlus最新完整教程通俗易懂