天天看點

Mybatis逆向工程

Mybatis逆向工程

配置說明

<?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 選配,最多配置一個
    用于指定一個需要在配置中解析使用的外部屬性檔案,引入屬性檔案後,可以使用${property}擷取值
    <properties resource="" ></properties> resource:指定classpath下的屬性檔案 eg:folder/generatorConfig.xml
    <properties url=""></properties> url:指定檔案系統上的特定位置 eg:file:///C:/folder/generatorConfig.xml
    -->
    <!-- classPathEntry 選配,可以配置多個
    标簽通過屬性 location 指定驅動路徑
    <classPathEntry location="" />
    -->
    <!--
       context标簽
           id:
           defaultModelType:定義了MBG如何生成實體類,
                可選值:
                    conditionnal:如果一個表的主鍵隻有一個字段,那麼不會為該字段生成單獨的實體類,二是會将該字段合并到基本實體類中
                    flat:為每張表生成一個實體類,該實體類包含表中所有字段
                    hierarchical:
           targetRuntime:指定生成的代碼的運作時環境
                 可選值:
                    Mybatis3:預設值
                    MyBatis3Simple
           introspectedColumnImpl:
    <context id="mysql" defaultModelType="flat">
         0個或多個
        <property name="" value=""></property>
        eg:
        自動給關鍵字添加分隔符
        <property name="autoDelimitKeywords" value="true"></property>
        <property name="beginningDelimiter" value="'"></property>
        <property name="endingDelimiter" value="'"></property>
        0個或多個,配置插件
        <plugin type="org.mybatis.generator.plugins.CachePlugin">
            <property name="" value=""></property>
        </plugin>
        0個或1個,配置如何生成注釋資訊,type有預設值
        <commentGenerator type="">
            阻止生成注釋,預設為false
            <property name="suppressAllComments" value="true"></property>
            阻止生成的注釋包含時間戳,預設為false
            <property name="suppressDate" value="true"></property>
            注釋是否添加資料庫表的備注資訊,預設為false
            <property name="addRemarkComments" value="true"></property>
        </commentGenerator>
        必填,隻能有一個
        <jdbcConnection driverClass="" connectionURL="" userId="" password=""></jdbcConnection>
         0個或1個,指定jdbc類型和java的轉換,type預設值即可
         <javaTypeResolver type="">
            <property name="forceBigDecimals" value="false"></property>
        </javaTypeResolver>
        1個,用于控制生成的實體類
        <javaModelGenerator targetPackage="" targetProject="">
                targetPackage:生成實體類存放的包名
                targetProject:指定目标項目路徑,可以使用絕對路徑或者相對路徑
            <property name="constructorBased" value="true"></property>
                constructorBased為true就會使用構造方法入參,為false使用setter方法入參,預設為false
            <property name="enableSubPackages" value="false"></property>
                enableSubPackages 如果為true,MBG會根據catalog和schema來生成子包,如果為false就會直接使用targetPackage屬性,預設為false
            <property name="immutable" value="false"></property>
                用于配置實體類屬性是否可變,如果為true,不管constructorBased設定,都會使用構造方法入參不會生成setter方法。如果為false實體類屬性可以改變,預設為false
            <property name="rootClass" value="類的全限定名"></property>
                設定所有實體類的基類
            <property name="trimStrings" value="false"></property>
                判斷是否對資料庫查詢結果進行trim操作,預設為false
        </javaModelGenerator>
        最多配置一個,用于配置SQL映射生成器(Mapper.xml)的屬性
        <sqlMapGenerator targetPackage="" targetProject="">
                targetPackage:包名
                targetProject:項目路徑
            <property name="enableSubPackages" value="false"></property>
                enableSubPackages如果為true,MBG會根據catalog和schema來生成子包,為false,就直接用targetPackage屬性,預設為false
        </sqlMapGenerator>
        最多配置一個,用于生成mapper接口
        <javaClientGenerator type="" targetPackage="" targetProject="" implementationPackage=""></javaClientGenerator>
            type:
                MyBatis3:ANNOTATEDMAPPER、MIXEDMAPPER、XMLMAPPER
                MyBtais3Simple:ANNOTATEDMAPPER、XMLMAPPER
            targetPackage:生成mapper接口存放的包名
            targetProject:指定目标項目路徑,絕對路徑或者相對路徑
            implementationPackage:
        <table tableName=""></table>
        // TODO
    </context>
    -->
    <!--指定資料庫驅動路徑-->
    <classPathEntry location="./mysql-connector-java-5.1.40.jar"/>
    <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3Simple">
        <!-- 生成的Java檔案的編碼 -->
        <property name="javaFileEncoding" value="UTF-8" />
        <!-- 格式化java代碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter" />
        <!-- 格式化XML代碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter" />
        <!--添加分隔符-->
        <property name="beginningDelimiter" value="'"></property>
        <property name="endingDelimiter" value="'"></property>
        <!--生成注釋資訊的配置-->
        <commentGenerator>
            <property name="suppressDate" value="true"></property>
            <property name="addRemarkComments" value="true"></property>
        </commentGenerator>
        <!--資料庫連接配接資訊-->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/mybatis"
                userId="root"
                password="19491001">
        </jdbcConnection>
        <!--生成實體類的配置-->
        <javaModelGenerator targetPackage="top.simba1949.common" targetProject="F:/java">
        </javaModelGenerator>
        <!--生成mapper.xml的配置-->
        <sqlMapGenerator targetPackage="top.simba1949.mapper" targetProject="F:/java"></sqlMapGenerator>
        <!--生成mapper接口的配置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="top.simba1949.mapper" targetProject="F:/java"></javaClientGenerator>
        <!--表的配置-->
        <table tableName="%">
            <generatedKey column="id" sqlStatement="mysql"></generatedKey>
        </table>
    </context>
</generatorConfiguration>      

Java 方式生成

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>
    <groupId>top.simba1949</groupId>
    <artifactId>Generator-Java</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.40</version>
        </dependency>
    </dependencies>
</project>      

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>
    <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3Simple">
        <!-- 生成的Java檔案的編碼 -->
        <property name="javaFileEncoding" value="UTF-8" />
        <!-- 格式化java代碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter" />
        <!-- 格式化XML代碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter" />
        <!--添加分隔符-->
        <property name="beginningDelimiter" value="'"></property>
        <property name="endingDelimiter" value="'"></property>
        <!--生成注釋資訊的配置-->
        <commentGenerator>
            <property name="suppressDate" value="true"></property>
            <property name="addRemarkComments" value="true"></property>
        </commentGenerator>
        <!--資料庫連接配接資訊-->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/mybatis"
                userId="root"
                password="19491001">
        </jdbcConnection>
        <!--生成實體類的配置-->
        <javaModelGenerator targetPackage="top.simba1949.common" targetProject="F:/java">
        </javaModelGenerator>
        <!--生成mapper.xml的配置-->
        <sqlMapGenerator targetPackage="top.simba1949.mapper" targetProject="F:/java"></sqlMapGenerator>
        <!--生成mapper接口的配置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="top.simba1949.mapper" targetProject="F:/java"></javaClientGenerator>
        <!--表的配置-->
        <table tableName="%">
            <generatedKey column="id" sqlStatement="mysql"></generatedKey>
        </table>
    </context>
</generatorConfiguration>      

GeneratorMain.java 配置

package top.simba1949.generator;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
/**
 * @author [email protected]
 * @date 2018/8/7 9:57
 */
public class GeneratorMain {
    public static void main(String[] args) throws IOException, XMLParserException, InvalidConfigurationException, SQLException, InterruptedException {
        ArrayList<String> warnings = new ArrayList<String>();
        boolean overWrite = true;
        String path = GeneratorMain.class.getClassLoader().getResource("").getPath();
        File configFile = new File(path + "/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(overWrite);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);
    }
}      

Maven 方式生成

<?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>
    <groupId>top.simba1949</groupId>
    <artifactId>Generator-Maven</artifactId>
    <version>1.0-SNAPSHOT</version>
    <build>
        <plugins>
            <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>
                </configuration>
                <dependencies>
                    <!--配置資料庫驅動-->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.40</version>
                    </dependency>
                </dependencies>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>      

<?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="mysql" defaultModelType="flat" targetRuntime="MyBatis3Simple">
        <!-- 生成的Java檔案的編碼 -->
        <property name="javaFileEncoding" value="UTF-8" />
        <!-- 格式化java代碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter" />
        <!-- 格式化XML代碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter" />
        <!--添加分隔符-->
        <property name="beginningDelimiter" value="'"></property>
        <property name="endingDelimiter" value="'"></property>
        <!--生成注釋資訊的配置-->
        <commentGenerator>
            <property name="suppressDate" value="true"></property>
            <property name="addRemarkComments" value="true"></property>
        </commentGenerator>
        <!--資料庫連接配接資訊-->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/mybatis"
                userId="root"
                password="19491001">
        </jdbcConnection>
        <!--生成實體類的配置-->
        <javaModelGenerator targetPackage="top.simba1949.common" targetProject="F:/java">
        </javaModelGenerator>
        <!--生成mapper.xml的配置-->
        <sqlMapGenerator targetPackage="top.simba1949.mapper" targetProject="F:/java"></sqlMapGenerator>
        <!--生成mapper接口的配置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="top.simba1949.mapper" targetProject="F:/java"></javaClientGenerator>
        <!--表的配置-->
        <table tableName="%">
            <generatedKey column="id" sqlStatement="mysql"></generatedKey>
        </table>
    </context>
</generatorConfiguration>      
Mybatis逆向工程

指令方式

<?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 location="./mysql-connector-java-5.1.40.jar"/>
    <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3Simple">
        <!-- 生成的Java檔案的編碼 -->
        <property name="javaFileEncoding" value="UTF-8" />
        <!-- 格式化java代碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter" />
        <!-- 格式化XML代碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter" />
        <!--添加分隔符-->
        <property name="beginningDelimiter" value="'"></property>
        <property name="endingDelimiter" value="'"></property>
        <!--生成注釋資訊的配置-->
        <commentGenerator>
            <property name="suppressDate" value="true"></property>
            <property name="addRemarkComments" value="true"></property>
        </commentGenerator>
        <!--資料庫連接配接資訊-->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/mybatis"
                userId="root"
                password="19491001">
        </jdbcConnection>
        <!--生成實體類的配置-->
        <javaModelGenerator targetPackage="top.simba1949.common" targetProject="F:/Java">
        </javaModelGenerator>
        <!--生成mapper.xml的配置-->
        <sqlMapGenerator targetPackage="top.simba1949.mapper" targetProject="F:/Java"></sqlMapGenerator>
        <!--生成mapper接口的配置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="top.simba1949.mapper" targetProject="F:/Java"></javaClientGenerator>
        <!--表的配置-->
        <table tableName="%">
            <generatedKey column="id" sqlStatement="mysql"></generatedKey>
        </table>
    </context>
</generatorConfiguration>      
Mybatis逆向工程

指令如下

在終端下使用

java -jar mybatis-generator-core-1.3.7.jar -configfile generatorConfig.xml