什么是MyBatis逆向工程
- 一個(gè) Maven 插件,根據(jù)數(shù)據(jù)的表生成實(shí)體類和 Mapper 接口和 Mapper XML
使用MyBatis逆向工程
-
jdbc.properties文件,連接數(shù)據(jù)庫使用
jdbc.driverClassName=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql:///ssm?characterEncoding=utf-8&useSSL=false jdbc.username=root jdbc.password=root
-
在resources目錄下新建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"> <!-- 上面這個(gè)約束文件會報(bào)紅项秉,不影響使用,當(dāng)然也不會有提示 如果看不過去库糠,可以復(fù)制鏈接到瀏覽器伙狐,將該約束文件下載放入resources目錄下即可 --> <!-- 配置生成器 --> <generatorConfiguration> <!--加載配置文件,為下面讀取數(shù)據(jù)庫信息準(zhǔn)備--> <properties resource="jdbc.properties"/> <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple"> <!-- 自動識別數(shù)據(jù)庫關(guān)鍵字瞬欧,默認(rèn)false贷屎,如果設(shè)置為true,根據(jù)SqlReservedWords中定義的關(guān)鍵字列表艘虎; 一般保留默認(rèn)值唉侄,遇到數(shù)據(jù)庫關(guān)鍵字(Java關(guān)鍵字),使用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:指明數(shù)據(jù)庫的用于標(biāo)記數(shù)據(jù)庫對象名的符號野建,比如ORACLE就是雙引號属划,MYSQL默認(rèn)是`反引號; --> <property name="beginningDelimiter" value="`" /> <property name="endingDelimiter" value="`" /> <commentGenerator> <property name="suppressDate" value="true" /> <property name="suppressAllComments" value="true" /> </commentGenerator> <!-- 必須要有的候生,使用這個(gè)配置連接數(shù)據(jù)庫 --> <jdbcConnection driverClass="${jdbc.driverClassName}" connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}"> <!-- 這里面可以設(shè)置property屬性同眯,每一個(gè)property屬性都設(shè)置到配置的Driver上 --> </jdbcConnection> <!-- java類型處理器 用于處理DB中的類型到Java中的類型,默認(rèn)使用JavaTypeResolverDefaultImpl唯鸭; 注意一點(diǎn)须蜗,默認(rèn)會先嘗試使用Integer,Long目溉,Short等來對應(yīng)DECIMAL和NUMERIC數(shù)據(jù)類型明肮; --> <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> <!-- true:使用BigDecimal對應(yīng)DECIMAL和 NUMERIC數(shù)據(jù)類型 false:默認(rèn) 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模型創(chuàng)建器缭付,是必須要的元素 負(fù)責(zé): 1. key類(見context的defaultModelType) 2. java類 3. 查詢類 targetPackage:生成的類要放的包柿估,真實(shí)的包受enableSubPackages屬性控制 targetProject:目標(biāo)項(xiàng)目,指定一個(gè)存在的目錄下陷猫,生成的內(nèi)容會放到指定目錄中秫舌,如果目錄不存在,MBG不會自動建目錄 --> <javaModelGenerator targetPackage="icu.resip.domain" targetProject="src/main/java"> <!--for MyBatis3/MyBatis3Simple 自動為每一個(gè)生成的類創(chuàng)建一個(gè)構(gòu)造方法绣檬,構(gòu)造方法包含了所有的field锰什;而不是使用setter--> <property name="constructorBased" value="false" /> <!-- for MyBatis3 / MyBatis3Simple 是否創(chuàng)建一個(gè)不可變的類, 如果為true霹疫, 那么MBG會創(chuàng)建一個(gè)沒有setter方法的類舌界,取而代之的是類似constructorBased的類 --> <property name="immutable" value="false" /> <!--設(shè)置是否在getter方法中,對String類型字段調(diào)用trim()方法--> <!--<property name="trimStrings" value="true" />--> </javaModelGenerator> <!-- 生成SQL map的XML文件生成器忘蟹, 注意飒房,在Mybatis3之后,我們可以使用mapper.xml文件+Mapper接口(或者不用mapper接口)媚值, 或者只使用Mapper接口 + Annotation狠毯, 所以,如果 javaClientGenerator配置中配置了需要生成XML的話褥芒,這個(gè)元素就必須配置 targetPackage/targetProject: 同javaModelGenerator --> <sqlMapGenerator targetPackage="icu.resip.mapper" targetProject="src/main/resources"> <!--在targetPackage的基礎(chǔ)上嚼松,根據(jù)數(shù)據(jù)庫的schema再生成一層package嫡良,最終生成的類放在這個(gè)package下,默認(rèn)為false--> <property name="enableSubPackages" value="true" /> </sqlMapGenerator> <!-- 對于mybatis來說献酗,即生成Mapper接口寝受,注意,如果沒有配置該元素罕偎,那么默認(rèn)不會生成Mapper接口 targetPackage/targetProject: 同javaModelGenerator type: 選擇怎么生成mapper接口(在MyBatis3/MyBatis3Simple下): 1. ANNOTATEDMAPPER:會生成使用Mapper接口+Annotation的方式創(chuàng)建(SQL生成在annotation中)很澄,不會生成對應(yīng)的XML; 2. MIXEDMAPPER:使用混合配置颜及,會生成Mapper接口甩苛,并適當(dāng)添加合適的Annotation,但是XML會生成在XML中俏站; 3. XMLMAPPER:會生成Mapper接口讯蒲,接口完全依賴XML; 注意肄扎,如果context是MyBatis3Simple, 只支持ANNOTATEDMAPPER和XMLMAPPER --> <javaClientGenerator targetPackage="icu.resip.mapper" type="XMLMAPPER" targetProject="src/main/java"> <!-- 在targetPackage的基礎(chǔ)上爱葵,根據(jù)數(shù)據(jù)庫的schema再生成一層package,最終生成的類放在這個(gè)package下反浓,默認(rèn)為false --> <property name="enableSubPackages" value="true" /> <!--可以為所有生成的接口添加一個(gè)父接口萌丈,但是MBG只負(fù)責(zé)生成,不負(fù)責(zé)檢查--> <!--<property name="rootInterface" value=""/>--> </javaClientGenerator> <!-- 生成對應(yīng)表及類名 全部表: <table tableName="%" > 指定表: <table tableName="module_news" > --> <table tableName="%"> <property name="useActualColumnNames" value="true"/> <property name="constructorBased" value="false" /> <generatedKey column="id" sqlStatement="JDBC" /> </table> </context> </generatorConfiguration>
-
在pom.xml文件中導(dǎo)入mybatis-generator-maven-plugin插件
<!-- MyBatis 逆向工程插件 --> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.2</version> <configuration> <verbose>true</verbose> <overwrite>false</overwrite> </configuration> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.45</version> </dependency> </dependencies> </plugin>
-
最后在maven處輸入如下命令即可
mybatis-generator:generate