Mybatis系列(五)：mybatis逆向工程

一、背景        

        在實際開發中我們會自己去寫mapper映射文件，接口，數據庫表對應的實體類，如果需求任務比較少，咱們還可以慢慢的一個一個去寫，但是這是不現實的，因為在工作中我們的任務是很多的，這時mybatis逆向工程就能幫助我們節省這部分的時間了，因為mybatis逆向工程能根據數據庫的表結構生成對應的mapper映射文件，接口，實體類

二、實踐

1. 新建一個mybatis逆向工程測試的項目MybatisReverseProject和生成文件存放的項目MybatisTest，使用的mybatis-generator-core是借鑒githup上的一個兄弟改寫源碼的，他的已經能滿足我的需求了，有需要的同學可以自己去改寫，改寫內容如下：

             生成的*mapper.xml文件中使用4個空格來縮進
             生成的*mapper.xml文件中每個元素間增加一空行，如insert,update,delete等之間增加一空行
             去掉*mapper.xml文件中生成的注釋
             根據數據庫表名及字段的注釋為Java類、屬性增加注釋，可以在源碼org.mybatis.generator.internal.db.DatabaseIntrospector.java類中根據個人情況進行修改
             實現每次生成都覆蓋生成文件

 

         

     

 2.在數據庫里面建立需要使用的表

CREATE TABLE `t_user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(30) NOT NULL COMMENT '用戶名稱',
  `birthday` date DEFAULT NULL COMMENT '生日',
  `sex` char(2) DEFAULT NULL COMMENT '性別',
  `address` varchar(256) DEFAULT NULL COMMENT '地址',
  PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=5 DEFAULT CHARSET=utf8 COMMENT='用戶信息表';

3. 在generatorConfig.xml文件中配置數據庫連接的信息，配置生成實體類的位置、生成mapper映射文件生成的位置、生成mapper接口生成的位置，以上配置的3個路徑為你項目的路徑；指定要逆向生成代碼的數據庫的表

<?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="false" />
        </commentGenerator>
        <!--數據庫連接的信息：驅動類、連接地址、用戶名、密碼 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/study" userId="root"
            password="123456">
        </jdbcConnection> 
        <!-- 默認false，把JDBC DECIMAL 和 NUMERIC 類型解析為 Integer，為 true時把JDBC DECIMAL 
            和 NUMERIC 類型解析為java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- targetProject:生成實體類的位置 -->
        <javaModelGenerator targetPackage="com.study.mybatis.entiy"
            targetProject="D:\workspace\MybatisTest\src\main\java">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
            <!-- 從數據庫返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="com.study.mybatis.mapper"
            targetProject="D:\workspace\MybatisTest\src\main\java">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- targetPackage：mapper接口生成的位置 -->
        <javaClientGenerator type="XMLMAPPER"
            targetPackage="com.study.mybatis.dao" targetProject="D:\workspace\MybatisTest\src\main\java">
            <!-- enableSubPackages:是否讓schema作為包的后綴 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!-- 指定數據庫表 -->
        <table tableName="t_user" schema="" enableCountByExample="false"
            enableDeleteByExample="false" enableUpdateByExample="false"
            enableSelectByExample="false" selectByExampleQueryId="false"></table>

        <!-- 有些表的字段需要指定java類型 <table schema="" tableName=""> <columnOverride column="" 
            javaType="" /> </table> -->
    </context>
</generatorConfiguration>

4. 啟動主程序GeneratorSqlmap.java生成需要的文件

package com.lgs.reverse.start;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

/**
 * 根據數據庫定義的表結構生成實體類、接口、mapper映射文件的主類
 * 使用的mybatis-generator-core是借鑒githup上的一個兄弟改寫源碼的， 他的已經能滿足我的需求了有需要的同學可以自己去改寫
 * 
 * @author lgs
 *
 */
public class GeneratorSqlmap {

    public void generator() throws Exception {

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

    }

}

5. 需要完整項目的同學可以去我的githup上下載，下載地址https://github.com/leeSmall/MybatisReverseProject