springboot整合mybatis使用自動化生成工具（詳細）
阿新 • • 發佈：2019-01-16
在pom.xml中
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> <!-- mybatis generator 自動生成程式碼外掛(逆向工程外掛) --> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.2</version> <configuration> <!--配置檔案的位置--> <!--指定配置檔案的名稱。預設值:${basedir}/src/main/resources/generatorConfig.xml--><configurationFile> ${basedir}/src/main/resources/mybatis/generatorConfig.xml </configurationFile> <!-- 允許移動生成的檔案 --> <!--如果指定該引數，執行過程會輸出到控制檯--> <verbose>true</verbose> <!-- 是否覆蓋 --> <!--如果指定了該引數，如果生成的java檔案存在已經同名的檔案，新生成的檔案會覆蓋原有的檔案。 如果沒有指定該引數，如果存在同名的檔案，MBG會給新生成的程式碼檔案生成一個唯一的名字(例如： MyClass.java.1, MyClass.java.2 等等)。 重要: 生成器一定會自動合併或覆蓋已經生成的XML檔案。預設值:false--> <overwrite>true</overwrite> </configuration> <executions> <execution> <id>Generate MyBatis Artifacts</id> <goals> <goal>generate</goal> </goals> </execution> </executions> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>${mysql.version}</version> </dependency> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.2</version> </dependency> </dependencies> </plugin> </plugins> </build>
其中<version>${mysql.version}</version>的版本不能使用太高 否則會報錯
報錯：Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.2:generate (default-cli) on project ssm: Execution default-cli of goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.2:generate failed: Exception getting JDBC Driver: com.mysql.jdbc.Driver -> [Help 1][ERROR]
generatorConfig.xml
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPEgeneratorConfigurationPUBLIC"-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <!-- 根節點 --> <!-- 配置生成器 --> <generatorConfiguration> <!-- 可以用於載入配置項或者配置檔案，在整個配置檔案中就可以使用${propertyKey}的方式來引用配置項 resource：配置資源載入地址，使用resource，MBG從classpath開始找，比如com/myproject/generatorConfig.properties url：配置資源載入地質，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties. 注意，兩個屬性只能選址一個; 另外，如果使用了mybatis-generator-maven-plugin，那麼在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用 --> <!--<properties resource="application.yml"/>--> <!-- 在MBG工作的時候，需要額外載入的依賴包 location屬性指明載入jar/zip包的全路徑 (資料庫的JDBC驅動,換成你自己的驅動位) --> <!-- 資料庫驅動:選擇你的本地硬碟上面的資料庫驅動包--> <!--<classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />--> <!-- context:生成一組物件的環境 id:必選，上下文id，用於在生成錯誤時提示 defaultModelType:指定生成物件的樣式 1，conditional：類似hierarchical； 2，flat：所有內容（主鍵，blob）等全部生成在一個物件中； 3，hierarchical：主鍵生成一個XXKey物件(key class)，Blob等單獨生成一個物件，其他簡單屬性在一個物件中(record class) targetRuntime: 1，MyBatis3：預設的值，生成基於MyBatis3.x以上版本的內容，包括XXXBySample； 2，MyBatis3Simple：類似MyBatis3，只是不生成XXXBySample； introspectedColumnImpl：類全限定名，用於擴充套件MBG --> <!--<context id="Mysql" targetRuntime="MyBatis3" defaultModelType="flat">--> <context id="Mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple"> <!-- 自動識別資料庫關鍵字，預設false，如果設定為true，根據SqlReservedWords中定義的關鍵字列表； 一般保留預設值，遇到資料庫關鍵字（Java關鍵字），使用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"/> <!-- 是否生成註釋 --> <property name="suppressAllComments" value="false"></property> <!-- beginningDelimiter和endingDelimiter：指明資料庫的用於標記資料庫物件名的符號，比如ORACLE就是雙引號，MYSQL預設是`反引號； --> <property name="beginningDelimiter" value="`"/> <property name="endingDelimiter" value="`"/> <!-- 必須要有的，使用這個配置連結資料庫 @TODO:是否可以擴充套件 --> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/test_springboot" userId="root" password="root"> <!-- 這裡面可以設定property屬性，每一個property屬性都設定到配置的Driver上 --> </jdbcConnection> <!-- java型別處理器 用於處理DB中的型別到Java中的型別，預設使用JavaTypeResolverDefaultImpl； 注意一點，預設會先嚐試使用Integer，Long，Short等來對應DECIMAL和 NUMERIC資料型別； --> <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> <!-- true：使用BigDecimal對應DECIMAL和 NUMERIC資料型別 false：預設, 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模型建立器，是必須要的元素 負責：1，key類（見context的defaultModelType）；2，java類；3，查詢類 targetPackage：生成的類要放的包，真實的包受enableSubPackages屬性控制； targetProject：目標專案，指定一個存在的目錄下，生成的內容會放到指定目錄中，如果目錄不存在，MBG不會自動建目錄 --> <!-- 生成模型的包名和位置--> <javaModelGenerator targetPackage="com.szsm.bean" targetProject="src/main/java"> <!-- for MyBatis3/MyBatis3Simple 自動為每一個生成的類建立一個構造方法，構造方法包含了所有的field；而不是使用setter； --> <property name="constructorBased" value="false"/> <!-- 在targetPackage的基礎上，根據資料庫的schema再生成一層package，最終生成的類放在這個package下，預設為false --> <property name="enableSubPackages" value="true"/> <!-- for MyBatis3 / MyBatis3Simple 是否建立一個不可變的類，如果為true， 那麼MBG會建立一個沒有setter方法的類，取而代之的是類似constructorBased的類 --> <property name="immutable" value="false"/> <!-- 設定一個根物件， 如果設定了這個根物件，那麼生成的keyClass或者recordClass會繼承這個類；在Table的rootClass屬性中可以覆蓋該選項 注意：如果在key class或者record class中有root class相同的屬性，MBG就不會重新生成這些屬性了，包括： 1，屬性名相同，型別相同，有相同的getter/setter方法； --> <property name="rootClass" value="com.szsm.bean.BaseDomain"/> <!-- 設定是否在getter方法中，對String型別欄位呼叫trim()方法 --> <property name="trimStrings" value="true"/> </javaModelGenerator> <!-- 生成SQL map的XML檔案生成器， 注意，在Mybatis3之後，我們可以使用mapper.xml檔案+Mapper介面（或者不用mapper介面）， 或者只使用Mapper介面+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的話，這個元素就必須配置 targetPackage/targetProject:同javaModelGenerator --> <!-- 生成對映檔案的包名和位置--> <sqlMapGenerator targetPackage="mybatis/mapper" targetProject="src/main/resources"> <!-- 在targetPackage的基礎上，根據資料庫的schema再生成一層package，最終生成的類放在這個package下，預設為false --> <property name="enableSubPackages" value="true"/> </sqlMapGenerator> <!-- 對於mybatis來說，即生成Mapper介面，注意，如果沒有配置該元素，那麼預設不會生成Mapper介面 targetPackage/targetProject:同javaModelGenerator type：選擇怎麼生成mapper介面（在MyBatis3/MyBatis3Simple下）： 1，ANNOTATEDMAPPER：會生成使用Mapper介面+Annotation的方式建立（SQL生成在annotation中），不會生成對應的XML； 2，MIXEDMAPPER：使用混合配置，會生成Mapper介面，並適當新增合適的Annotation，但是XML會生成在XML中； 3，XMLMAPPER：會生成Mapper介面，介面完全依賴XML； 注意，如果context是MyBatis3Simple：只支援ANNOTATEDMAPPER和XMLMAPPER --> <!-- 生成DAO的包名和位置--> <javaClientGenerator targetPackage="com.szsm.mapper" type="XMLMAPPER" targetProject="src/main/java"> <!-- 在targetPackage的基礎上，根據資料庫的schema再生成一層package，最終生成的類放在這個package下，預設為false --> <property name="enableSubPackages" value="true"/> <!-- 可以為所有生成的介面新增一個父介面，但是MBG只負責生成，不負責檢查 <property name="rootInterface" value=""/> --> </javaClientGenerator> <!-- 選擇一個table來生成相關檔案，可以有一個或多個table，必須要有table元素 選擇的table會生成一下檔案： 1，SQL map檔案 2，生成一個主鍵類； 3，除了BLOB和主鍵的其他欄位的類； 4，包含BLOB的類； 5，一個使用者生成動態查詢的條件類（selectByExample, deleteByExample），可選； 6，Mapper介面（可選） tableName（必要）：要生成物件的表名； 注意：大小寫敏感問題。正常情況下，MBG會自動的去識別資料庫識別符號的大小寫敏感度，在一般情況下，MBG會 根據設定的schema，catalog或tablename去查詢資料表，按照下面的流程： 1，如果schema，catalog或tablename中有空格，那麼設定的是什麼格式，就精確的使用指定的大小寫格式去查詢； 2，否則，如果資料庫的識別符號使用大寫的，那麼MBG自動把表名變成大寫再查詢； 3，否則