Maven 外掛

資料庫 Maven MyBatis · 發表 2018-10-18 23:27:11

摘要： Maven本質上是一個外掛框架，它的核心並不執行任何具體的構建任務，所有這些任務都交給外掛來完成。概念模型 Maven 有以下三個標準的生命週期： clean：專案清理的處理 default(或 build)：專案部...

Maven本質上是一個外掛框架，它的核心並不執行任何具體的構建任務，所有這些任務都交給外掛來完成。

概念模型

Maven 有以下三個標準的生命週期：

clean： 專案清理的處理
default(或 build)： 專案部署的處理
site： 專案站點文件建立的處理

每個生命週期中都包含著一系列的階段(phase)。這些 phase 就相當於 Maven 提供的統一的介面，然後這些 phase 的實現由 Maven 的外掛來完成。

認識上述Maven外掛的基本概念能幫助你理解Maven的工作機制，不過要想更高效率地使用Maven，瞭解一些常用的外掛還是很有必要的，這可以幫助你避免一不小心重新發明輪子。多年來Maven社群積累了大量的經驗，並隨之形成了一個成熟的外掛生態圈。

Maven官方有兩個外掛列表：

ofollow,noindex">http://maven.apache.org/plugins/index.html 。
http://mojo.codehaus.org/plugins.html 。

我們在輸入 mvn 命令的時候比如 mvn clean ， clean 對應的就是 Clean 生命週期中的 clean 階段。但是 clean 的具體操作是由 maven-clean-plugin 來實現的。

所以說 Maven 生命週期的每一個階段的具體實現都是由 Maven 外掛實現的。

Maven 實際上是一個依賴外掛執行的框架，每個任務實際上是由外掛完成。Maven 外掛通常被用來：

建立 jar 檔案
建立 war 檔案
編譯程式碼檔案
程式碼單元測試
建立工程文件
建立工程報告
外掛通常提供了一個目標的集合，並且可以使用下面的語法執行：

mvn [plugin-name]:[goal-name]

例如，一個 Java 工程可以使用 maven-compiler-plugin 的 compile-goal 編譯，使用以下命令：

mvn compiler:compile

Maven 提供了下面兩種型別的外掛：

型別	描述
Build plugins	在構建時執行，並在 pom.xml 的元素中配置。
Reporting plugins	在網站生成過程中執行，並在 pom.xml 的元素中配置。

下面是一些常用外掛的列表：

外掛	描述
clean	構建之後清理目標檔案。刪除目標目錄。
compiler	編譯 Java 原始檔。
surefile	執行 JUnit 單元測試。建立測試報告。
jar	從當前工程中構建 JAR 檔案。
war	從當前工程中構建 WAR 檔案。
javadoc	為工程生成 Javadoc。
antrun	從構建過程的任意一個階段中執行一個 ant 任務的集合。

除了這些核心外掛之外，還有很多優秀的第三方外掛，可以幫助我們快捷、方便的構架專案。當使用到某些功能或者特性的時候多加搜尋，往往得到讓你驚喜的效果。

例如，專案中使用了 Mybatis ，就有一款神奇的maven外掛，執行一個命令，就可以根據資料庫的表，自動生成 Mybatis 的 mapper 配置檔案以及DAO層介面模板。

在 pom.xml 中新增 plugin ：

<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<configurationFile>src/main/resources/mybatis-generator/generatorConfig.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.2</version>
</dependency>
</dependencies>
</plugin>

定義 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>
<!-- 可以用於載入配置項或者配置檔案，在整個配置檔案中就可以使用${propertyKey}的方式來引用配置項
resource：配置資源載入地址，使用resource，MBG從classpath開始找，比如com/myproject/generatorConfig.properties
url：配置資源載入地質，使用URL的方式，比如file:///C:/myfolder/generatorConfig.properties.
注意，兩個屬性只能選址一個;

另外，如果使用了mybatis-select-maven-plugin，那麼在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用
<properties resource="" url="" />
 -->

 <!-- 在MBG工作的時候，需要額外載入的依賴包
location屬性指明載入jar/zip包的全路徑
<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" 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"/>

<!-- beginningDelimiter和endingDelimiter：指明資料庫的用於標記資料庫物件名的符號，比如ORACLE就是雙引號，MYSQL預設是`反引號； -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

<!-- 必須要有的，使用這個配置連結資料庫
@TODO:是否可以擴充套件
-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
<!-- 這裡面可以設定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._520it.mybatis.domain" 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._520it.mybatis.domain.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="com._520it.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
-->
<javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" 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，否則，如果資料庫的識別符號使用小寫的，那麼MBG自動把表名變成小寫再查詢；
4，否則，使用指定的大小寫格式查詢；
另外的，如果在建立表的時候，使用的""把資料庫物件規定大小寫，就算資料庫識別符號是使用的大寫，在這種情況下也會使用給定的大小寫來建立表名；
這個時候，請設定delimitIdentifiers="true"即可保留大小寫格式；

可選：
1，schema：資料庫的schema；
2，catalog：資料庫的catalog；
3，alias：為資料表設定的別名，如果設定了alias，那麼生成的所有的SELECT SQL語句中，列名會變成：alias_actualColumnName
4，domainObjectName：生成的domain類的名字，如果不設定，直接使用表名作為domain類的名字；可以設定為somepck.domainName，那麼會自動把domainName類再放到somepck包裡面；
5，enableInsert（預設true）：指定是否生成insert語句；
6，enableSelectByPrimaryKey（預設true）：指定是否生成按照主鍵查詢物件的語句（就是getById或get）；
7，enableSelectByExample（預設true）：MyBatis3Simple為false，指定是否生成動態查詢語句；
8，enableUpdateByPrimaryKey（預設true）：指定是否生成按照主鍵修改物件的語句（即update)；
9，enableDeleteByPrimaryKey（預設true）：指定是否生成按照主鍵刪除物件的語句（即delete）；
10，enableDeleteByExample（預設true）：MyBatis3Simple為false，指定是否生成動態刪除語句；
11，enableCountByExample（預設true）：MyBatis3Simple為false，指定是否生成動態查詢總條數語句（用於分頁的總條數查詢）；
12，enableUpdateByExample（預設true）：MyBatis3Simple為false，指定是否生成動態修改語句（只修改物件中不為空的屬性）；
13，modelType：參考context元素的defaultModelType，相當於覆蓋；
14，delimitIdentifiers：參考tableName的解釋，注意，預設的delimitIdentifiers是雙引號，如果類似MYSQL這樣的資料庫，使用的是`（反引號，那麼還需要設定context的beginningDelimiter和endingDelimiter屬性）
15，delimitAllColumns：設定是否所有生成的SQL中的列名都使用識別符號引起來。預設為false，delimitIdentifiers參考context的屬性

注意，table裡面很多引數都是對javaModelGenerator，context等元素的預設屬性的一個複寫；
-->
<table tableName="userinfo" >

<!-- 參考 javaModelGenerator 的 constructorBased屬性-->
<property name="constructorBased" value="false"/>

<!-- 預設為false，如果設定為true，在生成的SQL中，table名字不會加上catalog或schema； -->
<property name="ignoreQualifiersAtRuntime" value="false"/>

<!-- 參考 javaModelGenerator 的 immutable 屬性 -->
<property name="immutable" value="false"/>

<!-- 指定是否只生成domain類，如果設定為true，只生成domain類，如果還配置了sqlMapGenerator，那麼在mapper XML檔案中，只生成resultMap元素 -->
<property name="modelOnly" value="false"/>

<!-- 參考 javaModelGenerator 的 rootClass 屬性 
<property name="rootClass" value=""/>
-->

<!-- 參考javaClientGenerator 的rootInterface 屬性
<property name="rootInterface" value=""/>
-->

<!-- 如果設定了runtimeCatalog，那麼在生成的SQL中，使用該指定的catalog，而不是table元素上的catalog 
<property name="runtimeCatalog" value=""/>
-->

<!-- 如果設定了runtimeSchema，那麼在生成的SQL中，使用該指定的schema，而不是table元素上的schema 
<property name="runtimeSchema" value=""/>
-->

<!-- 如果設定了runtimeTableName，那麼在生成的SQL中，使用該指定的tablename，而不是table元素上的tablename 
<property name="runtimeTableName" value=""/>
-->

<!-- 注意，該屬性只針對MyBatis3Simple有用；
如果選擇的runtime是MyBatis3Simple，那麼會生成一個SelectAll方法，如果指定了selectAllOrderByClause，那麼會在該SQL中新增指定的這個order條件；
-->
<property name="selectAllOrderByClause" value="age desc,username asc"/>

<!-- 如果設定為true，生成的model類會直接使用column本身的名字，而不會再使用駝峰命名方法，比如BORN_DATE，生成的屬性名字就是BORN_DATE,而不會是bornDate -->
<property name="useActualColumnNames" value="false"/>


<!-- generatedKey用於生成生成主鍵的方法，
如果設定了該元素，MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素，該元素可選
column:主鍵的列名；
sqlStatement：要生成的selectKey語句，有以下可選項：
Cloudscape:相當於selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL()
DB2:相當於selectKey的SQL為： VALUES IDENTITY_VAL_LOCAL()
DB2_MF:相當於selectKey的SQL為：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
Derby:相當於selectKey的SQL為：VALUES IDENTITY_VAL_LOCAL()
HSQLDB:相當於selectKey的SQL為：CALL IDENTITY()
Informix:相當於selectKey的SQL為：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
MySql:相當於selectKey的SQL為：SELECT LAST_INSERT_ID()
SqlServer :相當於selectKey的SQL為：SELECT SCOPE_IDENTITY()
SYBASE:相當於selectKey的SQL為：SELECT @@IDENTITY
JDBC:相當於在生成的insert元素上新增useGeneratedKeys="true"和keyProperty屬性
<generatedKey column="" sqlStatement=""/>
-->

<!-- 
該元素會在根據表中列名計算物件屬性名之前先重新命名列名，非常適合用於表中的列都有公用的字首字串的時候，
比如列名為：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等；
那麼就可以設定searchString為"^CUST_"，並使用空白替換，那麼生成的Customer物件中的屬性名稱就不是
custId,custName等，而是先被替換為ID,NAME,EMAIL,然後變成屬性：id，name，email；

注意，MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的，
如果使用了columnOverride元素，該屬性無效；

<columnRenamingRule searchString="" replaceString=""/>
-->


<!-- 用來修改表中某個列的屬性，MBG會使用修改後的列來生成domain的屬性；
column:要重新設定的列名；
注意，一個table元素中可以有多個columnOverride元素哈~
-->
<columnOverride column="username">
<!-- 使用property屬性來指定列要生成的屬性名稱 -->
<property name="property" value="userName"/>

<!-- javaType用於指定生成的domain的屬性型別，使用型別的全限定名
<property name="javaType" value=""/>
-->

<!-- jdbcType用於指定該列的JDBC型別 
<property name="jdbcType" value=""/>
-->

<!-- typeHandler 用於指定該列使用到的TypeHandler，如果要指定，配置型別處理器的全限定名
注意，mybatis中，不會生成到mybatis-config.xml中的typeHandler
只會生成類似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的引數描述
<property name="jdbcType" value=""/>
-->

<!-- 參考table元素的delimitAllColumns配置，預設為false
<property name="delimitedColumnName" value=""/>
-->
</columnOverride>

<!-- ignoreColumn設定一個MGB忽略的列，如果設定了改列，那麼在生成的domain中，生成的SQL中，都不會有該列出現 
column:指定要忽略的列的名字；
delimitedColumnName：參考table元素的delimitAllColumns配置，預設為false

注意，一個table元素中可以有多個ignoreColumn元素
<ignoreColumn column="deptId" delimitedColumnName=""/>
-->
</table>

</context>

</generatorConfiguration>

Maven 外掛

您可能也會喜歡…