mybatis自動生成程式碼外掛mybatis-generator使用流程(親測可用)(轉載)
阿新 • • 發佈:2020-07-17
mybatis-generator是一款在使用mybatis框架時,自動生成model,dao和mapper的工具,很大程度上減少了業務開發人員的手動編碼時間
坐著在idea上用maven構建springboot專案,親測可用,流程記錄如下
1.新增依賴
<!--mybatis逆向工程--> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.7</version> </dependency>
2.新增maven外掛,在build的plugins中新增
<!--mybatis逆向工程--> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.7</version> <configuration> <configurationFile>src/main/resources/generatorConfig.xml</configurationFile> <verbose>true</verbose> <overwrite>true</overwrite> </configuration> </plugin>
3.外掛的配置檔案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> <!-- 可以用於載入配置項或者配置檔案 resource:配置資源載入地址,使用resource,從classpath開始找,比如com/myproject/generatorConfig.properties url:配置資源載入地質,使用URL的方式,比如file:///C:/myfolder/generatorConfig.properties. 注意,兩個屬性只能選址一個 --> <!--匯入屬性配置--> <properties resource="datasource.properties"/> <!--指定特定資料庫的jdbc驅動jar包的位置--> <!-- 暫時不清楚怎麼指定相對路徑,只能指定maven倉庫中的jar包 --> <classPathEntry location="D:/repository/mysql/mysql-connector-java/8.0.12/mysql-connector-java-8.0.12.jar"/> <!-- context:生成一組物件的環境 id:必選,上下文id,用於在生成錯誤時提示 targetRuntime: 1,MyBatis3:預設的值,生成基於MyBatis3.x以上版本的內容,包括XXXBySample; 2,MyBatis3Simple:類似MyBatis3,只是不生成XXXBySample; --> <context id="default" targetRuntime="MyBatis3"> <!--生成的bean是沒有tostring方法的,所以如果要想生成tostring方法的話,需要在generatorConfig.xml中加上如下配置--> <plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin> <!-- 該元素最多可以配置1個,可以生成檔案的註釋 --> <commentGenerator> <!--阻止生成的註釋包含時間戳,預設為false--> <property name="suppressDate" value="true"/> <!--阻止生成註釋,預設為false--> <property name="suppressAllComments" value="true"/> <!--設定要使用的Java檔案的編碼--> <property name="javaFileEncoding" value="UTF-8"/> </commentGenerator> <!--jdbc的資料庫連線,引入上述的配置檔案datasource.properties的內容,這裡直接寫死也可以 --> <jdbcConnection driverClass="${jdbc.driverClass}" connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}"> </jdbcConnection> <!-- 是否使用bigDecimal, false可自動轉化以下型別(Long, Integer, Short, etc.) --> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- Model模型生成器,用來生成資料庫對應的實體類 targetPackage 指定生成的實體類 所在的包名 targetProject 指定在該專案下所在的路徑 --> <javaModelGenerator targetPackage="com.pdzx.entity" targetProject="D:/workspaces/pdzx-customer-microservice/pdzx-manage-system/src/main/java"> <!-- 是否允許子包,eg:fase路徑com.pdzx.entity, true:com.pdzx.entity..[schemaName] --> <property name="enableSubPackages" value="false"/> <!-- 是否對model新增 建構函式 --> <property name="constructorBased" value="false"/> <!-- 建立的Model物件是否 不可改變 即生成的Model物件不會有 setter方法,只有構造方法 --> <property name="immutable" value="false"/> <!-- 設定是否在getter方法中,對String型別欄位呼叫trim()方法 --> <!--如果設定為true就會生成類似這樣 public void setUsername(String username) {this.username = username == null ? null : username.trim();}--> <property name="trimStrings" value="false"/> </javaModelGenerator> <!--mapper對映檔案生成所在的目錄 為每一個數據庫的表生成對應的SqlMap檔案,就是用xml寫SQL的方式 --> <sqlMapGenerator targetPackage="com.pdzx.mapper" targetProject="D:/workspaces/pdzx-customer-microservice/pdzx-manage-system/src/main/java"> <property name="enableSubPackages" value="false"/> </sqlMapGenerator> <!-- 生成易於使用的針對Model物件和XML配置檔案 的程式碼,即dao層介面檔案 type="ANNOTATEDMAPPER",基於註解的Mapper介面,不會有對應的XML對映檔案 type="MIXEDMAPPER",XML和註解的混合形式,(上面這種情況中的)SqlProvider註解方法會被XML替代 type="XMLMAPPER",所有的方法都在XML中,介面呼叫依賴XML檔案。 --> <!-- targetPackage:mapper介面dao生成的位置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="com.pdzx.dao" targetProject="D:/workspaces/pdzx-customer-microservice/pdzx-manage-system/src/main/java"> <!-- enableSubPackages:是否讓schema作為包的字尾 --> <property name="enableSubPackages" value="false" /> </javaClientGenerator> <!-- tableName為對應的資料庫表 domainObjectName是要生成的實體類 enable*ByExample是否生成 example類 --> <table tableName="b_template_useclient" domainObjectName="TemplateUseclient" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> <!-- 上面的屬性都可以使用子標籤形式表示 --> <!-- 是否使用真實欄位名,設定為false將自動駝峰轉換 --> <property name="useActualColumnNames" value="false" /> </table> </context> </generatorConfiguration>
4.資料庫配置檔案datasource.properties
jdbc.driverClass=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://139.196.51.7:3306/pdafc?characterEncoding=utf8&useSSL=false&allowMultiQueries=true&nullCatalogMeansCurrent=true&tinyInt1isBit=false jdbc.username=xxx jdbc.password=xxx
注意兩個問題的解決方案:
1. mybatis自動生成的程式碼只有insert()和insertSelective()
解決方案:在jdbc url後增加下面程式碼即可
nullCatalogMeansCurrent=true
2.mybatis 自動生成程式碼對於tinyint 型別自動解析成BOOLEAN型別
解決方案:對於tinyint 型別自動解析成BYTE型別 在jdbc.url後增加下面程式碼即可
tinyInt1isBit=false