如何使用MybatisPlus的代码生成器?

本是古典何须时尚 2022-10-06 05:56 228阅读 0赞

### 我在这里将做些什么？ ###

在这里我将展示MybatisPlus自动生成实体类、控制层、服务层、mapper等代码，这些基础的代码全部不需要我们手动创建，由MybatisPlus自动帮我们完成，我们只需要告诉MybatisPlus怎么生成这些代码就可以了，也就是编辑策略配置文件。  
当然了在此之前我们需要配置好测试的环境，配置好测试的数据库和表数据。

### 搭建测试的数据库和表数据的SQL ###

/*
     Navicat Premium Data Transfer
    
     Source Server         : MySQL8.0
     Source Server Type    : MySQL
     Source Server Version : 80022
     Source Host           : localhost:3306
     Source Schema         : mybatisplus
    
     Target Server Type    : MySQL
     Target Server Version : 80022
     File Encoding         : 65001
    
     Date: 11/06/2021 17:37:58
    */
    
    SET NAMES utf8mb4;
    SET FOREIGN_KEY_CHECKS = 0;
    
    -- ----------------------------
    -- Table structure for user
    -- ----------------------------
    DROP TABLE IF EXISTS `user`;
    CREATE TABLE `user`  (
      `id` bigint(0) NOT NULL COMMENT '主键ID',
      `name` varchar(30) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '姓名',
      `age` int(0) NULL DEFAULT NULL COMMENT '年龄',
      `email` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '邮箱',
      `create_time` datetime(0) NULL DEFAULT NULL COMMENT '创建时间',
      `update_time` datetime(0) NULL DEFAULT NULL COMMENT '修改时间',
      `version` int(0) NULL DEFAULT NULL COMMENT '版本号',
      `deleted` tinyint(1) NULL DEFAULT NULL COMMENT '用于逻辑删除',
      PRIMARY KEY (`id`) USING BTREE
    ) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
    
    -- ----------------------------
    -- Records of user
    -- ----------------------------
    INSERT INTO `user` VALUES (1, 'Jone', 18, 'test1@baomidou.com', NULL, NULL, NULL, NULL);
    INSERT INTO `user` VALUES (2, 'Jack', 20, 'test2@baomidou.com', NULL, NULL, NULL, NULL);
    INSERT INTO `user` VALUES (3, 'Tom', 38, 'test3@baomidou.com', NULL, '2021-04-11 16:13:56', NULL, NULL);
    INSERT INTO `user` VALUES (4, 'Sandy', 21, 'test4@baomidou.com', NULL, NULL, NULL, NULL);
    INSERT INTO `user` VALUES (5, 'Billie', 24, 'test5@baomidou.com', NULL, NULL, NULL, NULL);
    INSERT INTO `user` VALUES (1381145367839522818, '李白', 28, 'lucy@qq.com', NULL, NULL, NULL, NULL);
    INSERT INTO `user` VALUES (1381156317133090817, 'lili', 28, 'lucyee@qq.com', NULL, NULL, NULL, NULL);
    INSERT INTO `user` VALUES (1381157235618492418, 'lili', 28, 'lucyee@qq.com', NULL, NULL, NULL, NULL);
    INSERT INTO `user` VALUES (1381158109963096065, 'lili', 28, 'lucyee@qq.com', '2021-04-11 16:12:09', NULL, NULL, NULL);
    INSERT INTO `user` VALUES (1381166877736280066, '江小白', 200, 'lucyee@qq.com', '2021-04-11 16:46:59', '2021-04-11 16:51:57', 2, NULL);
    INSERT INTO `user` VALUES (1381186511252258818, '东方不败', 200, 'lucyee@qq.com', '2021-04-11 18:05:00', '2021-04-11 18:05:47', 2, 1);
    INSERT INTO `user` VALUES (1381225266432524290, '东方不败11', 28, 'lucyee@qq.com', '2021-04-11 20:39:00', '2021-04-11 20:39:00', 1, NULL);
    
    SET FOREIGN_KEY_CHECKS = 1;

### 引入Maven的配置文件 ###

在这里我多引入了swagger测试接口的依赖，因为在MybatisPlus的配置文件里，可以配置自动添加swagger的注解。用于测试接口时的标识。

<dependency>
                    <groupId>com.baomidou</groupId>
                    <artifactId>mybatis-plus-boot-starter</artifactId>
                     <version>3.0.5</version>
                </dependency>
    
                
                <dependency>
                    <groupId>org.apache.velocity</groupId>
                    <artifactId>velocity-engine-core</artifactId>
                    <version>2.0</version>
                </dependency>
    
     
           <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger2</artifactId>
          <version>2.7.0</version>
          <scope>provided </scope>
        </dependency>
        <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-ui</artifactId>
          <version>2.7.0</version>
          <scope>provided </scope>
        </dependency>

### 编辑MybatisPlus的配置文件 ###

在配置文件里有很多的注释，你可以根据注释来理解配置文件，并且改成和自己数据库对应的配置

package com.atguigu.demo;
    
    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;
    import org.junit.Test;
    
    /** * @author huiXing * @since 2018/12/13 */
    public class CodeGenerator { 
    
        @Test
        public void run() { 
    
            // 1、创建代码生成器
        AutoGenerator mpg = new AutoGenerator();
    
        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("huiXing");
        gc.setOpen(false); //生成后是否打开资源管理器
        gc.setFileOverride(false); //重新生成时文件是否覆盖
        gc.setServiceName("%sService");	//去掉Service接口的首字母I
        gc.setIdType(IdType.ID_WORKER_STR); //主键策略
        gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
        gc.setSwagger2(true);//开启Swagger2模式
    
        mpg.setGlobalConfig(gc);
    
        // 3、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/fyDatabase?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();
        pc.setModuleName("production"); //模块名
        pc.setParent("com.fuyuan.springboot");
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);
    
        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
    
        strategy.setInclude("tb_production");
    
        strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
        // strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
        strategy.setTablePrefix("tb" + "_"); //生成实体类时 去掉前缀t_
    
        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();
        }
    }

### 配置application.properties文件 ###

# 服务端口
    server.port=8009
    
    # mysql数据库连接
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=GMT%2B8
    spring.datasource.username=root
    spring.datasource.password=123456
    
    #返回json的全局时间格式
    spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
    spring.jackson.time-zone=GMT+8
    
    #mybatis-plus日志
    mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

编辑完毕了之后直接运行测试类就可以自动生成开发所需要的代码了  
当你看到有代码自动生成出来了说明你成功了：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NzM5NzA2_size_16_color_FFFFFF_t_70]  
[上一篇:MybatisPlus原理大纲][MybatisPlus] [下一篇：MybatisPlus的CRUD操作][MybatisPlus_CRUD]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NzM5NzA2_size_16_color_FFFFFF_t_70]: /images/20221005/c71df515e34043c8ba0a962305526192.png
[MybatisPlus]: https://hxwwhl.blog.csdn.net/article/details/117817201
[MybatisPlus_CRUD]: https://hxwwhl.blog.csdn.net/article/details/117848561