mybatis逆向工程

原文連接：https://www.cnblogs.com/shanheyongmu/p/5863961.html

1. 什麼是逆向工程

　　mybatis的一個主要的特色就是須要程序員本身編寫sql，那麼若是表太多的話，不免會很麻煩，因此mybatis官方提供了一個逆向工程，能夠針對單表自動生成mybatis執行所須要的代碼（包括mapper.xml、mapper.Java、po..）。通常在開發中，經常使用的逆向工程方式是經過數據庫的表生成代碼。

2. 使用逆向工程

　　使用mybatis的逆向工程，須要導入逆向工程的jar包，我用的是mybatis-generator-core-1.3.2，已經上傳到下載頻道了（點我下載），下面開始總結一下mybatis逆向工程的使用步驟。

2.1 新建一個工程（重要）

　　咱們要新建一個java工程，這個工程專門用來使用逆向工程生成代碼的。有些人可能會問，爲何要新建一個工程呢？直接在原來工程中你想生成不就能夠了麼？確實是這樣，能夠在原來的工程中生成，可是有風險，由於mybatis是根據配置文件來生成的（下面會說到），若是生成的路徑中有相同的文件，那麼就會覆蓋原來的文件，這樣會有風險。因此開發中通常都會新建一個java工程來生成，而後將生成的文件拷貝到本身的工程中，這也不麻煩，並且很安全。以下： 
 
　　從上圖中看，1就是要執行的java代碼，執行它便可生成咱們須要的代碼；2是執行過程當中新建的包，這個包均可以在4的配置文件中指定，最好是跟咱們本身項目的包名一致，後面就能夠直接拷貝了，就不須要修改包名了；3就是jar包咯；4是配置文件。下面會詳細分析。

2.1 生成代碼的配置文件

　　mybatis逆向工程生成代碼須要一個配置文件，名字隨便起。而後mybatis會根據這個配置文件中的配置，生成相應的代碼。下載好了jar包後，裏面有幫助文檔，打開后里面有配置文件的模板，這裏就再也不贅述了，下面先把配置文件寫好：

 

<?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="testTables" targetRuntime="MyBatis3">
        <commentGenerator>
            <!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        <!--數據庫鏈接的信息：驅動類、鏈接地址、用戶名、密碼 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root"
            password="root">
        </jdbcConnection>
        <!-- <jdbcConnection driverClass="oracle.jdbc.OracleDriver"
            connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:yycg" 
            userId="yycg"
            password="yycg">
        </jdbcConnection> -->

        <!-- 默認false，把JDBC DECIMAL 和 NUMERIC 類型解析爲 Integer，爲 true時把JDBC DECIMAL和NUMERIC類型解析爲java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- targetProject:生成PO類的位置，重要！！ -->
        <javaModelGenerator targetPackage="mybatis.po"
            targetProject=".\src">
            <!-- enableSubPackages:是否讓schema做爲包的後綴 -->
            <property name="enableSubPackages" value="false" />
            <!-- 從數據庫返回的值被清理先後的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置，重要！！ -->
        <sqlMapGenerator targetPackage="mybatis.mapper" 
            targetProject=".\src">
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- targetPackage：mapper接口生成的位置，重要！！ -->
        <javaClientGenerator type="XMLMAPPER"
            targetPackage="mybatis.mapper" 
            targetProject=".\src">
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
        <!-- 指定數據庫表，要生成哪些表，就寫哪些表，要和數據庫中對應，不能寫錯！ -->
        <table tableName="items"></table>
        <table tableName="orders"></table>
        <table tableName="orderdetail"></table>
        <table tableName="user"></table>        
    </context>
</generatorConfiguration>

 

　從上面的配置文件中能夠看出，配置文件主要要作的幾件事是：

1. 鏈接數據庫，這是必須的，要否則怎麼根據數據庫的表生成代碼呢？
2. 指定要生成代碼的位置，要生成的代碼包括po類， mapper.xml和mapper.java
3. 指定數據庫中想要生成哪些表

2.3 執行生成程序

　　配置文件搞好了，而後就執行如下生成程序便可生成了，生成的java程序，下載的逆向工程文檔中都有示例，以下：

 

public class GeneratorSqlmap {

    public void generator() throws Exception{

        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        //指向逆向工程配置文件
        File configFile = new File("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);

    } 
    public static void main(String[] args) throws Exception {
        try {
            GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
            generatorSqlmap.generator();
        } catch (Exception e) {
            e.printStackTrace();
        }

    }

}

 

運行一下便可，運行完了後刷新一下工程，就能夠看到最新生成的代碼了。 
 
　　這裏能夠看出有個細節，每一個po類多了一個東西，就是xxxExample.java，這個類是給用戶自定義sql是用的，後面我會提到。到這裏就生成好了，下面咱們就把生成的代碼拷貝到本身的工程使用了，爲了簡便，這裏我就拷貝ItemsMapper.java/ItemsMapper.xml/Items.java/ItemsExample.java這一類的，其餘都同樣。