使用Mybatis逆向工程生成XML和Java文件

       Mybatis作为一个半自动化的ORM框架，需要开发人员手动编写Sql语句。当数据库中的表格太多的时候，为每一个表格的CRUD操作编写Sql语句就显得十分的繁琐。Mybatis逆向工程可以针对单表自动生成所需要的代码，比如mapper.xml映射文件，dao.java持久层接口，以及pojo实体类。

       首先，创建一个新的java工程，名叫Mybatis-Generator，不建议在原来的项目中生成逆向工程代码，因为会覆盖原来的代码，因此通常开发者都选择新建一个项目专门用来生成逆向工程，再将需要的文件拷贝到自己的项目中去。然后导入三个jar包，分别是mybatis，mybatis-generator和mysql的jar包。同时，构建好三个包，分别是dao包用来存放生成的*dao.java文件，entity包用来存放实体类，mapper包用来存放生成的*mapper.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="testTables" targetRuntime="MyBatis3">
        <commentGenerator>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/jtsys" 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="com.jt.entity"
            targetProject=".\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="com.jt.mapper" 
            targetProject=".\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- targetPackage：mapper接口生成的位置 -->
        <javaClientGenerator type="XMLMAPPER"
            targetPackage="com.jt.dao" 
            targetProject=".\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
        <!-- 指定数据库表 -->
        <table schema="" tableName="sys_configs"></table>
        <table schema="" tableName="sys_depts"></table>
        <table schema="" tableName="sys_dicts"></table>
        <table schema="" tableName="sys_logs"></table>
        <table schema="" tableName="sys_menus"></table>
        <table schema="" tableName="sys_role_menus"></table>
        <table schema="" tableName="sys_roles"></table>
        <table schema="" tableName="sys_user_roles"></table>
        <table schema="" tableName="sys_users"></table>

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

       配置完毕，编写一个java类用来启动这些配置，生成逆向工程代码。

package com.jt.generator;

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;

public class GeneratorSqlMapper {
	public void generator() throws Exception{

        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        //指定 逆向工程配置文件
        File configFile = new File("config.xml"); 
        ConfigurationParser cp = new ConfigurationParser(warnings);
        //将配置文件的信息转化为Configuration对象
        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 {
        	System.out.println("here");
            GeneratorSqlMapper generatorSqlmapper = new GeneratorSqlMapper();
            generatorSqlmapper.generator();
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

       运行之后，刷新项目可以看到我们需要的文件都生成在对应包中，此处的*Mapper.java文件就是我们需要的持久层接口。

       此处对应数据库中的每一张表格有生成了两个.java文件，名字较短的是与数据库表格完全对应的实体类对象，即类中属性和数据库中的字段名完全对应。*Example.java是针对单一表格的CRUD操作进行了封装，通过这个类里的方法，我们可以更方便地自定义对数据库的操作，例如去重复查询、降序升序、针对单一字段的操作等等。

       

       以下是映射文件。

       虽然逆向工程为开发人员提供了一些方便，不需要自行编写实体类对象，生成了我们需要的dao接口和映射文件。但是可以逆向工程生成的文件中只涉及到了但以表格的操作，实际项目中往往会涉及到多个关联表格的联合操作，还有一些涉及到复杂业务的情况，这时候仍然需要开发人员自行编写Sql语句。