Mybatis最入门---代码自动生成（generatorConfig.xml配置）

最新推荐文章于 2022-03-02 21:21:02 发布

y-yg

最新推荐文章于 2022-03-02 21:21:02 发布

阅读量3.7w

点赞数 7

分类专栏： Mybatis 文章标签： mybatis 代码自动生成插件 generator配置

本文链接：https://blog.csdn.net/abcd898989/article/details/51316612

版权

Mybatis 专栏收录该内容

24 篇文章 4 订阅

订阅专栏

[一步是咫尺，一步即天涯]

经过前文的叙述，各位看官是不是已经被Mybatis的强大功能给折服了呢？本文我们将介绍一个能够极大提升我们开发效率的插件：即代码自动生成。这里的代码自动生成包括，与数据库一一对应的实体对象，Mapper基本结构文件，与Mapper对应的基本接口文件。本文，我们只介绍这个插件的基本用法，更多内容，就请读者先自行学习吧。

准备工作：

a.操作系统：win7 x64

b.基本软件：MySQL，Mybatis，SQLyog

-------------------------------------------------------------------------------------------------------------------------------------

第一种方式：通过Main方法执行配置文件。

-------------------------------------------------------------------------------------------------------------------------------------

1.创建本文我们将使用的工程Mybatis13，工程结构图如下：【重点文件我们给出，其他配置文件请读者参考前文工程】

2.修改jdbc.properties文件，具体内容如下：

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis
jdbc.username=root
jdbc.password=1234

3.修改log4j.properties，具体内容如下：

log4j.rootLogger=debug,stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

4.修改mbgConfiguration.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>  
    <properties resource="jdbc.properties" />  
    <context id="sqlserverTables" targetRuntime="MyBatis3">  
        <!-- 生成的pojo，将implements Serializable-->  
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>  
        <commentGenerator>  
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->  
            <property name="suppressAllComments" value="true" />  
        </commentGenerator>  
  
        <!-- 数据库链接URL、用户名、密码 -->  
        <jdbcConnection driverClass="${jdbc.driverClassName}"  
                        connectionURL="${jdbc.url}"  
                        userId="${jdbc.username}"  
                        password="${jdbc.password}">  
        </jdbcConnection>  
  
        <!--    
        默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer  
            true，把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal    
        -->  
        <javaTypeResolver>  
            <property name="forceBigDecimals" value="false" />  
        </javaTypeResolver>  
  
        <!--   
        生成model模型，对应的包路径，以及文件存放路径(targetProject)，targetProject可以指定具体的路径,如./src/main/java，  
        也可以使用“MAVEN”来自动生成，这样生成的代码会在target/generatord-source目录下  
        -->  
        <!--<javaModelGenerator targetPackage="com.joey.mybaties.test.pojo" targetProject="MAVEN">-->  
        <javaModelGenerator targetPackage="com.csdn.ingo.entity" targetProject="./src/main/java">  
            <property name="enableSubPackages" value="true"/>  
            <!-- 从数据库返回的值被清理前后的空格  -->  
            <property name="trimStrings" value="true" />  
        </javaModelGenerator>  
  
        <!--对应的mapper.xml文件  -->  
        <sqlMapGenerator targetPackage="mappers" targetProject="./src/main/resources">  
            <property name="enableSubPackages" value="true"/>  
        </sqlMapGenerator>  
  
        <!-- 对应的Mapper接口类文件 -->  
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.csdn.ingo.dao" targetProject="./src/main/java">  
            <property name="enableSubPackages" value="true"/>  
        </javaClientGenerator>  
  
  
        <!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->  
        <table tableName="userinfo" domainObjectName="UserInfoPO"  
               enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"  
               enableSelectByExample="false" selectByExampleQueryId="false" >  
            <property name="useActualColumnNames" value="false"/>  
        </table>  
    </context>  
</generatorConfiguration>

5.修改GenMain.java文件，具体内容如下：

package com.csdn.ingo.main;

import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
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.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;

public class GenMain {
    public static void main(String[] args) {
        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        String genCfg = "/mbgConfiguration.xml";
        File configFile = new File(GenMain.class.getResource(genCfg).getFile());
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = null;
        try {
            config = cp.parseConfiguration(configFile);
        } catch (IOException e) {
            e.printStackTrace();
        } catch (XMLParserException e) {
            e.printStackTrace();
        }
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = null;
        try {
            myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        } catch (InvalidConfigurationException e) {
            e.printStackTrace();
        }
        try {
            myBatisGenerator.generate(null);
        } catch (SQLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

6.测试方法：运行main方法，然后刷新工程即可。正常情况下：控制台能够看到如下输出，刷新工程后项目列表也能够看到填充文件的变化。

--------------------------------------------------------------------------------------------------------------------------------------------------------

在上面的mbgConfiguration.xml文件中，我们在给出一份更加详细的官方配置地址供读者参考，如下：

【英文版】http://www.mybatis.org/generator/configreference/xmlconfig.html

【中文版】http://generator.sturgeon.mopaas.com/configreference/table.html

--------------------------------------------------------------------------------------------------------------------------------------------------------

第二种方式：通过Maven插件运行。

--------------------------------------------------------------------------------------------------------------------------------------------------------

上面我们的工程是通过maven构建的，mybatis generator中也包含了一个可以集成到Maven的插件，具体做法如下：

1.修改pom.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>com.java.mybatis</groupId>
	<artifactId>mybatis13</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>mybatis13</name>
	<url>http://maven.apache.org</url>

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

	<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.12</version>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.mybatis</groupId>
			<artifactId>mybatis</artifactId>
			<version>3.3.1</version>
		</dependency>
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.26</version>
		</dependency>
		<dependency>
			<groupId>org.mybatis.generator</groupId>
			<artifactId>mybatis-generator-core</artifactId>
			<version>1.3.2</version>
		</dependency>
		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.17</version>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.mybatis.generator</groupId>
				<artifactId>mybatis-generator-maven-plugin</artifactId>
				<version>1.3.2</version>
				<configuration>
					<verbose>true</verbose>
					<overwrite>true</overwrite>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

2.在默认情况下，MBG的配置文件的名称为generatorConfig.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="C:/Users/yyg/Desktop/DevTool/DevTool/repository/Maven/Maven3.2.2/local/repo/mysql/mysql-connector-java/5.1.26/mysql-connector-java-5.1.26.jar" />
		<context id="sqlserverTables" targetRuntime="MyBatis3">
			<!-- 生成的pojo，将implements Serializable -->
			<plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
			<commentGenerator>
				<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
				<property name="suppressAllComments" value="true" />
			</commentGenerator>

			<!-- 数据库链接URL、用户名、密码 -->
			<jdbcConnection driverClass="com.mysql.jdbc.Driver"
				connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root" password="1234">
			</jdbcConnection>

			<!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer true，把JDBC DECIMAL 
				和 NUMERIC 类型解析为java.math.BigDecimal -->
			<javaTypeResolver>
				<property name="forceBigDecimals" value="false" />
			</javaTypeResolver>

			<!-- 生成model模型，对应的包路径，以及文件存放路径(targetProject)，targetProject可以指定具体的路径,如./src/main/java， 
				也可以使用“MAVEN”来自动生成，这样生成的代码会在target/generatord-source目录下 -->
			<!--<javaModelGenerator targetPackage="com.joey.mybaties.test.pojo" targetProject="MAVEN"> -->
			<javaModelGenerator targetPackage="com.csdn.ingo.entity"
				targetProject="./src/main/java">
				<property name="enableSubPackages" value="true" />
				<!-- 从数据库返回的值被清理前后的空格 -->
				<property name="trimStrings" value="true" />
			</javaModelGenerator>

			<!--对应的mapper.xml文件 -->
			<sqlMapGenerator targetPackage="mappers"
				targetProject="./src/main/resources">
				<property name="enableSubPackages" value="true" />
			</sqlMapGenerator>

			<!-- 对应的Mapper接口类文件 -->
			<javaClientGenerator type="XMLMAPPER"
				targetPackage="com.csdn.ingo.dao" targetProject="./src/main/java">
				<property name="enableSubPackages" value="true" />
			</javaClientGenerator>


			<!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->
			<table tableName="userinfo" domainObjectName="UserInfoPO"
				enableCountByExample="false" enableUpdateByExample="false"
				enableDeleteByExample="false" enableSelectByExample="false"
				selectByExampleQueryId="false">
				<property name="useActualColumnNames" value="false" />
			</table>
		</context>
	</generatorConfiguration>

3.运行方法：在eclipse 中，选择pom.xml文件，击右键先择Run AS——>Maven Build… ——>在Goals框中输入：mybatis-generator:generate

--------------------------------------------------------------------------------------------------------------------------------------------------------

对比上面两种方式，博主更加倾向于第一种方式，其main方法每次保持不变，xml配置文件中，也不用关心jdbc配置，每次使用时只需要修改其他关键配置项即可。另外，按照官方文档，我们还能够使用命令行，ant等方式实现上述同样的效果。这里博主只列出这两种方式的示例，更多内容请读者自行实现。

最后，在给出一个小建议：在建表时，字段名称建议用"_"分隔多个单词，比如:AWB_NO、REC_ID...，这样生成的entity，属性名称就会变成漂亮的驼峰命名，即：awbNo、recId

--------------------------------------------------------------------------------------------------------------------------------------------------------

至此，Mybatis最入门---代码自动生成（GeneratorCOnfig.xml配置）结束

参考资料：

官方文档：

http://www.jianshu.com/p/e09d2370b796

http://www.cnblogs.com/yjmyzz/p/4210554.html

y-yg

关注

7
点赞
踩
35

收藏

觉得还不错? 一键收藏
6
评论
Mybatis最入门---代码自动生成（generatorConfig.xml配置）

[一步是咫尺，一步即天涯]经过前文的叙述，各位看官是不是已经被Mybatis的强大功能给折服了呢？本文我们将介绍一个能够极大提升我们开发效率的插件：即代码自动生成。这里的代码自动生成包括，与数据库一一对应的实体对象，Mapper基本结构文件，与Mapper对应的基本接口文件。本文，我们只介绍这个插件的基本用法，更多内容，就请读者先自行学习吧。准备工作：a.操作系统
复制链接

扫一扫