mybaits generator 代碼自動(dòng)生成工具使用

mybaits generator 代碼自動(dòng)生成工具使用

MyBatis Generator (MBG) 是一個(gè)Mybatis的代碼生成器，它可以幫助我們根據(jù)數(shù)據(jù)庫(kù)中表的設(shè)計(jì)生成對(duì)應(yīng)的實(shí)體類，xml Mapper文件，接口以及幫助類(也就是我們可以借助該類來(lái)進(jìn)行簡(jiǎn)單的CRUD操作)，這樣就避免了我們每使用到一張表的數(shù)據(jù)就需要手動(dòng)去創(chuàng)建對(duì)應(yīng)的類和xml文件，這就幫我們節(jié)約了大量的時(shí)間去開發(fā)和業(yè)務(wù)邏輯有關(guān)的功能，但是如果對(duì)聯(lián)合查詢和存儲(chǔ)過(guò)程您仍然需要手寫SQL和對(duì)象。

生成方式主要有 Maven 和 java 方式 下面是 Maven 方式

1. pom 文件中加入插件

   <build>
           <plugins>
                   <plugin>
                           <groupId>org.mybatis.generator</groupId>
                           <artifactId>mybatis-generator-maven-plugin</artifactId>
                           <version>1.3.7</version>
                           <executions>
                                   <execution>
                                           <id>Generate MyBatis Artifacts</id>
                                           <phase>deploy</phase>
                                           <goals>
                                                   <goal>generate</goal>
                                           </goals>
                                   </execution>
                           </executions>
                           <configuration>
                                   <!-- generator 工具配置文件的位置 -->
                                   <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                                   <verbose>true</verbose>
                                   <overwrite>true</overwrite>
                           </configuration>
                           <dependencies>
                                   <dependency>
                                           <groupId>mysql</groupId>
                                           <artifactId>mysql-connector-java</artifactId>
                                   </dependency>
                                   <dependency>
                                           <groupId>org.mybatis.generator</groupId>
                                           <artifactId>mybatis-generator-core</artifactId>
                                           <version>1.3.7</version>
                                   </dependency>
                           </dependencies>
                   </plugin>
           </plugins>
   </build>

2.配置 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>
            <!--執(zhí)行g(shù)enerator插件生成文件的命令： call mvn mybatis-generator:generate -e -->
            <!-- 引入配置文件 -->
            <properties resource="mybatis-generator/mybatisGeneratorInit.properties"/>
            <!--classPathEntry:數(shù)據(jù)庫(kù)的JDBC驅(qū)動(dòng),換成你自己的驅(qū)動(dòng)位置 可選 -->
            <!--<classPathEntry location="D:\generator_mybatis\mysql-connector-java-5.1.24-bin.jar" /> -->

            <!-- 一個(gè)數(shù)據(jù)庫(kù)一個(gè)context -->
            <!--defaultModelType="flat" 大數(shù)據(jù)字段，不分表 -->
            <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
                    <!-- 自動(dòng)識(shí)別數(shù)據(jù)庫(kù)關(guān)鍵字，默認(rèn)false，如果設(shè)置為true，根據(jù)SqlReservedWords中定義的關(guān)鍵字列表；
                    一般保留默認(rèn)值，遇到數(shù)據(jù)庫(kù)關(guān)鍵字（Java關(guān)鍵字），使用columnOverride覆蓋 -->
                    <property name="autoDelimitKeywords" value="true" />
                    <!-- 生成的Java文件的編碼 -->
                    <property name="javaFileEncoding" value="utf-8" />
                    <!-- beginningDelimiter和endingDelimiter：指明數(shù)據(jù)庫(kù)的用于標(biāo)記數(shù)據(jù)庫(kù)對(duì)象名的符號(hào)，比如ORACLE就是雙引號(hào)，MYSQL默認(rèn)是`反引號(hào)； -->
                    <property name="beginningDelimiter" value="`" />
                    <property name="endingDelimiter" value="`" />

                    <!-- 格式化java代碼 -->
                    <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
                    <!-- 格式化XML代碼 -->
                    <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
                    <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

                    <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />

                    <!-- 注釋 -->
                    <commentGenerator >
                            <property name="suppressAllComments" value="false"/><!-- 是否取消注釋 -->
                            <property name="suppressDate" value="true" /> <!-- 是否生成注釋代時(shí)間戳-->
                    </commentGenerator>

                    <!-- jdbc連接 -->
                    <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" />
                    <!-- 類型轉(zhuǎn)換 -->
                    <javaTypeResolver>
                            <!-- 是否使用bigDecimal， false可自動(dòng)轉(zhuǎn)化以下類型（Long, Integer, Short, etc.） -->
                            <property name="forceBigDecimals" value="false"/>
                    </javaTypeResolver>

                    <!-- 生成實(shí)體類地址 -->
                    <javaModelGenerator targetPackage="com.test.entity" targetProject="${project}" >
                            <property name="enableSubPackages" value="false"/>
                            <property name="trimStrings" value="true"/>
                    </javaModelGenerator>
                    <!-- 生成mapxml文件 -->
                    <sqlMapGenerator targetPackage="mappers" targetProject="${resources}" >
                            <property name="enableSubPackages" value="false" />
                    </sqlMapGenerator>
                    <!-- 生成mapxml對(duì)應(yīng)client，也就是接口dao -->
                    <javaClientGenerator targetPackage="com.test.mapper" targetProject="${project}" type="XMLMAPPER" >
                            <property name="enableSubPackages" value="false" />
                    </javaClientGenerator>
                    <!-- table可以有多個(gè),每個(gè)數(shù)據(jù)庫(kù)中的表都可以寫一個(gè)table，tableName表示要匹配的數(shù)據(jù)庫(kù)表,也可以在tableName屬性中通過(guò)使用%通配符來(lái)匹配所有數(shù)據(jù)庫(kù)表,只有匹配的表才會(huì)自動(dòng)生成文件 -->
                    <table tableName="user" enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true">
                            <property name="useActualColumnNames" value="false" />
                            <!-- 數(shù)據(jù)庫(kù)表主鍵 -->
                            <generatedKey column="id" sqlStatement="Mysql" identity="true" />
                    </table>
            </context>
    </generatorConfiguration>

3.配置數(shù)據(jù)庫(kù)參數(shù)

#Mybatis Generator configuration
#dao類和實(shí)體類的位置
project =src/main/java
#mapper文件的位置
resources=src/main/resources
#根據(jù)數(shù)據(jù)庫(kù)中的表生成對(duì)應(yīng)的pojo類、dao、mapper
jdbc_driver =com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/demo
jdbc_user=root
jdbc_password=123456

最后執(zhí)行命令

    mvn mybatis-generator:generate