一、MyBatis Generator (MBG) 简介
Mybatis Generator是MyBatis和ibatis的代码生成器。主要生成如下:
(1)与表结构匹配的Java POJO(字段名对应属性)【javabean类】
(2)SQL映射XML文件(文件为配置中每个表上的简单CRUD(增删改查)函数生成SQL。)【beanMapper.xml】
(3)符合Spring框架的DAO接口java类【beanMapper.java】
二、配置MBG
1、搭建数据库
tbl_employee表【d_id 是外键 对应 tbl_dept表】
id last_name gender email d_id
1 mike 0 [email protected] 1
2 book 0 [email protected] 2
3 tom 1 [email protected] 2
4 jerry 1 [email protected] 1
tbl_dept表:
id dept_name
1 开发部
2 测试部
2、项目需要jar包:
总共需要导入项目的jar包就三个
mybatis.jar
mybatis-generator-core.jar
mysql-connector.jar
3、自动生成代码的配置文件
mbg.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>
<!--
targetRuntime="MyBatis3Simple":生成简单版的CRUD
MyBatis3:豪华版
-->
<context id="testTables" targetRuntime="MyBatis3">
<commentGenerator>
<!-- 是否去除自动生成的注释 true:是 : false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--数据库连接的信息:驱动类、连接地址、用户名、密码 -->
<!-- jdbcConnection:指定如何连接到目标数据库 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mybatis?allowMultiQueries=true"
userId="root"
password="Cool123!">
</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.mybatis.bean"
targetProject="./src">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
<!-- 从数据库返回的值被清理前后的空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- targetProject:mapper映射文件生成的位置 -->
<sqlMapGenerator targetPackage="com.mybatis.mapper"
targetProject="./conf">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- targetPackage:mapper接口生成的位置 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.mybatis.mapper"
targetProject="./src">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<!-- 指定要逆向分析哪些表:根据表要创建javaBean -->
<table tableName="tbl_dept" domainObjectName="Department"></table>
<table tableName="tbl_employee" domainObjectName="Employee"></table>
</context>
</generatorConfiguration>
注意:mbg配置文件中,对各标签有顺序要求。先javaModelGenerator
后
sqlMapGenerator
最后 javaClientGenerator
4、执行代码自动生成文件
新建包 com.mybatis.test
,并在下面创建 Junit 测试类 MybatisTest.java
package com.mybatis.test;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.junit.Test;
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 MybatisTest {
@Test
public void testMbg() throws Exception {
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
File configFile = new File("mbg.xml");// mbg.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);
}
}
生成代码遇到的问题:
1、mbg.xml 必须 放在项目根目录,不能放在 src目录下或者其他目录下。
//因为在自动 生成代码过程中,需要读取 mbg.xml 配置文件,路径需要匹配
File configFile = new File("mbg.xml");// mbg.xml为上面创建的配置文件。
2、报错找不到 : java.time 类,因为这个是java8 的,当前是jdk7代码环境。
java.lang.NoClassDefFoundError: java/time/temporal/TemporalAccessor
at java.lang.Class.forName0(Native Method)
at java.lang.Class.forName(Class.java:278)
at org.mybatis.generator.internal.ObjectFactory.internalClassForName(ObjectFactory.java:142)
at org.mybatis.generator.internal.ObjectFactory.createInternalObject(ObjectFactory.java:178)
3、Mybatis Generator代码不报错,但是没有生成文件
比如:之前是 targetProject=”.\src” 适用于windows,在当前目录的src创建文件。
targetProject=”./src” 适用于 linux ,在当前目录的 src 创建文件。
【Windows 无法识别 ./ 同理 linux 也无法识别 .\】
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.mybatis.mapper"
targetProject=".\src">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
MBG 配置目录的时候 targetProject=“./src” 需要知道 是windows环境还是mac环境。主要是 目录设置问题。windows环境:.\ mac环境:./
当然目录可以去掉前面./或.\ 直接开始写文件夹就行了,这样子 mac和windows都可以运行了。