前言
- mybatis-generator 被称为“数据库逆向框架生成器”,它可以根据数据库的表结构来逆向生成持久层的代码,常见的用法是生成Model,Dao,Mapper.xml
mybatis-generator 代码生成可归纳为三步:
1. 获取依赖jar:
mybatis-generator-core-1.3.5.jar(代码生成核心包 必选)
mysql-connector-java-5.1.34-bin.jar(数据库连接驱动包 必选)
mybatis-3.2.2.jar(mybatis核心依赖包 可选)
2. 配置生成所需的GeneratorXML文件, 定义该配置文件至少需定义以下5步:
1. (必须)<jdbcConnection> 配置数据库连接
2. (必须)<javaModelGenerator>配置生成实体
3. (必须) <sqlMapGenerator>配置实体XML
4. (可选)<javaClientGenerator>配置生成的接口类,如果,你不打算生成Dao,可以省略
5. <table> 用来配置实体对应的数据库表,该标签至少配置一个
顺序必须为<jdbcConnection>
—><javaModelGenerator>
—><sqlMapGenerator>
—><javaClientGenerator>
—><table>
不能跌到
3. 调用配置文件。
1. Eclipse插件调用
2. 命令行调用
3. java类直接调用
4. Maven插件调用
方式一:Eclipse 安装MyBatis-Generator 插件
步骤如下:
1. 安装插件
在Eclipse中选择Help ——>Eclipse Marketplace… ——>搜索Mybatis-generator并安装 ——>安装成功后,重启Eclipse
2. 为项目创建GeneratorXML(本示例为GeneratorConfigEclipse.xml)
在Eclipse中选择项目的资源文件夹,右击 ——>New ——>MyBatis Generator Configuration File
3. 右击GeneratorConfigEclipse.xml生成代码
在新创建的文件GeneratorConfigEclipse.xml上面右击——>Generate MyBatis/iBATIS Artifacts 即可生成代码
说明:
- 项目中已包含上述提到的Jar,否则会报错
- GeneratorConfigEclipse.xml 中target配置不可以使用相对路径,比如:./src/…. 必须使用项目名称开头+反斜杠的形式,例如,mbg\src….
方式二:命令行生成
说明:
- src文件夹用来放置新生成的代码,可以随便命名,更名后,配置文件也需要做改动
- mybatis-generator-core-1.3.5.jar 代码生成依赖包
- mysql-connector-java-5.1.34-bin.jar 数据库连接驱动包
- 打开cmd窗口进入当前文件夹后,执行命令:java -jar mybatis-generator-core-1.3.5.jar -configfile generatorConfig.xml -overwrite
命令行demo下载
方式三:java代码生成
该种方式同【方式一】有些类似,须有java项目做支持,不同的是,生成调用,是通过直接运行java类实现的,而非在配置文件上右击。
本示例运行GeneratorMybatis类的main方法,即可生成,具体配置见下文的Demo示例。
方式四:Maven插件生成
同【方式一】 一样,须有java项目作为支持,不同之处是,生成调用,是通过在pom.xml 右击执行Maven命令来完成。
本示例,选择pom.xml文件,右键先择Run AS——>Maven Build… ——>在Goals框中输入:mybatis-generator:generate 具体介绍见下文demo。
方式一、三、四合并Demo下载
基于方式一、三、四都需要依托java项目,故合并提供一个demo示例,项目结构如下:
1. GeneratorConfigEclipse.xml:方式一调用MyBatis GeneratorXML
2. generatorConfigJava.xml:方式三、四调用 MyBatis GeneratorXML
【1】和【2】的区别,仅在于在于MyBatis GeneratorXML 中targetProject和 location 这两个属性对于路径的配置,方式一,必须是项目名+\形式,不可以使用相对路径。而方式二,不做要求都可以使用,即generatorConfigJava.xml 可为方式一,三,四通用。
3. pom.xml 是maven调用时,必要XML,其中mybatis-generator-maven-plugin 为生成依赖的必要插件,必须配置。
附录:
mybatis-generator 官网:
http://www.itgo.me/a/x354411721311961992/mybatis
GeneratorXML官方配置及说明如下:
http://www.mybatis.org/generator/configreference/xmlconfig.html