mybaits generator 代碼自動生成工具使用

mybaits generator 代碼自動生成工具使用

MyBatis Generator (MBG) 是一個Mybatis的代碼生成器，它可以幫助我們根據數據庫中表的設計生成對應的實體類，xml Mapper文件，接口以及幫助類(也就是我們可以借助該類來進行簡單的CRUD操作)，這樣就避免了我們每使用到一張表的數據就需要手動去創建對應的類和xml文件，這就幫我們節約了大量的時間去開發和業務邏輯有關的功能，但是如果對聯合查詢和存儲過程您仍然需要手寫SQL和對象。

生成方式主要有 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>
            <!--執行generator插件生成文件的命令： call mvn mybatis-generator:generate -e -->
            <!-- 引入配置文件 -->
            <properties resource="mybatis-generator/mybatisGeneratorInit.properties"/>
            <!--classPathEntry:數據庫的JDBC驅動,換成你自己的驅動位置 可選 -->
            <!--<classPathEntry location="D:\generator_mybatis\mysql-connector-java-5.1.24-bin.jar" /> -->

            <!-- 一個數據庫一個context -->
            <!--defaultModelType="flat" 大數據字段，不分表 -->
            <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
                    <!-- 自動識別數據庫關鍵字，默認false，如果設置為true，根據SqlReservedWords中定義的關鍵字列表；
                    一般保留默認值，遇到數據庫關鍵字（Java關鍵字），使用columnOverride覆蓋 -->
                    <property name="autoDelimitKeywords" value="true" />
                    <!-- 生成的Java文件的編碼 -->
                    <property name="javaFileEncoding" value="utf-8" />
                    <!-- beginningDelimiter和endingDelimiter：指明數據庫的用于標記數據庫對象名的符號，比如ORACLE就是雙引號，MYSQL默認是`反引號； -->
                    <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" /> <!-- 是否生成注釋代時間戳-->
                    </commentGenerator>

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

                    <!-- 生成實體類地址 -->
                    <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對應client，也就是接口dao -->
                    <javaClientGenerator targetPackage="com.test.mapper" targetProject="${project}" type="XMLMAPPER" >
                            <property name="enableSubPackages" value="false" />
                    </javaClientGenerator>
                    <!-- table可以有多個,每個數據庫中的表都可以寫一個table，tableName表示要匹配的數據庫表,也可以在tableName屬性中通過使用%通配符來匹配所有數據庫表,只有匹配的表才會自動生成文件 -->
                    <table tableName="user" enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true">
                            <property name="useActualColumnNames" value="false" />
                            <!-- 數據庫表主鍵 -->
                            <generatedKey column="id" sqlStatement="Mysql" identity="true" />
                    </table>
            </context>
    </generatorConfiguration>

3.配置數據庫參數

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

最后執行命令

    mvn mybatis-generator:generate