目录
- Mybatis Generator
是什么
Mybatis Generator是Mybatis的代码生成工具,它根据数据库的表结构信息,逆向生成Java代码中对应的POJO类、DAO层以及映射文件等。对数据库的基本操作CRUD等都可以直接通过它创建的类调用完成,省去了手动写这些重复代码的工作。
怎么做
其实要使用Mybatis Generator除了下载jar包之后,只需要额外多一个配置文件即可。以如下官网样例为例:
<?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="/Program Files/IBM/SQLLIB/java/db2java.zip" />
<context id="DB2Tables" targetRuntime="MyBatis3">
<jdbcConnection driverClass="COM.ibm.db2.jdbc.app.DB2Driver"
connectionURL="jdbc:db2:TEST"
userId="db2admin"
password="db2admin">
</jdbcConnection>
<javaTypeResolver >
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<javaModelGenerator targetPackage="test.model" targetProject="\MBGTestProject\src">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<sqlMapGenerator targetPackage="test.xml" targetProject="\MBGTestProject\src">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER" targetPackage="test.dao" targetProject="\MBGTestProject\src">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<table schema="DB2ADMIN" tableName="ALLTYPES" domainObjectName="Customer" >
<property name="useActualColumnNames" value="true"/>
<generatedKey column="ID" sqlStatement="DB2" identity="true" />
<columnOverride column="DATE_FIELD" property="startDate" />
<ignoreColumn column="FRED" />
<columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />
</table>
</context>
</generatorConfiguration>
配置好了配置文件后,可以通过ant、maven等方式运行,当然也可以通过命令行的方式:
java -jar mybatis-generator-core-x.x.x.jar -configfile generatorConfig.xml
运行之后,就可以自动在对应位置生成相关文件。
Model、Client、sqlMap:
配置文件中的jdbcConnection
是数据库链接的一些配置信息,包括用户名、密码、驱动等
每一个<table/>
标签对应一张表,代码生成时,Mybatis Generator会扫描对应数据库中的这些表,不在配置文件中的表是会被忽略的。
javaModelGenerator
,sqlMapGenerator
,javaClientGenerator
这三个是比较有疑惑的。需要结合他们具体的使用方式才能知道各自的作用。
-
Model
主要包含4类,表名为Table
时有如下结构。
如果该表存在联合主键,则会生成该主键类(TableKey)。余下字段除BLOB
类型外均会在记录类(Table)中,该类会继承TableKey
(如果主键仅包含一个字段,由于不存在TableKey,该类不存在父类),BLOB
类型的其余字段单独一个TableWithBLOBs
类。
对于TableExample
类,通过Criteria
提供一套通用的查询接口,与Laravel
的Query Builder
类似,但是这里是不执行具体查询操作的,相当于只是将所需要的操作转换为对应的SQL -
Client
每个table会生成一个对应TableMapper接口以及TableSqlMapper的"实现类",通过在TableMapper接口的方法上的SelectProvider注解,将接口对应的实现映射到TableSqlMapper。这个包更像是DAO,Example类各种查询最后是要通过这里的Mapper去执行真正的查询操作。
sqlMap
Mybaits3.X后,如果Client是选择Mapper接口+注解方式,则不会有该包。该包作用是将查询对应SQL影射到xml配置文件中。
大致这些内容。关于配置具体内容与含义可以看文末的参考文档,参考性质的内容就不写在这里了。