mybatis-generator使用

前言

Mybatis 数据库持久层框架，提供一种Mapper类，支持让你用java代码进行增删改查的数据库操作，节省每次写sql语句的麻烦。前提，我们需要配置好 xml,model,mapper文件类。人工手写还是显得麻烦，这里就有了mybatis-generator 自动生成简单的增删改查文件工具。

1、介绍

mybatis-generator 自动生成 mybatis 使用中的xml,model,mapper接口的工具。每次新加库表是时候，只需要改一下配置就可以生成持久层相关类。大大提高我们开发效率。下面就介绍使用的方法：

2、使用步骤

2.1、增加 pom文件

<properties>
    <mysql.connector.version>5.1.41</mysql.connector.version>
    <mybatis.gernerator.version>1.3.2</mybatis.gernerator.version>
</properties>

<dependencies>

    <dependency>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-core</artifactId>
        <version>${mybatis.gernerator.version}</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql.connector.version}</version>
    </dependency>

</dependencies>

<build>
    <plugins>
        <!--使用插件方式-->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.2</version>
            <configuration>
                <!-- 在控制台打印执行日志 -->
                <verbose>true</verbose>
                <!-- 重复生成时会覆盖之前的文件-->
                <overwrite>true</overwrite>
            </configuration>
        </plugin>
    </plugins>
</build>

说明：在使用generator 时，需要数据库链接驱动：connector及 mybatis-generator-core

2.2 、通用的generatorConfig.xml 文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/d td/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <!--
    1.修改javaModelGenerator,sqlMapGenerator,javaClientGenerator节点的targetPackage属性以及table节点的tableName属性
    2.命令行进入对应的项目持久层模块目录下，比如lincomb-order-persistence目录下
    3.执行 mvn mybatis-generator:generate -f mybatis.xml
    -->
    <properties resource="dbconfig.properties"></properties>
    <classPathEntry
            location="${jdbc.driverLocation}"/>

    <context id="MysqlTables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true" />
        </commentGenerator>

        <!--数据库链接信息-->
        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.connectionURL}"
                        userId="${jdbc.userId}"
                        password="${jdbc.password}">
        </jdbcConnection>

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

        <!--java 实体类-->
        <javaModelGenerator targetPackage="${project.name}.models" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--sql mapper文件 -->
        <sqlMapGenerator targetPackage="mapper.${project.package}" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!--java xml映射mapper 接口-->
        <javaClientGenerator targetPackage="${project.name}.models.mapper" type="XMLMAPPER" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!--需要Generator的库表-->
        <table schema="${jdbc.db}" tableName="${jdbc.table}">
            <property name="useActualColumnNames" value="false"/>
            <property name="ignoreQualifiersAtRuntime" value="true"/>
        </table>

    </context>
</generatorConfiguration>

2.3、数据库配置dbconfig.properties信息

jdbc.driverLocation=/Users/lys/.m2/repository/mysql/mysql-connector-java/5.1.41/mysql-connector-java-5.1.41.jar

## ------------------【本地数据配置】------
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/
jdbc.database=my_family
jdbc.userId=root
jdbc.password=123456

jdbc.db=my_family
jdbc.table=m_member_info
project.name=com.lsy.family
project.package=user

# ===================【运动中心】========
#jdbc.driverClass=com.mysql.jdbc.Driver
#jdbc.connectionURL=jdbc:mysql://yddb01.mysql.database.chinacloudapi.cn:3306/
#jdbc.database=nextstore_apps_test
#jdbc.userId=*******
#jdbc.password=*******
##
#dbc.db=nextstore_apps_test
#primary.key=id
#jdbc.table=sport_app_device_upload_log
#dao.path=com.codoon
#xmlmapper.path=base

xml与配置文件分离好处是可以多个任意工程使用，只需要改通配数据库信息
有以下两种方式运行generator

第一种：运行generator右边mavn的插件

插件

第二种：配置maven 插件命令

编辑Configuration

image.png
新加maven

image.png

添加命令脚本：

mybatis-generator:generate -e

3、mysql8以上版本

升级mysql驱动版本及插件版本

 <mysql.connector.version>8.0.15</mysql.connector.version>

 <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                <!-- 在控制台打印执行日志 -->
                <verbose>true</verbose>
                <!-- 重复生成时会覆盖之前的文件-->
                <overwrite>true</overwrite>
                <!--将当前pom的依赖项添加到生成器的类路径中-->
<!--                <includeCompileDependencies>true</includeCompileDependencies>-->
            </configuration>

            <dependencies>
                <!-- mysql的JDBC驱动 -->
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${mysql.connector.version}</version>
                </dependency>
            </dependencies>
        </plugin>

修改数据库连接，增加时区等。

jdbc.connectionURL=jdbc:mysql://127.0.0.1:3306/longfamily?useSSL=false&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=UTC

mybatis-generator使用