# mybatis-generatorSqlmapCustom

**Repository Path**: mygit.zhoupan/mybatis-generatorSqlmapCustom

## Basic Information

- **Project Name**: mybatis-generatorSqlmapCustom
- **Description**: MyBatis逆向工程
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-09-29
- **Last Updated**: 2024-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

一 什么是逆向工程<br/>
二 使用MyBatis逆向工程<br/>
- 2.1 新建Maven项目并添加相关依赖(pom.xml)<br/>
- 2.2 MyBatis逆向工程代码编写<br/>
- 2.3 MyBatis逆向工程配置文件以及log4j配置文件编写<br/>
- 2.4 项目执行完成之后的目录结构<br/>

三 总结<br/>


## 一 什么是逆向工程
**官网解释浓缩版：**    
MyBatis逆向工程需要用到的就是MyBatis官方提供的MyBatis Generator（MBG）。MBG是MyBatis和iBATIS的代码生成器，它将为所有版本的MyBatis以及版本2.2.0之后的iBATIS版本生成代码。MBG对简单CRUD（增删改查）的大部分数据库操作产生重大影响。但是您仍然需要为连接查询或存储过程手动编写SQL和对象代码。

**简要概括版：**
创建好数据库表之后，MBG可以根据数据库表自动为您生成pojo类、example类(用于添加条件，相当where语句后面的部分 )、mapper文件。


## 二 使用MyBatis逆向工程
使用MyBatis的逆向工程，需要导入逆向工程的jar包，我用的是mybatis-generator-core-1.3.2.jar，下面开始总结一下MyBatis逆向工程的使用步骤


### 2.1 新建Maven项目并添加相关依赖(pom.xml)：
```xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>mybatis-generator</groupId>
	<artifactId>sql-mapper</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>sql-mapper</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<dependencies>
		<!--log4j -->
		<!-- https://mvnrepository.com/artifact/log4j/log4j -->
		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.17</version>
		</dependency>
		<!--MyBatis Generator -->
		<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core -->
		<dependency>
			<groupId>org.mybatis.generator</groupId>
			<artifactId>mybatis-generator-core</artifactId>
			<version>1.3.5</version>
		</dependency>
		<!--mysql-connector-java -->
		<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.38</version>
		</dependency>
		<!--mybatis -->
		<dependency>
			<groupId>org.mybatis</groupId>
			<artifactId>mybatis</artifactId>
			<version>3.2.1</version>
		</dependency>
	</dependencies>
</project>
```


### 2.2 MyBatis逆向工程代码编写
核心代码官网已经给出，地址为：http://www.mybatis.org/generator/running/runningWithJava.html

核心代码示例(推荐读取xml配置文件的形式，还有一种基于Java的配置这里就不做演示)：
```java
   List<String> warnings = new ArrayList<String>();
   boolean overwrite = true;
   //读取xml配置文件，推荐使用这种方式
   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);
```
本项目中使用代码MyBatisGeneratorApp.java：
````java
import java.io.File;
import java.io.IOException;
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.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;
public class MyBatisGeneratorApp {

	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 {
			MyBatisGeneratorApp generatorSqlmap = new MyBatisGeneratorApp();
			generatorSqlmap.generator();
		} catch (Exception e) {
			e.printStackTrace();
		}
		
	}

}

````
### 2.3 MyBatis逆向工程配置文件以及log4j配置文件编写
MyBatis GeneratorXML参考配置文件官网已经给出，地址为：http://www.mybatis.org/generator/configreference/xmlconfig.html

MyBatis逆向工程配置文件如下（generatorConfig.xml配置文件如下）：
```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" />
			<property name="suppressDate" value="true"/>
		</commentGenerator>
		<!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
		<jdbcConnection driverClass="com.mysql.jdbc.Driver"
			connectionURL="jdbc:mysql://localhost:3306/taotao" userId="root"
			password="1">
		</jdbcConnection>
		<!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和 
			NUMERIC 类型解析为java.math.BigDecimal -->
		<javaTypeResolver>
			<property name="forceBigDecimals" value="false" />
		</javaTypeResolver>

		<!-- targetProject:生成pojo类的位置 -->
		<javaModelGenerator targetPackage="pojo"
			targetProject=".\src\main\java">
			<!-- enableSubPackages:是否让schema作为包的后缀 -->
			<property name="enableSubPackages" value="false" />
			<!-- 从数据库返回的值被清理前后的空格 -->
			<property name="trimStrings" value="true" />
		</javaModelGenerator>

		<!-- targetProject:mapper映射文件生成的位置 -->
		<sqlMapGenerator targetPackage="mapper" targetProject=".\src\main\java">
			<!-- enableSubPackages:是否让schema作为包的后缀 -->
			<property name="enableSubPackages" value="false" />
		</sqlMapGenerator>

		<!-- targetPackage：mapper接口生成的位置 -->
		<javaClientGenerator type="XMLMAPPER"
			targetPackage="mapper" targetProject=".\src\main\java">
			<!-- enableSubPackages:是否让schema作为包的后缀 -->
			<property name="enableSubPackages" value="false" />
		</javaClientGenerator>

		<!-- 指定数据库表 -->
		<!--用百分号表示生成所有表,可以直接省去一个一个写 <table tableName="%" /> -->
		<table schema="" tableName="tb_content"></table>
		<table schema="" tableName="tb_content_category">
		    
		</table>
		<table schema="" tableName="tb_item"></table>
		<table schema="" tableName="tb_item_cat"></table>
		<table schema="" tableName="tb_item_desc"></table>
		<table schema="" tableName="tb_item_param"></table>
		<table schema="" tableName="tb_item_param_item"></table>
		<table schema="" tableName="tb_order"></table>
		<table schema="" tableName="tb_order_item"></table>
		<table schema="" tableName="tb_order_shipping"></table>
		<table schema="" tableName="tb_user"></table>
        
        <!-- 取舍 tableName:用于自动生成代码的数据库表；domainObjectName:对应于数据库表的javaBean类名 --> 
        <table schema="general" tableName="T_USER" domainObjectName="User">
        <!-- 忽略列，不生成bean 字段 -->  
        <!--     <ignoreColumn column="FRED" />   -->
        <!-- 指定列的java数据类型 -->  
        <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> 
        </table>

	</context>
</generatorConfiguration>
```
log4j.properties的配置文件如下：
```
log4j.rootLogger=DEBUG, Console
#Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
log4j.logger.java.sql.ResultSet=INFO
log4j.logger.org.apache=INFO
log4j.logger.java.sql.Connection=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG
```

### 2.4 项目执行完成之后的目录结构
![](http://ww1.sinaimg.cn/large/006movzOly1g2cxazyzb3j309k0993yq.jpg)

pojo及example类： 

![](http://ww1.sinaimg.cn/large/006movzOly1g2cxe9ecmuj30910ewq36.jpg)

mapper接口及mapper.xml:

![](http://ww1.sinaimg.cn/large/006movzOly1g2cxf574cqj309k0eswen.jpg)

## 三 总结
- **什么是逆向工程？**    
MBG可以根据数据库表自动为您生成pojo类、example类(用于添加条件，相当where语句后面的部分 )、mapper文件。
- **如何使用逆向工程？**   
pom文件（添加相关jar包）->逆向工程核心代码编写->创建generatorConfig.xml配置文件(可以加上log4j日志打印配置文件)

mybatis生成工具的帮助文档可以看：   
英文：http://www.mybatis.org/generator/usage/mysql.html    
中文：http://www.mybatis.tk/    
中文：http://mbg.cndocs.tk/ 


作者：SnailClimb <br/>
来源：https://juejin.im/post/5b44ae64f265da0f8145ccab<br/>