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

最新推荐文章于 2024-09-13 10:58:59 发布
最新推荐文章于 2024-09-13 10:58:59 发布
阅读量3.7w 收藏 35
点赞数 7
分类专栏： Mybatis 文章标签： mybatis 代码自动生成 插件 generator配置
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/abcd898989/article/details/51316612
版权

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

经过前文的叙述，各位看官是不是已经被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
关注
专栏目录
Mybatis Generator自动生成的mapper只有insert方法
孙冉的博客
12-18 734
Mybatis Generator 生成的mapper只有insert方法 首先检查generatorConfig.xml中table项中的属性 enableSelectByPrimaryKey=”true” enableUpdateByPrimaryKey=”true” enableDeleteByPrimaryKey=”true” 看看这几个属性是否设置成了false，默认的值是true。 如...
mybatis自动生成代码配置文件
04-28
mybatis自动生成代码配置文件，通过配置文件详细讲解以生成各层代码。
XML概述
最新发布
qq_74181819的博客
09-13 969
XML概述 ，XML基本语法，用Java操作XML
mybatis-generator 自动生成代码配置
helloloser的博客
04-14 276
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/myb...
generatorConfig.xml
01-07
Mybatis逆向工程的配置文件,通过设置相关配置来快速构建数据库表映射的实体类和接口方法和映射文件
mybatis-generator扩展教程系列 -- 自定义generatorConfig.xml参数
shadowsick的专栏
11-30 8128
今天我打算讲如何在生成器的xml配置文件里加入自定义的参数,真实很多场景我们会遇到需要自定义BaseDAO,BaseService类路径,所以这个时候为了扩展我们会考虑把这些参数放到xml配置,下面就延续使用上一篇的教程项目来做代码示例(如果没有看过之前的环境搭建入门篇可以到文章目录点击进入)1.大家可以先直接打开MyBatisGeneratorConfigurationParser.java这个
15：第二章：架构后端项目：11：使用【mybatis-generator-core】依赖生成实体类、mapper接口、mapper.xml等逆向文件；（我们使用tkmybatis来帮助提升开发效率）
小枯林的博客
06-25 913
使用【mybatis-generator-core】依赖生成实体类、mapper接口、mapper.xml等逆向文件；
mybatis-generator-for-imooc.zip
09-27
综上所述，"mybatis-generator-for-imooc.zip" 提供了一个快速入门MyBatis Generator的资源包，用户只需按照说明解压并配置，就能利用MBG自动化的代码生成功能，提高开发效率，专注于业务逻辑的实现。同时，这个...
Mybatis --- 通用 Mapper 专用代码生成器
xinbumi的博客
08-15 991
MyBatis 通用 Mapper4 通用Mapper都可以极大的方便开发人员。可以随意的按照自己的需要选择通用方法，还可以很方便的开发自己的通用方法。 极其方便的使用MyBatis单表的增删改查。 支持单表操作，不支持通用的多表联合查询。 通用 Mapper 支持 Mybatis-3.2.4 及以上版本。 快速入门 - MyBatis 为什么需要通用 Mapper ? 简介: 在早...
Mybatis---从入门到深化
11-16 479
框架即一个半成品软件。开发者从头开发一个软件需要花费大量精力，于是有一些项目组开发出半成品软件，开发者在这些软件的基础上进行开发，这样的软件就称之为框架。如果将开发完成的软件比作是一套已经装修完毕的新房，框架就好比是一套已经修建好的毛坯房。用户直接购买毛坯房，保证建筑质量和户型合理的同时可以进行风格的自由装修。省去大量的代码编写、减少开发时间、降低开发难度。限制程序员必须使用框架规范开发，增强代码的规范性，降低程序员之间沟通及日后维护的成本。将程序员的注意力从技术中抽离出来，更集中在业务层面。
MyBatis Generator 详解
热门推荐
偶尔记一下 - mybatis.io
12-23 32万+
MyBatis Generator中文文档 MyBatis Generator中文文档地址： http://mbg.cndocs.ml/ 该中文文档由于尽可能和原文内容一致，所以有些地方如果不熟悉，看中文版的文档的也会有一定的障碍，所以本章根据该中文文档以及实际应用，使用通俗的语言来讲解详细的配置。 本文中所有节点的链接都是对应的中文文档地址，可以点击查看详细信息。 注:本文后面提到...
mybatis自动生成配置
上善若水
11-28 262
-->
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值