什么是MyBatis Generator
MyBatis Generator (MBG) 是一個Mybatis的代碼生成器，可以自動生成一些簡單的CRUD（插入，查詢，更新，刪除）操作代碼，model代碼，及mapper配置文件；
如何配置MyBatis Generator
代碼生成器(MBG)是由一個XML配置文件驅動，主要告訴MBG以下三件事
- 如何連接到數據庫
- 生成什么對象，以及如何生成它們
- 那些表生成對象
具體如何配置，可以參考如下鏈接,已經有很詳細的說明了：
http://generator.sturgeon.mopaas.com/configreference/xmlconfig.html
這里給出本Demo的配置，以及相應的注釋，如下：
<?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> <!-- MyBatis3Simple 這是默認值 不會有"by example"一類的方法，只有少量的動態SQL。 flat 該模型為每一張表只生成一個實體類。這個實體類包含表中的所有字段 --> <context id="default" targetRuntime="MyBatis3Simple" defaultModelType="flat"> <!-- 該插件給實體類添加toString()方法 --> <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/> <!-- 這個插件給由MBG生成的Java模型對象增加了equals和hashCode方法 --> <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/> <!-- 不希望生成的注釋中包含時間戳 --> <commentGenerator> <property name="suppressDate" value="true" /> </commentGenerator> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull" userId="root" password="root"> </jdbcConnection> <!-- true：使用BigDecimal對應DECIMAL和 NUMERIC數據類型 false：默認, scale>0;length>18：使用BigDecimal; scale=0;length[10,18]：使用Long； scale=0;length[5,9]：使用Integer； scale=0;length<5：使用Short； --> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <javaModelGenerator targetPackage="cn.edu.hdu.mbgdemo.model.generator" targetProject="src/main/java"> <!-- 是否 自動為每一個生成的類創建一個構造方法--> <property name="constructorBased" value="false"/> <property name="useActualColumnNames" value="true" /> <!-- 在targetPackage的基礎上，根據數據庫的schema再生成一層package--> <property name="enableSubPackages" value="false"/> <!-- 是否創建一個不可變的類 --> <property name="immutable" value="false"/> <!-- 設置是否在getter方法中，對String類型字段調用trim()方法 --> <property name="trimStrings" value="true"/> <property name="rootClass" value="cn.edu.hdu.mbgdemo.base.BaseModel"/> </javaModelGenerator> <!-- 生成SQL map的XML文件生成器--> <sqlMapGenerator targetPackage="mappers.generator" targetProject="src/main/resources"> <property name="enableSubPackages" value="false"/> </sqlMapGenerator> <javaClientGenerator targetPackage="cn.edu.hdu.mbgdemo.dao.generator" targetProject="src/main/java" type="XMLMAPPER"> <property name="enableSubPackages" value="false"/> <property name="rootInterface" value="cn.edu.hdu.mbgdemo.base.BaseDao"/> </javaClientGenerator> <!--這里包含SQL通配符，表示匹配所有demo開頭的表--> <table tableName="demo_%"> </table> </context> </generatorConfiguration>
其實官網有很全的注釋，想要了解更多配置，最好參考官網。
如何運行MyBatis Generator
有以下四種運行方式：
- 從 命令提示符 使用 XML 配置文件
- 作為 Ant 任務 使用 XML 配置文件
- 作為 Maven Plugin
- 從另一個 Java 程序 使用 XML 配置文件
個人比較推薦作為maven插件運行，方便集成，部署。
MyBatis Generator例子
新建一個maven工程，編寫pom.xml文件，如下，主要是添加mybatis-generator-maven-plugin插件：
<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>cn.edu.hdu.mbgdemo</groupId> <artifactId>mbgdemo</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>mbgdemo</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>3.8.1</version> <scope>test</scope> </dependency> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.2</version> </dependency> </dependencies> <build> <finalName>${project.name}</finalName> <resources> <resource> <directory>src/main/java</directory> </resource> </resources> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.3</version> <configuration> <source>1.7</source> <target>1.7</target> <encoding>UTF-8</encoding> </configuration> </plugin> <!--幫助開發者讓他們的代碼兼容下一版本的Java，，Java 9開始，內部API將變為不可訪問--> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jdeps-plugin</artifactId> <version>3.0.0</version> <executions> <execution> <goals> <goal>jdkinternals</goal><!--檢查主代碼中是否包含對內部API的引用--> <goal>test-jdkinternals</goal><!--檢查測試代碼中是否包含對內部API的引用--> </goals> </execution> </executions> </plugin> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.2</version> <configuration> <verbose>true</verbose> <overwrite>true</overwrite> <configurationFile>src/main/resources/generatorConfig-demo.xml</configurationFile> </configuration> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.30</version> </dependency> </dependencies> <executions> <execution> <id>Generate MyBatis Artifacts</id> <goals> <goal>generate</goal> </goals> </execution> </executions> </plugin> </plugins> </pluginManagement> </build> </project>
然后編寫BaseDao和BaseModel，添加一些共性部分的代碼用於被子類繼承，如下：
public interface BaseDao<T extends BaseModel> { List<T> selectAll(); int delete(String id); T select(String id); int insert(T record); int update(T record); }
public class BaseModel implements Serializable {
/**
* ID
*/
private String id;
/**
* 是否有效
*/
private Boolean valid;
/**
* 由誰創建
*/
private String createBy;
/**
* 創建時間
*/
private Date createTime;
/**
* 最后修改者
*/
private String updateBy;
/**
* 最后修改時間
*/
private Date updateTime;
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public Boolean getValid() {
return valid;
}
public void setValid(Boolean valid) {
this.valid = valid;
}
public String getCreateBy() {
return createBy;
}
public void setCreateBy(String createBy) {
this.createBy = createBy;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
public String getUpdateBy() {
return updateBy;
}
public void setUpdateBy(String updateBy) {
this.updateBy = updateBy;
}
public Date getUpdateTime() {
return updateTime;
}
public void setUpdateTime(Date updateTime) {
this.updateTime = updateTime;
}
}
編寫配置文件generatorConfig-demo.xml，前面部分已經給出了，這里就不貼了，按官網來配置即可。
最后執行mybatis-generator:generate命令即可；
執行前與執行后，可以發現自動生成了Dao代碼，model代碼，mapper配置文件：
這里可以看下自動生成的mapper配置文件，如下，可見mbg可以幫助我們大大提高開發效率，而且還可以盡量減少人為錯誤：
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" > <mapper namespace="cn.edu.hdu.mbgdemo.dao.generator.DemoUserMapper" > <resultMap id="BaseResultMap" type="cn.edu.hdu.mbgdemo.model.generator.DemoUser" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> <id column="id" property="id" jdbcType="VARCHAR" /> <result column="name" property="name" jdbcType="VARCHAR" /> <result column="address" property="address" jdbcType="VARCHAR" /> </resultMap> <delete id="deleteByPrimaryKey" parameterType="java.lang.String" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> delete from demo_user where id = #{id,jdbcType=VARCHAR} </delete> <insert id="insert" parameterType="cn.edu.hdu.mbgdemo.model.generator.DemoUser" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> insert into demo_user (id, name, address ) values (#{id,jdbcType=VARCHAR}, #{name,jdbcType=VARCHAR}, #{address,jdbcType=VARCHAR} ) </insert> <update id="updateByPrimaryKey" parameterType="cn.edu.hdu.mbgdemo.model.generator.DemoUser" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> update demo_user set name = #{name,jdbcType=VARCHAR}, address = #{address,jdbcType=VARCHAR} where id = #{id,jdbcType=VARCHAR} </update> <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.String" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> select id, name, address from demo_user where id = #{id,jdbcType=VARCHAR} </select> <select id="selectAll" resultMap="BaseResultMap" > <!-- WARNING - @mbggenerated This element is automatically generated by MyBatis Generator, do not modify. --> select id, name, address from demo_user </select> </mapper>
當然，我們也可以自己往dao添加一些方法，然后在mapper配置文件里添加對應的配置信息。