自動生成Mybatis的Mapper檔案
阿新 • • 發佈:2019-07-26
自動生成Mybatis的Mapper檔案
工作中使用mybatis時我們需要根據資料表字段建立pojo類、mapper檔案以及dao類,並且需要配置它們之間的依賴關係,這樣的工作很瑣碎和重複,mybatis官方也發現了這個問題,因此給我們提供了mybatis generator工具來幫我們自動建立pojo類、mapper檔案以及dao類並且會幫我們配置好它們的依賴關係。
實際上,最非常流行MyBatis-Plus中內建了程式碼生成器:採用程式碼或者 Maven 外掛可快速生成 Mapper 、 Model 、 Service 、 Controller 層程式碼,支援模板引擎,有超多自定義配置等,在這主要介紹Mybatis的自動生成步驟。
外掛依賴
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.5</version> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>6.0.6</version> </dependency> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.5</version> </dependency> </dependencies> <!--<executions>--> <!--<execution>--> <!--<id>Generate MyBatis Artifacts</id>--> <!--<phase>package</phase>--> <!--<goals>--> <!--<goal>generate</goal>--> <!--</goals>--> <!--</execution>--> <!--</executions>--> <configuration> <!--允許移動生成的檔案 --> <verbose>true</verbose> <!-- 是否覆蓋 --> <overwrite>true</overwrite> <!-- 自動生成的配置 --> <configurationFile> src/main/resources/generatorConfig.xml </configurationFile> </configuration> </plugin> </plugins> </build>
注意:mysql-connector-java的版本問題,如果你的驅動是com.mysql.cj.jdbc.Driver,你就需要6.0.x的版本。如果是com.mysql.jdbc.Driver 則是5.1.x的版本。
配置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> <!--匯入屬性配置--> <properties resource="datasource.properties"></properties> <!-- context 是逆向工程的主要配置資訊 --> <!-- id:name --> <!-- targetRuntime:設定生成的檔案適用於那個 mybatis 版本 --> <context id="default" targetRuntime="MyBatis3"> <!-- 生成的 Java 檔案的編碼 --> <property name="javaFileEncoding" value="UTF-8"/> <!-- optional,旨在建立class時,對註釋進行控制 --> <commentGenerator> <property name="suppressDate" value="true"/> <property name="suppressAllComments" value="true"/> </commentGenerator> <!--jdbc的資料庫連線 --> <jdbcConnection driverClass="${db.driverClassName}" connectionURL="${db.url}" userId="${db.username}" password="${db.password}"> </jdbcConnection> <!-- 非必需,型別處理器,在資料庫型別和java型別之間的轉換控制--> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- Model模型生成器,用來生成含有主鍵key的類,記錄類 以及查詢Example類 targetPackage 指定生成的model生成所在的包名 targetProject 指定在該專案下所在的路徑 --> <!--<javaModelGenerator targetPackage="com.mmall.pojo" targetProject=".\src\main\java">--> <javaModelGenerator targetPackage="com.ke.likehouse.model" targetProject="./src/main/java"> <!-- 是否允許子包,即targetPackage.schemaName.tableName --> <property name="enableSubPackages" value="false"/> <!-- 是否對model新增 建構函式 --> <property name="constructorBased" value="true"/> <!-- 是否對類CHAR型別的列的資料進行trim操作 --> <property name="trimStrings" value="true"/> <!-- 建立的Model物件是否 不可改變 即生成的Model物件不會有 setter方法,只有構造方法 --> <property name="immutable" value="false"/> </javaModelGenerator> <!--mapper對映檔案生成所在的目錄 為每一個數據庫的表生成對應的SqlMap檔案 --> <!--<sqlMapGenerator targetPackage="mappers" targetProject=".\src\main\resources">--> <sqlMapGenerator targetPackage="mybatis/mappers" targetProject="./src/main/resources"> <property name="enableSubPackages" value="false"/> </sqlMapGenerator> <!-- 客戶端程式碼,生成易於使用的針對Model物件和XML配置檔案 的程式碼 type="ANNOTATEDMAPPER",生成Java Model 和基於註解的Mapper物件 type="MIXEDMAPPER",生成基於註解的Java Model 和相應的Mapper物件 type="XMLMAPPER",生成SQLMap XML檔案和獨立的Mapper介面 --> <!-- targetPackage:mapper介面dao生成的位置 --> <!--<javaClientGenerator type="XMLMAPPER" targetPackage="com.mmall.dao" targetProject=".\src\main\java">--> <javaClientGenerator type="XMLMAPPER" targetPackage="com.ke.likehouse.dao" targetProject="./src/main/java"> <!-- enableSubPackages:是否讓schema作為包的字尾 --> <property name="enableSubPackages" value="false" /> </javaClientGenerator> <!--生成的表--> <!--domainObjectName:生成的domain類的名字,如果不設定,直接使用表名作為domain類的名字;可以設定為somepck.domainName,那麼會自動把domainName類再放到somepck包裡面;--> <!--enableInsert(預設true):指定是否生成insert語句;--> <!--enableSelectByPrimaryKey(預設true):指定是否生成按照主鍵查詢物件的語句(就是getById或get);--> <!--enableSelectByExample(預設true):MyBatis3Simple為false,指定是否生成動態查詢語句;--> <!--enableUpdateByPrimaryKey(預設true):指定是否生成按照主鍵修改物件的語句(即update);--> <!--enableDeleteByPrimaryKey(預設true):指定是否生成按照主鍵刪除物件的語句(即delete);--> <!--enableDeleteByExample(預設true):MyBatis3Simple為false,指定是否生成動態刪除語句;--> <!--enableCountByExample(預設true):MyBatis3Simple為false,指定是否生成動態查詢總條數語句(用於分頁的總條數查詢);--> <!--enableUpdateByExample(預設true):MyBatis3Simple為false,指定是否生成動態修改語句(只修改物件中不為空的屬性);--> <table tableName="agent" domainObjectName="Agent" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> </table> <!-- geelynote mybatis外掛的搭建 --> </context> </generatorConfiguration>
提供datasource.properties
db.driverClassName = com.mysql.cj.jdbc.Driver
db.url = jdbc:mysql://localhost:3306/twelve?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
db.username = root
db.password = 你的密碼
執行maven命令
方式一:通過IDEA的MAVEN工具執行
方式二:通過MAVEN命令
配置命令:mybatis-generator:generate -e
然後Run就好了:
可能出現的BUG
如果你複製貼上了程式碼卻出現稀奇古怪的BUG,很有可能是:
- 你的maven的配置檔案問題
- 引用的mysql-connector-java與driverClassName版本不匹配
如果你的驅動是com.mysql.cj.jdbc.Driver,你就需要6.x.x的版本。如果是com.mysql.jdbc.Driver 則是5.x.x的版本