1. 程式人生 > >配置Mybatis generator程式碼生成器外掛

配置Mybatis generator程式碼生成器外掛

1.新建maven專案,在pom.xml檔案中新增mybatis.generatorjar包

	 <dependency>
        	<groupId>org.mybatis.generator</groupId>
     		<artifactId>mybatis-generator-core</artifactId>
        	<version>1.3.5</version>
      	</dependency>

2.在pom.xml檔案中新增maven編譯外掛maven-compiler-plugin和mybatis-generator-maven-plugin外掛:

<build>

	<defaultGoal>compile</defaultGoal>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.2</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                </configuration>
            </plugin>
            
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.5</version>
                <configuration>
                	<configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>false</overwrite>
                </configuration>
                <!--外掛需要單獨配置資料庫連結-->
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.11</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
	</build>

3在src/main/resource資原始檔中新增程式碼生成器的配置檔案generatorConfig.xml
注意:要修改該檔案中關於資料庫連線的配置、生成檔案位置路徑的配置、以及對應DB表名。

generatorConfig.xml內容如下:

<?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>
	<context id="mysql" defaultModelType="hierarchical"
			 targetRuntime="MyBatis3Simple">
 
		<!-- 自動識別資料庫關鍵字,預設false,如果設定為true,根據SqlReservedWords中定義的關鍵字列表; 一般保留預設值,遇到資料庫關鍵字(Java關鍵字),使用columnOverride覆蓋 -->
		<property name="autoDelimitKeywords" value="false" />
		<!-- 生成的Java檔案的編碼 -->
		<property name="javaFileEncoding" value="UTF-8" />
		<!-- 格式化java程式碼 -->
		<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter" />
		<!-- 格式化XML程式碼 -->
		<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter" />
 
		<!-- beginningDelimiter和endingDelimiter:指明資料庫的用於標記資料庫物件名的符號,比如ORACLE就是雙引號,MYSQL預設是`反引號; -->
		<property name="beginningDelimiter" value="`" />
		<property name="endingDelimiter" value="`" />
 
		<commentGenerator>
			<property name="suppressDate" value="true" />
			<property name="suppressAllComments" value="true" />
		</commentGenerator>
 
		<!-- 必須要有的,使用這個配置連結資料庫 @TODO:是否可以擴充套件 -->
		<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
		 connectionURL="jdbc:mysql://127.0.0.1:3306/comment?useUnicode=true&amp;characterEncoding=utf8&amp;useSSL=false&amp;serverTimezone=GMT" 
		 userId="root"
		  password="password">
			<!-- 這裡面可以設定property屬性,每一個property屬性都設定到配置的Driver上 -->
		</jdbcConnection>
 
		<!-- java型別處理器 用於處理DB中的型別到Java中的型別,預設使用JavaTypeResolverDefaultImpl; 注意一點,預設會先嚐試使用Integer,Long,Short等來對應DECIMAL和
			NUMERIC資料型別; -->
		<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
			<!-- 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; -->
			<property name="forceBigDecimals" value="false" />
		</javaTypeResolver>
 
 
		<!-- java模型建立器,是必須要的元素 負責:1,key類(見context的defaultModelType);2,java類;3,查詢類
			targetPackage:生成的類要放的包,真實的包受enableSubPackages屬性控制; targetProject:目標專案,指定一個存在的目錄下,生成的內容會放到指定目錄中,如果目錄不存在,MBG不會自動建目錄 -->
		<javaModelGenerator targetPackage="org.imooc.bean" 
							targetProject="src/main/java">
			<!-- for MyBatis3/MyBatis3Simple 自動為每一個生成的類建立一個構造方法,構造方法包含了所有的field;而不是使用setter; -->
			<property name="constructorBased" value="false" />
 
			<!-- for MyBatis3 / MyBatis3Simple 是否建立一個不可變的類,如果為true, 那麼MBG會建立一個沒有setter方法的類,取而代之的是類似constructorBased的類 -->
			<property name="immutable" value="false" />
 
			<!-- 設定是否在getter方法中,對String型別欄位呼叫trim()方法 -->
			<property name="trimStrings" value="true" />
		</javaModelGenerator>
 
		<!-- 生成SQL map的XML檔案生成器, 注意,在Mybatis3之後,我們可以使用mapper.xml檔案+Mapper介面(或者不用mapper介面),
			或者只使用Mapper介面+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的話,這個元素就必須配置
			targetPackage/targetProject:同javaModelGenerator -->
		<sqlMapGenerator targetPackage="mapper"
						 targetProject="src/main/resources">
			<!-- 在targetPackage的基礎上,根據資料庫的schema再生成一層package,最終生成的類放在這個package下,預設為false -->
			<property name="enableSubPackages" value="true" />
		</sqlMapGenerator>
 
 
		<!-- 對於mybatis來說,即生成Mapper介面,注意,如果沒有配置該元素,那麼預設不會生成Mapper介面 targetPackage/targetProject:同javaModelGenerator
			type:選擇怎麼生成mapper介面(在MyBatis3/MyBatis3Simple下): 1,ANNOTATEDMAPPER:會生成使用Mapper介面+Annotation的方式建立(SQL生成在annotation中),不會生成對應的XML;
			2,MIXEDMAPPER:使用混合配置,會生成Mapper介面,並適當新增合適的Annotation,但是XML會生成在XML中; 3,XMLMAPPER:會生成Mapper介面,介面完全依賴XML;
			注意,如果context是MyBatis3Simple:只支援ANNOTATEDMAPPER和XMLMAPPER -->
		<javaClientGenerator targetPackage="org.imooc.dao"
							 type="XMLMAPPER" targetProject="src/main/java">
			<!-- 在targetPackage的基礎上,根據資料庫的schema再生成一層package,最終生成的類放在這個package下,預設為false -->
			<property name="enableSubPackages" value="true" />
 
			<!-- 可以為所有生成的介面新增一個父介面,但是MBG只負責生成,不負責檢查 <property name="rootInterface"
				value=""/> -->
		</javaClientGenerator>
                 <!-- 要生成的表名 -->
		<table tableName="ad">
			<!-- 參考 javaModelGenerator 的 constructorBased屬性 -->
			<property name="constructorBased" value="false" />
			<generatedKey column="employee_id" sqlStatement="JDBC" />
		</table>
	</context>
</generatorConfiguration>

4.配置好之後如何執行呢?
方法一:使用cmd命令列。(前提是配置了mvn)
在pom.xml這一級目錄的命令列視窗執行mvn mybatis-generator:generate即可生成 

方式二:在Eclipse中配置命令

之後在Eclipse選單欄的小蜘蛛圖示中就可以看到剛剛配置的命令了:

 

方式三:在intellij IDEA中,pom.xml中配置外掛之後,直接點選右側maven project中該外掛即可生成。

大功告成。程式碼生成器會生成3個檔案,如類檔案Ad.java  Mapper介面檔案AdMapper.java,以及Mybatis對映檔案AdMapper.xml.

 

注意自動工具生成的容易Mapper.xml檔案裡面容易生成重複的id例如<insert id="insert" parameterType="org.imooc.bean.Ad">

一定要刪除的重複的不然執行會報錯