Mybatis中使用mybatis-generator结合Ant脚本快速自动生成Model、Mapper等文件

简介:

使用过Mybatis的同学都知道,针对每一个项目中使用到的数据库表都需要建立其对应的数据库增删改查xxxMapper.xml文件、实体类xxx.java文件以及其他类用来调用进行数据库操作的xxxMapper.java文件。在开始学习Mybatis时,我相信不少人都是通过手动来建立这些文件的。毫无疑问,如果项目比较大的话还通过手动建立这些文件效率是非常低的,这时我们可以通过mybatis-generator来自动生成这些文件。但是,这个工具默认是以命令行的形式来生成相关文件的,因此我们可以通过写一个Ant脚本,每次需要建立这些文件时在eclipse中执行一下这个Ant脚本就可以自动生成了。完整步骤如下:

一 导入相关jar包

要想使用“mybatis-generator”需要在web项目的lib中导入对应的一个mybatis-generator-1.3.x.jar文件,Github上的下载地址:mybatis-generator的jar包下载

二 配置mybatis-generator的配置文件

(1)首先在项目中新建几个包用于存放对应的文件:

wKioL1c4GwWT7LbbAABGJG6JwXc356.png

由上图可以看出,src/main/java用于存放Java源代码;src/main/env/dev用于存放开发环境下的配置文件(如:jdbc,缓存,日志等);src/main/resources用于存放通用的一些配置文件,在这里我们自动生成的Mapper.xml文件就存放在这个路径下;src/test/java表示测试代码,这里不管

注:如何在eclipse中添加这些源文件夹?

wKioL1c4GyaAKG7JAAEw43WIEzI818.png

(2)在项目根目录下新建generatorConfig.xml和build_mybatis.xml:

这两个文件分别是“mybatis-generator”的配置文件和自动化的Ant脚本,在项目中的路径如下:

wKiom1c4GmKCFQa8AAAtgsRnYb8301.png

i)generatorConfig.xml:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
<? 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 = "WebContent/WEB-INF/lib/mysql-connector-java-5.1.26-bin.jar"  />
 
     < context  id = "DB2Tables"  targetRuntime = "MyBatis3" >
         < commentGenerator >
             < property  name = "suppressAllComments"  value = "true"  /> <!-- 是否取消注释 -->
             < property  name = "suppressDate"  value = "true"  />  <!-- 是否生成注释代时间戳 -->
         </ commentGenerator >
         <!-- 数据库连接信息 -->
         < jdbcConnection  driverClass = "com.mysql.jdbc.Driver"
             connectionURL = "jdbc:mysql://127.0.0.1:3306/ehcache_db"  userId = "root"
             password = "root" >
         </ jdbcConnection >
 
         <!-- 只有一个属于forceBigDecimals,默认false。 如果字段精确超过0,生成BigDecimal 如果字段精确是0,总长度10-18生成Long;如果字段精确是0, 
             总长5-9生成Integer; 如果字段精确是0,总长小于5生成Short; 如果forceBigDecimals为true,统一生成BigDecimal -->
         < javaTypeResolver >
             <!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) -->
             < property  name = "forceBigDecimals"  value = "false"  />
         </ javaTypeResolver >
 
         <!--生成Model.java文件 -->
         < javaModelGenerator  targetPackage = "cn.zifangsky.model"
             targetProject = "src/main/java" >
             <!-- enableSubPackages:是否让schema作为包的后缀 -->
             < property  name = "enableSubPackages"  value = "false"  />
             <!-- 是否针对string类型的字段在set的时候进行trim调用 -->
             < property  name = "trimStrings"  value = "true"  />
         </ javaModelGenerator >
 
         <!-- 生成Mapper.xml文件 -->
         < sqlMapGenerator  targetPackage = "sqlmaps"
             targetProject = "src/main/resources" >
             <!-- enableSubPackages:是否让schema作为包的后缀 -->
             < property  name = "enableSubPackages"  value = "false"  />
         </ sqlMapGenerator >
 
         <!-- 生成Mapper.java文件,即dao层 -->
         < javaClientGenerator  type = "XMLMAPPER"
             targetPackage = "cn.zifangsky.mapper"  targetProject = "src/main/java" >
             < property  name = "enableSubPackages"  value = "false"  />
         </ javaClientGenerator >
         
         <!-- 待生成的数据库中的表名,生成一个表对应的Java和xml文件就需要配置一段 -->
         < table  tableName = "user"  domainObjectName = "User"
             enableCountByExample = "false"  enableUpdateByExample = "false"
             enableDeleteByExample = "false"  enableSelectByExample = "false"
             selectByExampleQueryId = "false" >
         </ table >
     </ context >
</ generatorConfiguration >

注:需要修改的一些地方可以参照我上面的注释进行修改,同时别忘了数据驱动的jar包

ii)build_mybatis.xml:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
< project  default = "genfiles"  basedir = "." >
     < property  name = "generated.source.dir"  value = "${basedir}"  />
     
        < path  id = "ant.run.lib.path" >
              < pathelement  location = "${basedir}/WebContent/WEB-INF/lib/mybatis-generator-core-1.3.2.jar" />
        </ path >
     
     < target  name = "genfiles"  description = "Generate the files" >
         < taskdef  name = "mbgenerator"  classname = "org.mybatis.generator.ant.GeneratorAntTask"   classpathref = "ant.run.lib.path" />
         < mbgenerator  overwrite = "true"  configfile = "generatorConfig.xml"  verbose = "false" >
             < propertyset >
                 < propertyref  name = "generated.source.dir"  />
             </ propertyset >
         </ mbgenerator >
     </ target >
</ project >

上面的代码就两个地方需要注意:一是“mybatis-generator”的jar包,二是需要对应的“generatorConfig.xml”文件

注:如果对Ant脚本不太熟悉的话,可以参考下我写的这篇文章:http://www.zifangsky.cn/444.html

三 测试

wKiom1c4Gq2z4AHJAABkKWMktKM529.png

进行效果测试时,只需要把“build_mybatis.xml”这个文件拖到Ant视图中,然后点击执行这个脚本就可以自动生成我们需要的文件了,最后就是刷新一下项目结构就可以看到文件了,效果如下:

wKioL1c4G7yCHFnZAAA-sWYpPxc552.png

注:我测试使用到的数据库数据:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
SET  FOREIGN_KEY_CHECKS=0;
 
-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP  TABLE  IF EXISTS ` user `;
CREATE  TABLE  ` user ` (
   `id`  int (11)  NOT  NULL  AUTO_INCREMENT,
   ` name varchar (32)  DEFAULT  NULL ,
   ` password varchar (64)  DEFAULT  NULL ,
   `email`  varchar (64)  DEFAULT  NULL ,
   `birthday`  date  DEFAULT  NULL ,
   PRIMARY  KEY  (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4  DEFAULT  CHARSET=utf8;
 
-- ----------------------------
-- Records of user
-- ----------------------------
INSERT  INTO  ` user VALUES  ( '1' 'admin' '123456' 'admin@qq.com' '2000-01-02' );
INSERT  INTO  ` user VALUES  ( '2' 'test' '1234' 'test@zifangsky.cn' '1990-12-12' );
INSERT  INTO  ` user VALUES  ( '3' 'xxxx' 'xx' 'xx@zifangsky.cn' '1723-06-21' );



本文转自 pangfc 51CTO博客,原文链接:http://blog.51cto.com/983836259/1773597,如需转载请自行联系原作者
相关文章
|
2月前
|
SQL Java 数据库连接
mybatis使用四:dao接口参数与mapper 接口中SQL的对应和对应方式的总结,MyBatis的parameterType传入参数类型
这篇文章是关于MyBatis中DAO接口参数与Mapper接口中SQL的对应关系,以及如何使用parameterType传入参数类型的详细总结。
45 10
|
4月前
|
SQL Java 数据库连接
Mybatis系列之 Error parsing SQL Mapper Configuration. Could not find resource com/zyz/mybatis/mapper/
文章讲述了在使用Mybatis时遇到的资源文件找不到的问题,并提供了通过修改Maven配置来解决资源文件编译到target目录下的方法。
Mybatis系列之 Error parsing SQL Mapper Configuration. Could not find resource com/zyz/mybatis/mapper/
|
3月前
|
SQL XML Java
mybatis :sqlmapconfig.xml配置 ++++Mapper XML 文件(sql/insert/delete/update/select)(增删改查)用法
当然,这些仅是MyBatis功能的初步介绍。MyBatis还提供了高级特性,如动态SQL、类型处理器、插件等,可以进一步提供对数据库交互的强大支持和灵活性。希望上述内容对您理解MyBatis的基本操作有所帮助。在实际使用中,您可能还需要根据具体的业务要求调整和优化SQL语句和配置。
58 1
|
5月前
|
SQL Java 数据库连接
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
idea中配置mybatis 映射文件模版及 mybatis plus 自定义sql
98 3
|
4月前
|
XML Java 数据库连接
Mybatis 模块拆份带来的 Mapper 扫描问题
Mybatis 模块拆份带来的 Mapper 扫描问题
47 0
|
5月前
|
SQL
自定义SQL,可以利用MyBatisPlus的Wrapper来构建复杂的Where条件,如何自定义SQL呢?利用MyBatisPlus的Wrapper来构建Wh,在mapper方法参数中用Param注
自定义SQL,可以利用MyBatisPlus的Wrapper来构建复杂的Where条件,如何自定义SQL呢?利用MyBatisPlus的Wrapper来构建Wh,在mapper方法参数中用Param注
|
2月前
|
Java 数据库连接 Maven
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和MyBatis Generator,使用逆向工程来自动生成Java代码,包括实体类、Mapper文件和Example文件,以提高开发效率。
126 2
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
|
2月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
65 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
2月前
|
前端开发 Java Apache
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
本文详细讲解了如何整合Apache Shiro与Spring Boot项目,包括数据库准备、项目配置、实体类、Mapper、Service、Controller的创建和配置,以及Shiro的配置和使用。
425 1
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
|
2月前
|
SQL Java 数据库连接
mybatis使用二:springboot 整合 mybatis,创建开发环境
这篇文章介绍了如何在SpringBoot项目中整合Mybatis和MybatisGenerator,包括添加依赖、配置数据源、修改启动主类、编写Java代码,以及使用Postman进行接口测试。
21 0
mybatis使用二:springboot 整合 mybatis,创建开发环境