使用 MyBatis-Plus 的 AutoGenerator 代码生成器自动生成代码

483 阅读3分钟

使用 MyBatis-Plus 的 AutoGenerator 代码生成器

1、新建测试表

 CREATE TABLE `user` (
   `id` bigint NOT NULL COMMENT '主键',
   `name` varchar(32) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin NOT NULL COMMENT '姓名',
   `phone` varchar(11) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin NOT NULL COMMENT '手机号',
   `sex` varchar(2) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin NOT NULL COMMENT '性别',
   `id_car_number` varchar(18) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin NOT NULL COMMENT '身份证号',
   `create_time` datetime NOT NULL COMMENT '创建时间',
   `update_time` datetime NOT NULL COMMENT '更新时间',
   PRIMARY KEY (`id`) USING BTREE
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_bin COMMENT='员工信息';

2、新建一个工程

image-20230714201739239.png

image-20230714202426750.png

3、引入依赖

 <dependency>
     <groupId>org.apache.velocity</groupId>
     <artifactId>velocity-engine-core</artifactId>
     <version>2.0</version>
 </dependency>
 ​
 <dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-generator</artifactId>
     <version>3.2.0</version>
     <scope>test</scope>
 </dependency>
 ​
 <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <scope>runtime</scope>
 </dependency>

注意:引入依赖之后记得刷新一下依赖

4、将此文将放到test目录下

说明:为什么放到test目录下,放到main目录下不行吗?

也可以放到main目录下,但是项目打包的时候这个文件就会被一起打包到项目中,但是此文件只是在开发的时候有用,所以,建议放到test目录下

 import com.baomidou.mybatisplus.annotation.DbType;
 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;
 import com.baomidou.mybatisplus.generator.config.rules.DateType;
 import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
 ​
 /**
  * @author: cvv
  * @since: 1.0
  * @version: 1.0
  * @description:
  */
 ​
 public class codeAutoGenerator {
 ​
     public static void main(String[] args) {
 ​
         // 1、创建代码生成器
         AutoGenerator mpg = new AutoGenerator();
 ​
         // 2、全局配置
         GlobalConfig gc = new GlobalConfig();
         //获取当前根路径(即项目文件夹所在的位置),如果出问题,自己修改成绝对路径即可
         String projectPath = System.getProperty("user.dir");
         //String projectPath = "D:/dev/code/test/mybatis_plus_autoGenerator"
 ​
         //输出目录,即代码生成后的位置
         gc.setOutputDir(projectPath + "/src/main/java");
 ​
         //设置作者名字
         gc.setAuthor("cvv");
 ​
         //生成后是否打开资源管理器,即代码生成完毕之后是否将文件夹展开,方便查看
         gc.setOpen(false);
 ​
         //重新生成时文件是否覆盖
         gc.setFileOverride(false);
 ​
         //去掉Service接口的首字母I,写了生成的文件名为:UserService,不写为:IUserService
         gc.setServiceName("%sService");
 ​
         //主键策略,
         // 如果id属性为long型,设置为ID_WORKER,如果属性为String型,设置为ID_WORKER_STR
         gc.setIdType(IdType.ID_WORKER_STR);
 ​
         //定义生成的实体类中日期类型,这个一般不用修改,暂时不管
         gc.setDateType(DateType.ONLY_DATE);
 ​
         //开启Swagger2模式
         gc.setSwagger2(false);
 ​
         mpg.setGlobalConfig(gc);
 ​
         // 3、数据源配置
         DataSourceConfig dsc = new DataSourceConfig();
         dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8");
         dsc.setDriverName("com.mysql.cj.jdbc.Driver");
         dsc.setUsername("root");
         dsc.setPassword("123456");
         dsc.setDbType(DbType.MYSQL);
         mpg.setDataSource(dsc);
 ​
         // 4、包配置
         PackageConfig pc = new PackageConfig();
 ​
         //包名:com.mybatisplus.test
         pc.setParent("com.mybatisplus");
         pc.setModuleName("test"); //模块名,这里的值可以为null
 ​
         //com.mybatisplus.test.controller
         pc.setController("controller");
         //com.mybatisplus.test.entity
         pc.setEntity("entity");
         //com.mybatisplus.test.service
         pc.setService("service");
         //com.mybatisplus.test.mapper
         pc.setMapper("mapper");
         mpg.setPackageInfo(pc);
 ​
         // 5、策略配置
         StrategyConfig strategy = new StrategyConfig();
         //对那一张表生成代码,正常情况下只用修改这里即可,后面的不建议修改
         strategy.setInclude("user");
         //多张表
         //strategy.setInclude("user","order","student"...);
 ​
         strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
         strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
 ​
         strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
         strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作
 ​
         strategy.setRestControllerStyle(true); //restful api风格控制器
         strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
 ​
         mpg.setStrategy(strategy);
 ​
         // 6、执行
         mpg.execute();
     }
 }
 ​

以上文件会改即可,不需要自己写

一般只需要修改这几个地方即可

 //设置作者名字,修改成自己的,不改也行
 gc.setAuthor("cvv");
 // 3、数据源配置
 DataSourceConfig dsc = new DataSourceConfig();
 dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8");
 dsc.setDriverName("com.mysql.cj.jdbc.Driver");
 dsc.setUsername("root");
 dsc.setPassword("123456");
 dsc.setDbType(DbType.MYSQL);
  // 4、包配置,改成自己的包名,修改完成之后会在src/main/java目录下生成对应的包
  PackageConfig pc = new PackageConfig();
 ​
 //包名:com.mybatisplus.test
 pc.setParent("com.mybatisplus");
 pc.setModuleName("test"); //模块名,这里的值可以为null
  // 5、策略配置
  StrategyConfig strategy = new StrategyConfig();
  
  //对哪里一张表生成代码
  strategy.setInclude("user");
  //对多张表生成代码
  //strategy.setInclude("user","order","student"...);

5、修改完以上文件,右键运行即可

image-20230714211314946.png