微服务（三）—— MyBatis逆向工程模块（backend-generator）

关注

转载 2023-10-31 20:47:59 1.2k 阅读 AI 写同款· GEO 优化 ›

SpringBoot+Vue构建企业级二手交易平台实战现代Web应用开发中，前后端分离架构已成为主流技术范式。通过SpringBoot构建RESTful API后端服务，结合Vue实现动态前端交互，能够显著提升系统可维护性和开发效率。这种架构模式的核心价值在于清晰的职责分离，后端专注于业务逻辑与数据持久化（如MySQL事务处理），前端负责用户体验与状态管理（如Pinia状态库）。在电商类应用场景中，这种技术组合特别适合处理商品管理、订单状态机等典型业务需求。本文以二手交易平台为例，详细解析如何整合JWT认证、MyBatis动态SQL、Redis多级缓存等关键技阅读详情

一、创建项目

首先创建一个SpringBoot项目，具体创建过程和微服务（二）—— 公共模块（backend-common）.类似。

二、项目结构

1. pom.xml文件

添加父依赖，这里主要是为了使用父依赖添加的依赖

<parent>
    <artifactId>BackendManageSystem</artifactId>
    <groupId>com.aiun</groupId>
    <version>1.0-SNAPSHOT</version>
</parent>

完整的pom文件如下

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>BackendManageSystem</artifactId>
        <groupId>com.aiun</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>backend-generator</artifactId>

    <dependencies>
        <!-- mybatis 依赖 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <!--mybatis generator core 依赖-->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>
    </dependencies>

    <!-- build 标签常用于添加插件及编译配置-->
    <build>
        <plugins>
            <!-- mybatis generator plugin 依赖-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <verbose>true</verbose>
                    <!-- 是否覆盖-->
                    <overwrite>true</overwrite>
                    <!-- 配置文件-->
                    <configurationFile>src/main/resources/mybatis-generator.xml</configurationFile>
                </configuration>
                <dependencies>
                    <!-- mysql 数据库连接依赖-->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>${mysql.version}</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>

mybatis 依赖由于在父模块定义了，所以这里不需要版本号，遵循父模块的版本号；
mybatis generator core 依赖只是本模块需要使用，所以不需要在父模块添加依赖；

<configurationFile>src/main/resources/mybatis-generator.xml</configurationFile>

描述了xml配置文件的位置

2. mybatis-generator.xml配置文件

首先需要配置JDBC数据库的连接信息

<jdbcConnection
        driverClass="com.mysql.cj.jdbc.Driver"
        connectionURL="jdbc:mysql://localhost:3306/trade?useUnicode=true&amp;
characterEncoding=UTF-8&amp;serverTimezone=UTC&amp;tinyIntlisBit=false"
        userId="root"
        password="数据库连接密码">
</jdbcConnection>

然后需要配置数据库表对应的实体类对象信息

<!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
  targetPackage     指定生成的model生成所在的包名
  targetProject     指定在该项目下所在的路径
-->
<javaModelGenerator targetPackage="com.aiun.generator.pojo" targetProject="./src/main/java">
    <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
    <property name="enableSubPackages" value="false"/>
    <!-- 是否对model添加 构造函数 -->
    <property name="constructorBased" value="true"/>
    <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
    <property name="trimStrings" value="true"/>
    <!-- 建立的Model对象是否不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
    <property name="immutable" value="false"/>
</javaModelGenerator>

配置DAO层的Mapper接口信息

<!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
        type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
        type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
        type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
-->
<!-- targetPackage：mapper接口dao生成的位置 -->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.aiun.generator.mapper" targetProject="./src/main/java">
    <!-- enableSubPackages:是否让schema作为包的后缀 -->
    <property name="enableSubPackages" value="false" />
</javaClientGenerator>

配置Mapper接口对应的mapper.xml映射文件的信息，主要用来写SQL语句

<!--mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
<sqlMapGenerator targetPackage="com.aiun.generator.mapper" targetProject="./src/main/resources">
    <property name="enableSubPackages" value="false"/>
</sqlMapGenerator>

如果数据库表名和Java实体对象名不同还需要配置数据库实体和Java实体类的映射关系

<table tableName="trade_shipping" domainObjectName="Shipping" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
<table tableName="trade_cart" domainObjectName="Cart" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
<table tableName="trade_category" domainObjectName="Category" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
<table tableName="trade_order" domainObjectName="Order" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
<table tableName="trade_order_item" domainObjectName="OrderItem" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
<table tableName="trade_pay_info" domainObjectName="PayInfo" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
<table tableName="trade_product" domainObjectName="Product" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
    <columnOverride column="detail" jdbcType="VARCHAR" />
    <columnOverride column="sub_images" jdbcType="VARCHAR" />
</table>
<table tableName="trade_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>

mybatis-generator.xml配置文件完整的如下：
参考https://blog.youkuaiyun.com/for_my_life/article/details/51228098.博客。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<!-- 配置生成器 -->
<generatorConfiguration>
    <context id="MysqlTables" targetRuntime="MyBatis3">
        <!-- 生成 java 文件的编码-->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 增加 Models ToString 方法-->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!-- 增加 Models Serializable 实现-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>

        <!-- 是否去除自动生成的注释 true:是，false:否 -->
        <!-- type 指定生成注释使用的对象-->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="false"/>
        </commentGenerator>

        <!--jdbc的数据库连接 -->
        <jdbcConnection
                driverClass="com.mysql.cj.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/trade?useUnicode=true&amp;
characterEncoding=UTF-8&amp;serverTimezone=UTC&amp;tinyIntlisBit=false"
                userId="root"
                password="数据库连接密码">
        </jdbcConnection>


        <!-- 是否忽略 BigDecimals 非必需，类型处理器，在数据库类型和java类型之间的转换控制
                 自动生成 Java 对象的时候，会根据 number 类型的长度生成不同的数据类型
                    number 长度      java 类型
                    1-4              Short
                    5-9              Integer
                    10-18            Long
                    18+              BigDecimal-->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>


        <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
            targetPackage     指定生成的model生成所在的包名
            targetProject     指定在该项目下所在的路径
        -->
        <javaModelGenerator targetPackage="com.aiun.generator.pojo" targetProject="./src/main/java">
            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对model添加 构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立的Model对象是否不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!--mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
        <sqlMapGenerator targetPackage="com.aiun.generator.mapper" targetProject="./src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
                type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
                type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
                type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
        -->
        <!-- targetPackage：mapper接口dao生成的位置 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.aiun.generator.mapper" targetProject="./src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <table tableName="trade_shipping" domainObjectName="Shipping" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        <table tableName="trade_cart" domainObjectName="Cart" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        <table tableName="trade_category" domainObjectName="Category" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        <table tableName="trade_order" domainObjectName="Order" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        <table tableName="trade_order_item" domainObjectName="OrderItem" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        <table tableName="trade_pay_info" domainObjectName="PayInfo" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
        <table tableName="trade_product" domainObjectName="Product" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
            <columnOverride column="detail" jdbcType="VARCHAR" />
            <columnOverride column="sub_images" jdbcType="VARCHAR" />
        </table>
        <table tableName="trade_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
    </context>
</generatorConfiguration>