mybatis根據(jù)表逆向自動化生成代碼的實現(xiàn)

更新時間：2021年08月30日 10:22:13 作者：---蔥---

若采用mybatis框架，數(shù)據(jù)庫新建表，手動編寫的話，需要編寫大量的實體類、mapper文件、mapper.xml文件，都是一些重復(fù)且有規(guī)律的工作。我們可以引用插件，然后做配置，自動生成這些文件，本文就來詳細的介紹一下

1.引入插件

　　在項目的pom文件中引入generator插件

<plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <!-- 配置文件存放路徑 -->
                    <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <!-- mysql -->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.46</version>
                    </dependency>
                    <!-- mapper -->
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>3.4.1</version>
                    </dependency>
                </dependencies>
            </plugin>

2.修改generatorConfig.xml文件

　　注：generatorConfig.xml 一定要放在pom中插件配置的路徑下。

　　下面給出配置文件中的代碼，代碼中都有注釋。主要注意的點有：

　?、賘dbc連接數(shù)據(jù)庫的路徑

　?、谏蓪嶓w類存放的路勁

　?、凵蒻apper.xml存放的路勁

　?、苌蒻apper文件的存放路徑

　?、菪薷谋硪约霸摫韺?yīng)的實體類名稱

<?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>
    <!--classPathEntry:數(shù)據(jù)庫的JDBC驅(qū)動,換成你自己的驅(qū)動位置 可選 -->
    <!--    <classPathEntry location="F://jdbc//mysql-connector-java-8.0.18.jar"/>-->

    <!-- 一個數(shù)據(jù)庫一個context -->
    <context id="DB2Tables" targetRuntime="Mybatis3">
        <!-- 自動識別數(shù)據(jù)庫關(guān)鍵字，默認false，如果設(shè)置為true，根據(jù)SqlReservedWords中定義的關(guān)鍵字列表；一般保留默認值，遇到數(shù)據(jù)庫關(guān)鍵字（Java關(guān)鍵字），使用columnOverride覆蓋 -->
        <property name="autoDelimitKeywords" value="true"/>
        <!-- 生成的Java文件的編碼 -->
        <property name="javaFileEncoding" value="utf-8"/>
        <!-- beginningDelimiter和endingDelimiter：指明數(shù)據(jù)庫的用于標記數(shù)據(jù)庫對象名的符號，比如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"/>

        <!-- 配置 tk.mybatis 插件 -->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="com.glsx.plat.mybatis.mapper.CommonBaseMapper"/>
        </plugin>

        <!--配置生成注釋信息，最多配置一個 -->
        <commentGenerator>
            <!-- 阻止生成注釋包含時間戳 默認為false -->
            <property name="suppressDate" value="true"/>
            <!-- 注釋是否添加數(shù)據(jù)庫表的備注信息 默認為false -->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
        <!-- jdbc連接-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3307/test?serverTimeZone=Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false"
                        userId="root"
                        password="root">
            <!--防止生成其他庫同名表-->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>
        <!-- 類型轉(zhuǎn)換 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自動轉(zhuǎn)化以下類型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成實體類地址 -->
        <javaModelGenerator targetPackage="cn.com.glsx.admin.modules.entity" targetProject="src/main/java">
            <!-- 是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="true"/>
            <!-- 從數(shù)據(jù)庫返回的值去掉前后空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成mapper.xml文件存放地址 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 生成接口dao  type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper對象 type="MIXEDMAPPER",　　　　　　　　生成基于注解的Java Model 和相應(yīng)的Mapper對象 type="XMLMAPPER",生成SQLMap XML文件和獨立的Mapper接口 -->
        <javaClientGenerator targetPackage="cn.com.glsx.admin.modules.mapper" targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- table可以有多個,每個數(shù)據(jù)庫中的表都可以寫一個table，tableName表示要匹配的數(shù)據(jù)庫表,也可以在tableName屬性中通過使用%通配符來匹配所有數(shù)據(jù)庫表,　　　　　　　　只有匹配的表才會自動生成文件 enableSelectByPrimaryKey相應(yīng)的配置表示是否生成相應(yīng)的接口 -->
        <table tableName="d_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
　　　　<table tableName="d_student" domainObjectName="Student" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context> 
</generatorConfiguration>