Spring Boot - 使用 MyBatis 的 Maven 插件生成代码

太过爱你忘了你带给我的痛 2023-10-04 12:01 27阅读 0赞

我们无需手动编写实体类、DAO、XML 配置文件，只需要使用 MyBatis 提供的一个 Maven 插件就可以自动生成所需的各种文件便能够满足基本的业务需求，如果业务比较复杂只需要修改相关文件即可。

### 配置插件 ###

在 `pom.xml` 文件中增加 mybatis-generator-maven-plugin\` 插件

<build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.5</version>
                <configuration>
                    <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>${mysql.version}</version>
                    </dependency>
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>3.4.4</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

*  configurationFile：自动生成所需的配置文件路径

#### 自动生成的配置 ####

在 `src/main/resources/generator` 目录下创建 `generatorConfig.xml` 配置文件：

<?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>
        
        <properties resource="jdbc.properties"/>
    
        <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
            <property name="beginningDelimiter" value="`"/>
            <property name="endingDelimiter" value="`"/>
            
            
            <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
                <property name="mappers" value="tx.mybatis.MyMapper"/>
            </plugin>
    
            
            <jdbcConnection
                    driverClass="${jdbc.driverClass}"
                    connectionURL="${jdbc.connectionURL}"
                    userId="${jdbc.username}"
                    password="${jdbc.password}">
            </jdbcConnection>
    
            
            <javaModelGenerator targetPackage="com.bianya.hello.spring.boot.entity" targetProject="src/main/java"/>
    
            
            <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>
    
            
            <javaClientGenerator
                    targetPackage="com.bianya.hello.spring.boot.mapper"
                    targetProject="src/main/java"
                    type="XMLMAPPER"/>
    
            
            <table catalog="myshop" tableName="%">
                
                <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
            </table>
        </context>
    </generatorConfiguration>

### 配置数据源 ###

在 `src/main/resources` 目录下创建 `jdbc.properties` 数据源配置：

# MySQL 8.x: com.mysql.cj.jdbc.Driver
    jdbc.driverClass=com.mysql.jdbc.Driver
    jdbc.connectionURL=jdbc:mysql://ip:port/dbname?useUnicode=true&characterEncoding=utf-8&useSSL=false
    jdbc.username=root
    jdbc.password=123456

### 插件自动生成命令 ###

mvn mybatis-generator:generate