SSM-MyBatis【MyBatis Generator的使用】

一、前言

在使用MyBatis框架时，我们通常需要根据表结构创建一个对应的javaBean对象，然后会有实现CRUD功能的接口，最后每个接口都会对应一个配置文件（xxxMapper.xml）。
但是，如果数据库中的表较多时，这个过程就会变得比较繁琐。并且通过思考，我们会发现，这些事情都是重复的，因此，有没有工具能够帮助我们改善这个问题呢？
答案是肯定的。MyBatis Generator就是这样的一个工具。

二、MyBatis Generator是什么？

MyBatis Generator是一个可以用来生成Mybatis dao,entity,Mapper文件的一个工具,在项目的过程中可以省去很多重复的工作,我们只要在MyBatis Generator的配置文件中配置好要生成的表名与包名，然后运行一条命令就会生成一堆文件。

三、MyBatis Generator的简单使用

（一）帮助文档

MyBatis Generator帮助文档
通常我们会使用XML配置文件的方法来进行MyBatis Generator需要的配置。
因此，打开帮助文档后，点击 XML Configuration Reference. 会显示一个基本的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>
  <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />

  <context id="DB2Tables" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="COM.ibm.db2.jdbc.app.DB2Driver"
        connectionURL="jdbc:db2:TEST"
        userId="db2admin"
        password="db2admin">
    </jdbcConnection>

    <javaTypeResolver >
      <property name="forceBigDecimals" value="false" />
    </javaTypeResolver>

    <javaModelGenerator targetPackage="test.model" targetProject="\MBGTestProject\src">
      <property name="enableSubPackages" value="true" />
      <property name="trimStrings" value="true" />
    </javaModelGenerator>

    <sqlMapGenerator targetPackage="test.xml"  targetProject="\MBGTestProject\src">
      <property name="enableSubPackages" value="true" />
    </sqlMapGenerator>

    <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao"  targetProject="\MBGTestProject\src">
      <property name="enableSubPackages" value="true" />
    </javaClientGenerator>

    <table schema="DB2ADMIN" tableName="ALLTYPES" domainObjectName="Customer" >
      <property name="useActualColumnNames" value="true"/>
      <generatedKey column="ID" sqlStatement="DB2" identity="true" />
      <columnOverride column="DATE_FIELD" property="startDate" />
      <ignoreColumn column="FRED" />
      <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />
    </table>

  </context>
</generatorConfiguration>

当然，要在项目中使用，我们需要根据自己的需要进行配置。下面根据案例讲解使用。

（二）快速入门

1、数据库表

假设在数据库ssm_curd中有两张表，分别为tbl_emp和tbl_dept，结构如下：
tbl_emp:
tbl_dept:

2、项目结构

（dao、domain、mapper目录下的内容为已经生成后的，忽略即可！）

3、编写配置文件

在项目根目录下创建一个名为mgb.xml的配置文件，拷贝帮助文档中XML Configuration Reference中的内容到该文件中。
如下：
根据该项目需要修改至如下：

<?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="DB2Tables" targetRuntime="MyBatis3">
        <!--不生成任何注释-->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--配置数据库连接信息-->
        <jdbcConnection
            driverClass="com.mysql.cj.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/ssm_crud?serverTimezone=UTC"
            userId="root"
            password="123456">
        </jdbcConnection>

        <!--Java类型解析器用于根据数据库列信息计算Java类型。
        默认的Java Type Resolver尝试通过尽可能地替换Integral类型（Long，Integer，Short等）
        来使JDBC DECIMAL和NUMERIC类型更易于使用-->
        <javaTypeResolver >
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!--指定javaBean生成的位置-->
        <!--指定存放的包-->
	    <!--指定当前项目路径-->
        <javaModelGenerator
                targetPackage="com.zuobiao.domain"  
                targetProject=".\src\main\java">    
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--指定SQL映射文件(xxxMapper.xml)生成的位置-->
        <sqlMapGenerator
                targetPackage="mapper"
                targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!--指定dao接口(mapper)生成的位置-->
        <javaClientGenerator
                type="XMLMAPPER"
                targetPackage="com.zuobiao.dao"
                targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!--指定每个表的生成策略-->
        <table tableName="tbl_emp" domainObjectName="Employee"/>
        <table tableName="tbl_dept" domainObjectName="Department"/>
    </context>
</generatorConfiguration>

4、运行 MyBatis Generator

通过运行MyBatis Generator，即可生成所需代码。
根据帮助文档可知，运行的方式由多种，通常我们会使用从另一个具有XML配置的Java程序的方式来运行。
此时，只需要打开帮助文档中的 Running MyBatis Generator 选项， 点击 From another Java program with an XML configuration。
会显示如下代码：

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);

我们只需要在项目中创建一个测试类，修改配置文件名并导入相关类，然后运行这些代码即可。

四、总结

对于更多 MyBatis Generator 的详细配置，只需要仔细查看官方的帮助文档即可。
想要通过GUI方式使用 MyBatis Generator，点击此处：mybatis-generator-gui。

Java新手，若有错误，欢迎指正！

赏

都是码农，别客气了