MyBatis Plus 代码生成器

1. 导入依赖

   <!--代码生成器-->
   <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-generator</artifactId>
       <version>3.4.1</version>
   </dependency>
   
   <!--velocity模板引擎-->
   <dependency>
       <groupId>org.apache.velocity</groupId>
       <artifactId>velocity-engine-core</artifactId>
       <version>2.3</version>
   </dependency>
   

2. 写一个类 Generator ，名字叫什么都行，写在哪里也都可以，在这个类里面写main方法，运行main方法即可生成代码，内容如下：

   public static void main(String[] args) {
           //获取代码生成器对象
           AutoGenerator autoGenerator = new AutoGenerator();
   
           //设置数据库相关配置
           DataSourceConfig dataSource = new DataSourceConfig();
           dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
           dataSource.setUrl("jdbc:mysql://localhost:3306/db?serverTimezone=UTC");
           dataSource.setUsername("root");
           dataSource.setPassword("1234");
           autoGenerator.setDataSource(dataSource);
   
           //设置全局配置
           GlobalConfig globalConfig = new GlobalConfig();
           globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");//设置代码输出位置，否则默认输出到D://目录下
           globalConfig.setOpen(false);//设置生成完毕后是否打开生成代码的目录，一般选择false，不需要打开目录
           globalConfig.setAuthor("tuuli");//作者名字，会在注释中添加作者名字
           globalConfig.setFileOverride(true);//是否覆盖原始生成的文件，选择true后，生成时若原来已有相同文件会自动覆盖，谨慎操作
           globalConfig.setMapperName("%sDao");//设置数据层接口名，%s为占位符，指代模块名称，默认为"%sMapper"
           globalConfig.setIdType(IdType.AUTO);//设置id生成策略
           autoGenerator.setGlobalConfig(globalConfig);
   
           //设置包名配置
           PackageConfig packageConfig = new PackageConfig();
           packageConfig.setParent("com.tuuli");//设置生成的包名，默认为"com.baomidou"
           packageConfig.setEntity("domain");//设置实体类包名，默认为entity
           packageConfig.setMapper("dao");//设置数据层包名，默认为mapper
           autoGenerator.setPackageInfo(packageConfig);
   
           //策略设置
           StrategyConfig strategyConfig = new StrategyConfig();
           strategyConfig.setInclude("tb_course");//设置参与生成的表名，可填一个或多个
           strategyConfig.setTablePrefix("tb_");//设置数据库表名的前缀名称，设置后会省略该前缀
           strategyConfig.setRestControllerStyle(false);//设置是否启用Rest风格
           //strategyConfig.setLogicDeleteFieldName("deleted");//设置逻辑删除字段名，没有就不填
           strategyConfig.setEntityLombokModel(true);//设置是否启用Lombok
           autoGenerator.setStrategy(strategyConfig);
   
           //执行生成操作
           autoGenerator.execute();
       }
   

3. 测试

   • 新建一个springboot项目，导入相关依赖坐标，初始时目录结构如下：

• 新建数据库，数据名db3，新建了两个表，分别为tb_user、tb_course，表结构如下：

  tb_user

  

  tb_course

  

  表中内容均为空。

• 生成代码，此处代码生成器的完整代码的如下：

  package com.tuuli;
  
  import com.baomidou.mybatisplus.annotation.IdType;
  import com.baomidou.mybatisplus.generator.AutoGenerator;
  import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
  import com.baomidou.mybatisplus.generator.config.GlobalConfig;
  import com.baomidou.mybatisplus.generator.config.PackageConfig;
  import com.baomidou.mybatisplus.generator.config.StrategyConfig;
  
  /**
   * @author tuuli
   * @time Created in 2023/2/20 23:21
   * @description
   */
  public class Generator {
      public static void main(String[] args) {
          //获取代码生成器对象
          AutoGenerator autoGenerator = new AutoGenerator();
  
          //设置数据库相关配置
          DataSourceConfig dataSource = new DataSourceConfig();
          dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
          dataSource.setUrl("jdbc:mysql://localhost:3306/db3?serverTimezone=UTC");
          dataSource.setUsername("root");
          dataSource.setPassword("1234");
          autoGenerator.setDataSource(dataSource);
  
          //设置全局配置
          GlobalConfig globalConfig = new GlobalConfig();
          globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");//设置代码输出位置，否则默认输出到D://目录下
          globalConfig.setOpen(false);//设置生成完毕后是否打开生成代码的目录，一般选择false，不需要打开目录
          globalConfig.setAuthor("tuuli");//作者名字，会在注释中添加作者名字
          globalConfig.setFileOverride(true);//是否覆盖原始生成的文件，选择true后，生成时若原来已有相同文件会自动覆盖，谨慎操作
          globalConfig.setMapperName("%sDao");//设置数据层接口名，%s为占位符，指代模块名称，默认为"%sMapper"
          globalConfig.setIdType(IdType.AUTO);//设置id生成策略
          autoGenerator.setGlobalConfig(globalConfig);
  
          //设置包名配置
          PackageConfig packageConfig = new PackageConfig();
          packageConfig.setParent("com.tuuli");//设置生成的包名，默认为"com.baomidou"
          packageConfig.setEntity("domain");//设置实体类包名，默认为entity
          packageConfig.setMapper("dao");//设置数据层包名，默认为mapper
          autoGenerator.setPackageInfo(packageConfig);
  
          //策略设置
          StrategyConfig strategyConfig = new StrategyConfig();
          strategyConfig.setInclude("tb_course", "tb_user");//设置参与生成的表名，可填一个或多个
          strategyConfig.setTablePrefix("tb_");//设置数据库表名的前缀名称，设置后会省略该前缀
          strategyConfig.setRestControllerStyle(false);//设置是否启用Rest风格
          //strategyConfig.setLogicDeleteFieldName("deleted");//设置逻辑删除字段名，没有就不填
          strategyConfig.setEntityLombokModel(true);//设置是否启用Lombok
          autoGenerator.setStrategy(strategyConfig);
  
          //执行生成操作
          autoGenerator.execute();
      }
  }
  
  

• 运行成功，目录内容已发生改变，已生成相关代码

  

controller层代码：

dao层代码（请手动添加@Mapper注解，否则后面会出错）：

domain层代码：

mapper.xml

注意：生成出来的xml文件默认是在java/…/…目录下，但是springboot在打包时是不会把java目录下的xml文件打包的，运行时会报错找不到xml文件，因此我们需要将mapper包移到resources目录下。在resources目录下新建一个名为mapper的文件夹，然后将xml文件移到这个文件夹中，并在application.yml中作以下配置：

mybatis-plus:
	mapper-locations: classpath*:/mapper/*.xml

然后删掉生成出来的target文件夹，重新运行即可。

service接口：

service实现类：