Springboot mybatis generate 自动生成实体类和Mapper

2022-12-26 08:12:49

https://github.com/JasmineQian/SpringDemo_2019/tree/master/mybatis

Springboot让java开发变得方便，Springboot中的插件让项目开发变得更更更便捷。

以下演示如何运用mybatis generate 自动生成实体类和Mapper。

需要的原材料：
数据库的用户名密码
数据库的表
数据库的驱动jar，需下载到本地

搭建一个新的空项目
项目中进行必要的配置

关于新建一个springboot项目，就不多说了，下面是生成的空项目的截图，可依据截图增加必要的目录。

POM.xml文件中需要添加数据库驱动和mybatis插件依赖

<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.14</version>
</dependency>

<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>

其次，POM.xml文件中还需要增加build块的mybatis generator maven插件和mysql驱动依赖

<build>
    <plugins>
        <!--添加mybatis generator maven插件-->
        <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.5</version>
        <configuration>
            <!--generatorConfig.xml位置-->
            <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
            <verbose>true</verbose>
            <overwrite>true</overwrite>
        </configuration>
        <executions>
            <execution>
                <id>Generate MyBatis Artifacts</id>
                <goals>
                    <goal>generate</goal>
                </goals>
                <phase>generate-sources</phase>
            </execution>
        </executions>
        <!--此处必须添加mysql驱动包-->
        <dependencies>
    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.14</version>
            </dependency>

        </dependencies>
        </plugin>
    </plugins>
</build>

完整的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 http://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.1.2.RELEASE</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <groupId>com.example</groupId>

    <artifactId>mybaitis</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <name>mybaitis</name>

    <description>Demo project for Spring Boot</description>

    <properties>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-thymeleaf</artifactId>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

        <dependency>

            <groupId>org.mybatis.spring.boot</groupId>

            <artifactId>mybatis-spring-boot-starter</artifactId>

            <version>2.0.0</version>

        </dependency>

        <dependency>

            <groupId>mysql</groupId>

            <artifactId>mysql-connector-java</artifactId>

            <version>8.0.14</version>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-test</artifactId>

            <scope>test</scope>

        </dependency>

        <dependency>

            <groupId>org.mybatis.generator</groupId>

            <artifactId>mybatis-generator-core</artifactId>

            <version>1.3.5</version>

        </dependency>

    </dependencies>

    <build>

        <plugins>

            <!--添加mybatis generator maven插件-->

            <plugin>

            <groupId>org.mybatis.generator</groupId>

            <artifactId>mybatis-generator-maven-plugin</artifactId>

            <version>1.3.5</version>

            <configuration>

                <!--generatorConfig.xml位置-->

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

                <verbose>true</verbose>

                <overwrite>true</overwrite>

            </configuration>

            <executions>

                <execution>

                    <id>Generate MyBatis Artifacts</id>

                    <goals>

                        <goal>generate</goal>

                    </goals>

                    <phase>generate-sources</phase>

                </execution>

            </executions>

            <!--此处必须添加mysql驱动包-->

            <dependencies>

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->

                <dependency>

                    <groupId>mysql</groupId>

                    <artifactId>mysql-connector-java</artifactId>

                    <version>8.0.14</version>

                </dependency>

            </dependencies>

            </plugin>

        </plugins>

    </build>

</project>

下面就是对Generator做一些配置，比如对哪些表进行自动生成，生成的mapper存放路径等等。

到resources目录下的mybatis-generator目录下，创建两个文件，分别是generatorConfig.xml 和mybatisGenerator.properties

<?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>

    <!--执行generator插件生成文件的命令： call mvn mybatis-generator:generate -e -->

    <!-- 引入配置文件 -->

    <properties resource="mybatis-generator/mybatisGeneratorinit.properties"/>

    <!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->

    <classPathEntry location="D:/mysql-connector-java-8.0.14.jar" />

    <!-- 一个数据库一个context -->

    <!--defaultModelType="flat" 大数据字段，不分表 -->

    <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">

        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；

        一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->

        <property name="autoDelimitKeywords" value="true" />

        <!-- 生成的Java文件的编码 -->

        <property name="javaFileEncoding" value="utf-8" />

        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->

        <property name="beginningDelimiter" value="`" />

        <property name="endingDelimiter" value="`" />

        <!-- 格式化java代码 -->

        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>

        <!-- 格式化XML代码 -->

        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />

        <!-- 注释 -->

        <commentGenerator >

            <property name="suppressAllComments" value="false"/><!-- 是否取消注释 -->

            <property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳-->

        </commentGenerator>

        <!-- jdbc连接 -->

        <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" />

        <!-- 类型转换 -->

        <javaTypeResolver>

            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->

            <property name="forceBigDecimals" value="false"/>

        </javaTypeResolver>

        <!-- 生成实体类地址 -->

        <javaModelGenerator targetPackage="${modelPackage}" targetProject="${models}" >

            <property name="enableSubPackages" value="false"/>

            <property name="trimStrings" value="true"/>

        </javaModelGenerator>

        <!-- 生成mapxml文件 -->

        <sqlMapGenerator targetPackage="mapper" targetProject="${resources}" >

            <property name="enableSubPackages" value="false" />

        </sqlMapGenerator>

        <!-- 生成mapxml对应client，也就是接口dao -->

        <javaClientGenerator targetPackage="${daoPackage}" targetProject="${dao}" type="XMLMAPPER" >

            <property name="enableSubPackages" value="true" />

        </javaClientGenerator>

        <!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->

        <!--如果想生成一个表则tableName="table_name"-->

        <table tableName="qa_employ"

               enableCountByExample="false"

               enableUpdateByExample="true"

               enableDeleteByExample="false"

               enableSelectByExample="true"

               selectByExampleQueryId="true">

            <property name="useActualColumnNames" value="false" />

            <!-- 数据库表主键 -->

            <generatedKey column="id" sqlStatement="Mysql" identity="true" />

        </table>

    </context>

</generatorConfiguration>

jdbc_driver=com.mysql.cj.jdbc.Driver

jdbc_url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true

jdbc_user=root

jdbc_password=root

daoPackage=com.example.mybaitis.dao

modelPackage=com.example.mybaitis.model

models= src/main/java

resources=src/main/resources

dao=src/main/java

之后双击mabatis-generator即可在对应目录下生成对应的dao，model，mapper文件

生成之后，如果这个项目不再需要自动生成器了，建议将依赖的build和jar包全部删除掉。

或者将有用的文件全部复制走。不要在真正的项目里，将一次性的依赖和持久的依赖，混淆在一起。

码农公寓

相关文章