寫了10年的程式碼,我最怕寫Mybatis這些配置,現在有詳解了
在使用 mybatis 過程中, 當手寫 JavaBean和XML 寫的越來越多的時候, 就越來越同意出錯。這種重複性的工作, 我們當然不希望做那麼多。
關於MyBatis的知識點總結了個思維導圖分享給大家
還好, mybatis 為我們提供了強大的程式碼生成--MybatisGenerator。
通過簡單的配置, 我們就可以生成各種型別的實體類, Mapper介面, MapperXML檔案, Example物件等。通過這些生成的檔案, 我們就可以方便的進行單表進行增刪改查的操作。
Tips:關注微信公眾號:程式設計師白楠楠,獲取每日推送。
以下的工具使用的都是 IDEA
1.1 建立Maven專案
1.1.1 選單上選擇新建專案
File | New | Project
1.1.2 選擇左側的Maven
新增描述
由於我們只是建立一個普通的專案, 此處點選 Next即可。
1.1.3 輸入GroupId和ArtifactId
- 在我的專案中,
GroupId 填 com.homejim.mybatis ArtifactId 填 mybatis-generator
點選 Next。
1.1.4 Finish
通過以上步驟, 一個普通的Maven專案就建立好了。
1.2 配置 generator.xml
其實名字無所謂, 只要跟下面的 pom.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>
<classPathEntry location="C:\Users\\Administrator\\.m2\repository\\mysql\\mysql-connector-java\\8.0.12\\mysql-connector-java-8.0.12.jar"/>
<context id="context" targetRuntime="MyBatis3">
<commentGenerator>
<property name="suppressAllComments" value="false"/>
<property name="suppressDate" value="true"/>
</commentGenerator>
<jdbcConnection
driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mybatis"
userId="root"
password="jim777"/>
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<javaModelGenerator
targetPackage="com.homejim.mybatis.entity"
targetProject=".\src\main\java">
<property name="enableSubPackages" value="false"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<sqlMapGenerator
targetPackage="mybatis/mapper"
targetProject=".\src\main\resources">
<property name="enableSubPackages" value="false"/>
</sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.homejim.mybatis.mapper"
targetProject=".\src\main\java">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<table tableName="blog" />
</context>
</generatorConfiguration>
需要改一些內容:
1. 本地資料庫驅動程式jar包的全路徑(必須要改)。
2. 資料庫的相關配置(必須要改)
3. 相關表的配置(必須要改)
4. 實體類生成存放的位置。
5. MapperXML 生成檔案存放的位置。
6. Mapper 介面存放的位置。
如果不知道怎麼改, 請看後面的配置詳解。
1.3 配置 pom.xml
在原基礎上新增一些內容。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.homejim.mybatis</groupId>
<artifactId>mybatis-generator</artifactId>
<version>1.0-SNAPSHOT</version>
<build>
<finalName>mybatis-generator</finalName>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<configurationFile>src/main/resources/generator.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
需要注意的是 configurationFile 中的檔案指的是 generator.xml。因此路徑寫的是該檔案的相對路徑, 名稱也跟該檔案相同。
到此, mybatis-generator 就可以使用啦。
1.4 使用及測試
1.4.1 開啟 Maven Projects 檢視
在 IDEA 上, 開啟:
View | Tools | Windwos | Maven Projects
新增描述
1.4.2 Maven Projects 中雙擊 mybatis-generator
在右側此時可以看到 Maven Projects 了。找到 mybatis-generator 外掛。
mybatis-generator | Plugins | mybatis-generator | mybatis-generator
新增描述
1.4.3 雙擊執行
執行正確後, 生成程式碼, 得到如下的結構
新增描述
僅僅是上面那麼簡單的使用還不夠爽。那麼我們就可以通過更改 generator.xml 配置檔案的方式進行生成的配置。
2.1 文件
推薦檢視官方的文件。
英文不錯的:http://www.mybatis.org/generator/configreference/xmlconfig.html
中文翻譯版:http://mbg.cndocs.ml/index.html
2.2 官網沒有的
2.2.1 property 標籤
該標籤在官網中只是說用來指定元素的屬性, 至於怎麼用沒有詳細的講解。
2.2.1.1 分隔符相關
<property name="autoDelimitKeywords" value="true"/>
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
以上的配置對應的是 mysql, 當資料庫中的欄位和資料庫的關鍵字一樣時, 就會使用分隔符。
比如我們的資料列是 delete, 按以上的配置後, 在它出現的地方, 就變成 `delete`。
2.2.1.2 編碼
預設是使用當前的系統環境的編碼, 可以配置為 GBK 或 UTF-8。
<property name="javaFileEncoding" value="UTF-8"/>
我想專案為 UTF-8, 如果指定生成 GBK, 則自動生成的中文就是亂碼。
2.2.1.3 格式化
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
這些顯然都是可以自定義實現的的。
2.2.2 plugins 標籤
plugins 標籤用來擴充套件或修改程式碼生成器生成的程式碼。
在生成的 XML 中, 是沒有 這個標籤的。該標籤是配置快取的。
如果我們想生成這個標籤, 那麼可以 plugins 中進行配置。
<plugin type="org.mybatis.generator.plugins.CachePlugin" >
<property name="cache_eviction" value="LRU"/>
</plugin>
新增描述
比如你想生成的 JavaBean 中自行實現 Serializable 介面。
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
新增描述
還能自定義外掛。
這些外掛都蠻有用的, 感覺後續可以專門開一篇文章來講解。
看名稱, 就知道是用來生成註釋用的。
預設配置:
<commentGenerator >
<property name="suppressAllComments" value="false"/>
<property name="suppressDate" value="false"/>
<property name="addRemarkComments" value="false"/>
</commentGenerator>
suppressAllComments: 阻止生成註釋, 預設值是false。
suppressDate: 阻止生成的註釋包含時間戳, 預設為false。
addRemarkComments: 註釋中新增資料庫的註釋, 預設為 false。
還有一個就是我們可以通過 type 屬性指定我們自定義的註解實現類, 生成我們自己想要的註解。自定義的實現類需要實現 org.mybatis.generator.api.CommentGenerator。
總結
小編總結了2020面試題,這份面試題的包含的模組分為19個模組,分別是: Java 基礎、容器、多執行緒、反射、物件拷貝、Java Web 、異常、網路、設計模式、Spring/Spring MVC、Spring Boot/Spring Cloud、Hibernate、MyBatis、RabbitMQ、Kafka、Zookeeper、MySQL、Redis、JVM 。
關注我的公眾號:程式設計師白楠楠,獲取上述資料。