基于maven插件-代码生成器(MybatisPlus)

问题引入？

如果只给一张表的字段信息，是否能够推演出springboot各层结构的代码呢？

一、代码生成器是什么？

代码生成器是一种自动化工具，用于根据预定义的模板和配置信息生成项目中的代码文件。它可以在开发过程中减少重复性的编码工作，提高开发效率。

1.1 核心组件

代码生成器通常会需要以下几个核心组件：

1. 模板文件：定义了生成代码的结构和内容。模板文件中会包含占位符或者模板语言，用于动态生成代码内容。
2. 配置文件：用于配置代码生成器的参数，例如数据库连接信息、模板文件路径、生成代码的路径等。
3. 元数据：指定生成代码的源数据，比如数据库表结构、实体类定义等。代码生成器会根据元数据来生成相应的代码文件。

1.2 基本工作流程

其工作流程主要分为以下几个步骤;

1. 读取配置文件，获取生成代码的参数和模板文件路径。
2. 根据配置文件的参数连接到数据库，读取数据库的元数据。
3. 解析模板文件，根据元数据和模板语言生成代码内容。
4. 将生成的代码内容写入指定的文件或者生成新的文件。
5. 生成代码的过程中，可能会根据业务需求进行一些自定义的操作，例如添加注释、修改包名等。

1.3 常见的代码生成器工具

        常见的代码生成器工具有很多，例如Maven插件 MyBatis-Plus 的代码生成器、Spring Boot的代码生成器、Eclipse的代码生成插件等。这些工具通常提供了各种配置选项和模板库，可以根据具体项目的需求进行定制和扩展。

          通过使用代码生成器，我们可以快速生成常见的代码文件，如实体类、Mapper接口、服务接口、服务实现类等。它可以减少手动编写重复性代码的工作量，提高开发效率，并确保生成代码的一致性和规范性。下面我们将针对Maven插件 MyBatis-Plus 的代码生成器来进行详细描述

二、MybatisPlus代码生成器

        MyBatis-Plus 是一个基于 MyBatis 的增强工具，提供了丰富的功能和增强的操作，其中包括一个强大的代码生成器。通过 MyBatis-Plus 的代码生成器，你可以根据数据库表结构自动生成实体类、Mapper 接口以及对应的 XML 映射文件。

2.1 使用步骤

1. 在项目的依赖管理中添加 MyBatis-Plus 的依赖。
2. 在项目中创建一个用于配置代码生成器的类，
3. 在代码生成器配置类中，根据需要配置数据源信息、全局配置、包配置和策略配置。你可以根据实际情况自定义配置，包括生成的文件路径、文件命名规则、数据库表选择等。
4. 运行代码生成器类的 main 方法，即可生成相应的实体类、Mapper 接口和 XML 映射文件。

2.2 生成的代码结构 

通常包括以下部分：

1. 实体类（Entity）：对应数据库表的实体类，使用JPA或MyBatis的注解定义实体属性和映射关系。
2. Mapper接口：继承了BaseMapper接口，提供了数据库的CRUD操作方法，可以直接使用通用的增删改查等方法。
3. 服务接口（Service Interface）：定义了业务逻辑的接口，可以扩展自定义的业务方法。
4. 服务实现类（Service Implement）：实现了服务接口，具体实现业务逻辑，可以调用Mapper接口提供的方法完成数据库操作。
5. 控制器类（Controller）：负责接收请求、调用服务接口进行处理，并返回响应结果。

        代码生成器还可以根据具体的配置进行定制，例如定义生成文件的包名、文件名、模板引擎和自定义模板等。需要注意的是，MyBatis-Plus代码生成器生成的代码结构只是一个基础模板，你可以根据具体的项目需求对生成的代码进行自定义修改。可以根据项目实际情况对生成的代码结构和文件进行调整和扩展，以满足项目的特定需求和规范。

三、工程搭建和项目编写

第一步：创建SpringBoot工程，添加代码生成器相关依赖，其他依赖自行添加

在使用 MyBatis-Plus 代码生成器之前，需要添加相应的依赖项。以下是使用代码生成器所需的核心依赖：

mybatis-plus-boot-starter：MyBatis-Plus 的核心依赖，包含了 MyBatis-Plus 的基础功能和增强功能。

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>

mybatis-plus-generator：代码生成器的依赖，包含了用于生成代码的相关配置和工具类。

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>最新版本</version>
</dependency>

数据库驱动依赖：根据你所使用的数据库类型选择相应的数据库驱动依赖项，比如 MySQL、Oracle、SQL Server 等。例如，使用 MySQL 数据库驱动的依赖项如下：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>版本号</version>
</dependency>

        根据实际项目需求，你可能需要添加其他依赖项，比如 Spring Boot Starter、Spring Data JPA 等。确保你在 pom.xml 文件中正确地配置了以上依赖项，并使用适当的版本号来匹配你的项目环境。请注意，版本号可以根据你的需求选择最新的可用版本。你可以参考 MyBatis-Plus 官方文档或在 Maven 仓库中查找最新的版本。

https://mp.baomidou.com/https://mp.baomidou.com/第二步：编写代码生成器类

package com.ithema;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;

public class Generator {
    public static void main(String[] args) {
        //1. 创建代码生成器对象，执行生成代码操作
        AutoGenerator autoGenerator = new AutoGenerator();
        //设置生成目录
        autoGenerator.setGlobalConfig(new GlobalConfig().setOutputDir("C:/works"));
        //2. 数据源相关配置：读取数据库中的信息，根据数据库表结构生成代码
        DataSourceConfig dataSource = new DataSourceConfig();
        dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC");
        dataSource.setUsername("root");
        dataSource.setPassword("123456");
        autoGenerator.setDataSource(dataSource);
        //3. 执行生成操作
        autoGenerator.execute();
    }
}

 当然也可以根据自己需要进行开发者自定义配置：

设置全局配置：

//设置全局配置
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(System.getProperty("user.dir")+"/mybatisplus_04_generator/src/main/java"); //设置代码生成位置
globalConfig.setOpen(false); //设置生成完毕后是否打开生成代码所在的目录
globalConfig.setAuthor("大写的z先生"); //设置作者
globalConfig.setFileOverride(true); //设置是否覆盖原始生成的文件
globalConfig.setMapperName("%sDao"); //设置数据层接口名，%s为占位符，指代模块名称
globalConfig.setIdType(IdType.ASSIGN_ID); //设置Id生成策略
autoGenerator.setGlobalConfig(globalConfig);

设置包名相关配置：

//设置包名相关配置
PackageConfig packageInfo = new PackageConfig();
packageInfo.setParent("com.aaa"); //设置生成的包名，与代码所在位置不冲突，二者叠加组成
完整路径
packageInfo.setEntity("domain"); //设置实体类包名
packageInfo.setMapper("dao"); //设置数据层包名
autoGenerator.setPackageInfo(packageInfo);

策略设置：

//策略设置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("tbl_user"); //设置当前参与生成的表名，参数为可变参数
strategyConfig.setTablePrefix("tbl_"); //设置数据库表的前缀名称，模块名 = 数据库表名 -
前缀名 例如： User = tbl_user - tbl_
strategyConfig.setRestControllerStyle(true); //设置是否启用Rest风格
strategyConfig.setVersionFieldName("version"); //设置乐观锁字段名
strategyConfig.setLogicDeleteFieldName("deleted"); //设置逻辑删除字段名
strategyConfig.setEntityLombokModel(true); //设置是否启用lombok
autoGenerator.setStrategy(strategyConfig);

四、测试运行

一切工作就绪之后，进行运行测试：

会在代码生成器类中所对应的自己所要其生成的目录下出现一个com文档:

 里面便是由自动生成器所生成的基本框架：