1、mybatis-generator 概述
MyBatis官方提供了逆向工程 mybatis-generator,可以針對數據庫表自動生成MyBatis執行所需要的代碼(如Mapper.java、Mapper.xml、POJO)。mybatis-generator 有三種用法:命令行、eclipse插件、maven插件。而maven插件的方式比較通用,本文也將概述maven插件的使用方式。
2、pom.xml中配置plugin
(官方文檔:Running MyBatis Generator With Maven)
<build>
<plugins>
<!-- mybatis-generator -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<!-- mybatis-generator的配置文件,根據情況調整位置 -->
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
3、generatorConfig.xml配置文件
(官方文檔:MyBatis GeneratorXML Configuration File Reference)
稍微詳細一點如下:
<?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>
<!--JDBC驅動jar包的位置-->
<classPathEntry location="C:/workspace/project/learning/mybatis/lib/mysql-connector-java-5.1.6.jar"/>
<context id="default" targetRuntime="MyBatis3">
<!--創建Java類時是否取消生成註釋-->
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--JDBC數據庫連接-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/test"
userId="root"
password="dev">
</jdbcConnection>
<!--
Model模型生成器,用來生成含有主鍵key的類,記錄類 以及查詢Example類
targetPackage 指定生成的model生成所在的包名
targetProject 指定在該項目下所在的路徑
-->
<javaModelGenerator targetPackage="dulk.learn.mybatis.generator.pojo"
targetProject="./src/main/java">
<!-- 是否允許子包,即targetPackage.schemaName.tableName -->
<property name="enableSubPackages" value="false"/>
<!-- 是否對model添加構造函數 -->
<property name="constructorBased" value="true"/>
<!-- 是否對類CHAR類型的列的數據進行trim操作 -->
<property name="trimStrings" value="true"/>
<!-- 建立的Model對象是否 不可改變 即生成的Model對象不會有 setter方法,只有構造方法 -->
<property name="immutable" value="false"/>
</javaModelGenerator>
<!--
mapper映射文件生成所在的目錄 爲每一個數據庫的表生成對應的SqlMap文件
-->
<sqlMapGenerator targetPackage="generator"
targetProject="./src/main/resources">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<!--
客戶端代碼,生成易於使用的針對Model對象和XML配置文件的代碼
type="ANNOTATEDMAPPER",生成Java Model和基於註解的Mapper對象
type="MIXEDMAPPER",生成基於註解的Java Model和相應的Mapper對象
type="XMLMAPPER",生成SQLMap XML文件和獨立的Mapper接口
-->
<javaClientGenerator type="XMLMAPPER"
targetPackage="dulk.learn.mybatis.generator.mapper"
targetProject="./src/main/java">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<!--tables-->
<table tableName="author" domainObjectName="Author"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
<table tableName="book" domainObjectName="Book"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
</context>
</generatorConfiguration>
另,配置文件中諸如 javaModelGenerator / sqlMapGenerator / javaClientGenerator 等配置的順序不要輕易改變,可能會導致插件執行時失敗。
4、使用方式
mvn mybatis-generator:generate
如果是在IDEA環境中,直接鼠標點擊執行即可:
目錄結構如下:
注:建表時,字段名稱建議用"_"分隔多個單詞,比如:author_id…,這樣生成的model,屬性名稱就會變成的駝峯命名,即:authorId
5、參考鏈接
利用mybatis-generator自動生成代碼