代码一键自动生成，拿走不谢

古城微笑少年丶 2023-07-22 05:58 5阅读 0赞

> 程序猿学社的GitHub，欢迎**Star**  
> [github技术专题][github]  
> 本文已记录到github

### 文章目录 ###

*  前言
 *  起源
 *  环境
 *  实战
 *   *  sql脚本
     *  pom.xml
     *  application.yml
     *  启动类
     *  代码自动生成
     *  controller类
 *  测试

# 前言 #

> **隔壁老王：** 社长，我工作有一段时间咯，我看其他的同事，上班都很悠闲，而且，那些实体类，感觉有模板似的，有点像机器生成的，是不是有什么工具，可以自动生成代码。  
> **社长：** 有的，嘻嘻，MP的AutoGenerator 插件，一键生成代码，并且，可以集成swagger，加上对应的注释，大大提高你的开发效率。  
> **隔壁老王：** 这么优秀，难怪，我看我们项目组的那些人，这么多时间撩妹。

# 起源 #

社长刚刚开始工作的时候，那时候，dao,entity，service，controller都要自己去编写。而这部分代码，都是有一定的规范，有需求，就有对应的产品应运而生,**AutoGenerator 是 MyBatis-Plus 的代码生成器**，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

# 环境 #

springboot 2.2.6.RELEASE  
mybatis-plus 3.3.0  
spring-boot-starter-swagger 1.5.1.RELEASE

*  环境版本最好保持一致，不然，你可以收获意外的惊喜  
    ![20200405191320526.png][]

# 实战 #

![20200405192709729.png][]

*  如遇到不清楚的，文件如何存放的，可以参考我的结构

## sql脚本 ##

/* Navicat Premium Data Transfer Source Server : 本地 Source Server Type : MySQL Source Server Version : 50722 Source Host : localhost:3306 Source Schema : pro Target Server Type : MySQL Target Server Version : 50722 File Encoding : 65001 Date: 05/04/2020 19:17:01 */
    
    SET NAMES utf8mb4;
    SET FOREIGN_KEY_CHECKS = 0;
    
    -- ----------------------------
    -- Table structure for student
    -- ----------------------------
    DROP TABLE IF EXISTS `student`;
    CREATE TABLE `student`  (
      `id` int(111) NOT NULL AUTO_INCREMENT COMMENT '编号',
      `name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '姓名',
      `age` int(11) NULL DEFAULT NULL COMMENT '年龄',
      PRIMARY KEY (`id`) USING BTREE
    ) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
    
    -- ----------------------------
    -- Records of student
    -- ----------------------------
    INSERT INTO `student` VALUES (1, '社长', 18);
    INSERT INTO `student` VALUES (2, '老王', 20);
    INSERT INTO `student` VALUES (3, '兰陵王', 11);
    
    SET FOREIGN_KEY_CHECKS = 1;

## pom.xml ##

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.6.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.cxyxs</groupId>
        <artifactId>auto</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>auto</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.3.0</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.1.tmp</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.2</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.18</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.6</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <optional>true</optional>
            </dependency>
    
            
            <dependency>
                <groupId>com.spring4all</groupId>
                <artifactId>spring-boot-starter-swagger</artifactId>
                <version>1.5.1.RELEASE</version>
            </dependency>
        </dependencies>
    
        <build>
            
            <finalName>codeauto</finalName>
            
            <resources>
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*</include> </includes> <filtering>true</filtering> </resource> <resource> <directory>src\main\java</directory> <includes> <include>**/*.xml</include>
                    </includes>
                </resource>
            </resources>
    
    
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
    
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-jar-plugin</artifactId>
                    <configuration>
                        <archive>
                            <manifest>
                                <addClasspath>true</addClasspath>
                                <classpathPrefix>lib/</classpathPrefix>
                                <mainClass>com.cxyxs.auto.AutoApplication</mainClass>
                            </manifest>
                        </archive>
                    </configuration>
                </plugin>
    
    
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-dependency-plugin</artifactId>
                    <executions>
                        <execution>
                            <id>copy-dependencies</id>
                            <phase>package</phase>
                            <goals>
                                <goal>copy-dependencies</goal>
                            </goals>
                            <configuration>
                                <outputDirectory>${ project.build.directory}/lib</outputDirectory>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
    
    
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-surefire-plugin</artifactId>
                    <configuration>
                        <skip>true</skip>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </project>

*  MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：
 *  为方便以后前后端对接，集成了swagger
 *  可达成jar包，直接build就行，build里面的配置，就是为了打成jar包

## application.yml ##

server:
      port: 8888
    
    spring:
      datasource:
        # 配置数据源
        driver-class-name: com.mysql.cj.jdbc.Driver
        # 使用druid连接池
        type: com.alibaba.druid.pool.DruidDataSource
        url: jdbc:mysql://127.0.0.1:3306/pro?useUnicode=true&characterEncoding=utf8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8
        username: root
        password: root
    
    ###增加日志输出，方便定位问题
    logging:
      level:
        root : warn
        com.cxyxs.mybatisplus.dao: trace
      ###控制台输出格式
      pattern:
        console: '%p%m%n'
    
    mybatis-plus:
      mapper-locations: classpath*:/com/cxyxs/auto/mapper/xml/*.xml global-config: db-config: ###逻辑未删除的值 logic-not-delete-value: 0 ###逻辑已删除的值 logic-delete-value: 1 ####扫描swagger注解 swagger: base-package: com.cxyxs

*  配置数据库的信息，以自己的配置为主
 *  mapper-locations 是根据自动生成代码的规则而定义的
 *  swagger 配置swagger注解，扫描范围

## 启动类 ##

package com.cxyxs.auto;
    
    import com.spring4all.swagger.EnableSwagger2Doc;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @MapperScan("com.cxyxs.auto.mapper")
    @EnableSwagger2Doc
    public class AutoApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(AutoApplication.class, args);
        }
    }

*  @MapperScan配置扫描dao包的位置(以我们常用的思维)，社长习惯以mapper命名
 *  @EnableSwagger2Doc 启用swagger注解  
    ![20200405192617946.png][]

## 代码自动生成 ##

package com.cxyxs.auto;
    
    import com.baomidou.mybatisplus.annotation.DbType;
    import com.baomidou.mybatisplus.annotation.FieldFill;
    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.po.TableFill;
    import com.baomidou.mybatisplus.generator.config.rules.DateType;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    import org.junit.runner.RunWith;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /** * Description： * Author: wude * Date: 2020/4/5 9:14 * Modified By: */
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class CodeGenerationTests { 
        public static void main(String[] args) { 
            // 代码生成器
            AutoGenerator mpg = new AutoGenerator();
    
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            //当前路径
            String projectPath = System.getProperty("user.dir");
            //输出路径
            gc.setOutputDir(projectPath + "/src/main/java");
            gc.setAuthor("程序猿学社");    //设置作者
            //生成代码后，是否打开文件夹
            gc.setOpen(false);
            gc.setFileOverride(false);  //是否覆盖原来代码，个人建议设置为false,别覆盖，危险系数太高
            gc.setServiceName("%sService");   //去掉service的I前缀,一般只需要设置service就行
    /* gc.setMapperName("%sMapper"); gc.setXmlName("%sMapper"); gc.setServiceImplName("%sServiceImpl"); gc.setControllerName("%sController");*/
    
            gc.setDateType(DateType.ONLY_DATE);   //日期格式
            gc.setSwagger2(true);       // 实体属性 Swagger2 注解,实体类上会增加注释
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://127.0.0.1:3306/pro?useUnicode=true&characterEncoding=utf8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8");
            // dsc.setSchemaName("public");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("root");
            dsc.setDbType(DbType.MYSQL);    //指定数据库的类型
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setParent("com.cxyxs.auto");   //自定义包的路径
            //pc.setModuleName("module"); //模块名称 设置后,会生成com.cxyxs.test.module,里面存放之前设置的mapper,entity
            pc.setEntity("entity");
            pc.setMapper("mapper");
            pc.setService("service");
            pc.setController("controller");
            mpg.setPackageInfo(pc);
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setInclude("student");    //设置映射的表名，可以设置多个表
    
            //表前缀设置 cxyxs_student
            //strategy.setTablePrefix(new String[]{"cxyxs_"});
            //包的命名规则，使用驼峰规则
            strategy.setNaming(NamingStrategy.underline_to_camel);
            //列的名称，使用驼峰规则
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            //是否使用lombok
            strategy.setEntityLombokModel(true);
            //驼峰命名
            strategy.setRestControllerStyle(true);
            strategy.setLogicDeleteFieldName("is_delete");   //逻辑删除,假删除会用到
    
            //自动填充字段,在项目开发过程中,例如创建时间，修改时间,每次，都需要我们来指定，太麻烦了,设置为自动填充规则，就不需要我们赋值咯
            TableFill fillInsert = new TableFill("create_time", FieldFill.INSERT);
            TableFill fillUpdate= new TableFill("update_time", FieldFill.UPDATE);
            List fillLists = new ArrayList();
            fillLists.add(fillInsert);
            fillLists.add(fillUpdate);
            strategy.setTableFillList(fillLists);
            //乐观锁
            //strategy.setVersionFieldName("version");
            mpg.setStrategy(strategy);
    
            mpg.execute();  //执行
        }
    }

直接启动main方法 ，见证奇迹的时候到咯。  
![20200405192931798.png][]  
![2020040519302692.png][]

*  contoller，entity,mapper,service代码都给我们生成好咯。  
    ![20200405193122237.png][]
 *  swagger注释都给我们生成好咯，而且代码也很规范，让我们自己来写，可能会遇到很多很低级的错误。
 *  虽说，代码自动生成很智能，智能的前提，是有规范的，数据库命令，最高遵守相关的规范，这里就不过多阐述咯

## controller类 ##

package com.cxyxs.auto.controller;
    
    
    import com.cxyxs.auto.entity.Student;
    import com.cxyxs.auto.mapper.StudentMapper;
    import com.cxyxs.auto.util.Result;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    /** * <p> * 前端控制器 * </p> * * @author 程序猿学社 * @since 2020-04-05 */
    @RestController
    @RequestMapping("/student")
    public class StudentController { 
        @Autowired
        private StudentMapper studentMapper;
    
        @GetMapping("/test")
        @ApiOperation(value = "测试接口",notes = "测试")
        public List<Student> getStudent1(Student stu){ 
            List<Student> lists = studentMapper.selectList(null);
            return lists;
        }
    }

*  StudentController这个类，是自动生成的，增加一个方法，来看看效果。

# 测试 #

http://localhost:8888/swagger-ui.html  
![20200405193907544.png][]

*  通过页面可以发现有一个basic-error-controller，实际上，我们代码里面没有定义这个，有强迫症的，可以百度解决方法，配置一下，这里社长，就不配置咯。  
    ![20200405194106459.png][]
 *  通过可视化界面，前端可以看到返回的参数注释  
    ![20200405194209403.png][]
 *  传参也有注释

点击**try it out**按钮  
![20200405194323413.png][]

*  跟前端需要对接的传参和返回参数都有注释，那个接口，用来干嘛的，都有注释文档。就没有后台什么事咯  
    ![20200405194551620.png][]

> 在公众号"程序猿学社",后台回复关键字"**代码自动生成**"，获取源码

--------------------

**原创不易，不要白嫖**，觉得有用的社友，**给我点赞**，让更多的老铁看到这篇文章。  
因技术能力有限，**如文中有不合理的地方，希望各位大佬指出，在下方评论留言**，谢谢，希望大家一起进步，一起成长。

> 作者：**程序猿学社**  
> 原创公众号：『**程序猿学社**』，专注于java技术栈，分享java各个技术系列专题，以及各个技术点的面试题。  
> 原创不易，转载请注明来源(注明：来源于公众号：**程序猿学社**， 作者：**程序猿学社**)。

![20200513150606197.png][]

[github]: https://github.com/ITfqyd/cxyxs
[20200405191320526.png]: /images/20230528/fb4da6dcbd1547f7afc2adfd7385d2a3.png
[20200405192709729.png]: /images/20230528/897864c3e28a4c25930b94362b3bddd1.png
[20200405192617946.png]: /images/20230528/c1c017e899a546c1bb8c47cc1d977651.png
[20200405192931798.png]: /images/20230528/ea5ebc603c684405bd4cf1c8464a6f0b.png
[2020040519302692.png]: /images/20230528/fd34faf72edc4b57bdbe5894df127787.png
[20200405193122237.png]: /images/20230528/9803619b44f0418babbc976a59dcd443.png
[20200405193907544.png]: /images/20230528/098615f698024b85b23859c6a2b8fbc4.png
[20200405194106459.png]: /images/20230528/f09dbb28d0304f1da1715974125c1bc0.png
[20200405194209403.png]: /images/20230528/7e10b4119d9943da9c66a8b6f3e740d7.png
[20200405194323413.png]: /images/20230528/e89bf30a61634885a40372d6e67b371b.png
[20200405194551620.png]: /images/20230528/8680dc195d0f4423986e65f3c514119c.png
[20200513150606197.png]: /images/20230528/e23b32ad2df9499eb28d5739184967e6.png