Maven本質上是一個插件框架咐柜,它的核心并不執(zhí)行任何具體的構建任務,所有這些任務都交給插件來完成赞草。
Maven 有以下三個標準的生命周期:
- clean:項目清理的處理
- default(或 build):項目部署的處理
- site:項目站點文檔創(chuàng)建的處理
每個生命周期中都包含著一系列的階段(phase)四啰。這些 phase 就相當于 Maven 提供的統(tǒng)一的接口歇攻,然后這些 phase 的實現(xiàn)由 Maven 的插件來完成。
認識上述Maven插件的基本概念能幫助你理解Maven的工作機制亲桥,不過要想更高效率地使用Maven穴张,了解一些常用的插件還是很有必要的,這可以幫助你避免一不小心重新發(fā)明輪子两曼。多年來Maven社區(qū)積累了大量的經驗皂甘,并隨之形成了一個成熟的插件生態(tài)圈。
Maven官方有兩個插件列表:
我們在輸入 mvn
命令的時候 比如 mvn clean
,clean
對應的就是 Clean 生命周期中的 clean 階段户辫。但是 clean 的具體操作是由 maven-clean-plugin
來實現(xiàn)的渐夸。
所以說 Maven 生命周期的每一個階段的具體實現(xiàn)都是由 Maven 插件實現(xiàn)的。
Maven 實際上是一個依賴插件執(zhí)行的框架渔欢,每個任務實際上是由插件完成墓塌。Maven 插件通常被用來:
- 創(chuàng)建 jar 文件
- 創(chuàng)建 war 文件
- 編譯代碼文件
- 代碼單元測試
- 創(chuàng)建工程文檔
- 創(chuàng)建工程報告
插件通常提供了一個目標的集合,并且可以使用下面的語法執(zhí)行:
mvn [plugin-name]:[goal-name]
例如,一個 Java 工程可以使用 maven-compiler-plugin
的 compile-goal
編譯苫幢,使用以下命令:
mvn compiler:compile
Maven 提供了下面兩種類型的插件:
類型 | 描述 |
---|---|
Build plugins | 在構建時執(zhí)行访诱,并在 pom.xml 的 元素中配置。 |
Reporting plugins | 在網(wǎng)站生成過程中執(zhí)行韩肝,并在 pom.xml 的 元素中配置触菜。 |
下面是一些常用插件的列表:
插件 | 描述 |
---|---|
clean | 構建之后清理目標文件。刪除目標目錄哀峻。 |
compiler | 編譯 Java 源文件涡相。 |
surefile | 運行 JUnit 單元測試。創(chuàng)建測試報告剩蟀。 |
jar | 從當前工程中構建 JAR 文件催蝗。 |
war | 從當前工程中構建 WAR 文件。 |
javadoc | 為工程生成 Javadoc育特。 |
antrun | 從構建過程的任意一個階段中運行一個 ant 任務的集合丙号。 |
除了這些核心插件之外,還有很多優(yōu)秀的第三方插件且预,可以幫助我們快捷槽袄、方便的構架項目烙无。當使用到某些功能或者特性的時候多加搜索锋谐,往往得到讓你驚喜的效果。
例如截酷,項目中使用了Mybatis
涮拗,就有一款神奇的maven插件,運行一個命令迂苛,就可以根據(jù)數(shù)據(jù)庫的表三热,自動生成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:生成一組對象的環(huán)境
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" >
<!-- 自動識別數(shù)據(jù)庫關鍵字留储,默認false翼抠,如果設置為true,根據(jù)SqlReservedWords中定義的關鍵字列表获讳;
一般保留默認值阴颖,遇到數(shù)據(jù)庫關鍵字(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:指明數(shù)據(jù)庫的用于標記數(shù)據(jù)庫對象名的符號丐膝,比如ORACLE就是雙引號量愧,MYSQL默認是`反引號; -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<!-- 必須要有的帅矗,使用這個配置鏈接數(shù)據(jù)庫
@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數(shù)據(jù)類型紊馏;
-->
<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
<!--
true:使用BigDecimal對應DECIMAL和 NUMERIC數(shù)據(jù)類型
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模型創(chuàng)建器,是必須要的元素
負責:1暖哨,key類(見context的defaultModelType)赌朋;2凰狞,java類;3沛慢,查詢類
targetPackage:生成的類要放的包赡若,真實的包受enableSubPackages屬性控制;
targetProject:目標項目团甲,指定一個存在的目錄下逾冬,生成的內容會放到指定目錄中,如果目錄不存在躺苦,MBG不會自動建目錄
-->
<javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
<!-- for MyBatis3/MyBatis3Simple
自動為每一個生成的類創(chuàng)建一個構造方法身腻,構造方法包含了所有的field;而不是使用setter匹厘;
-->
<property name="constructorBased" value="false"/>
<!-- 在targetPackage的基礎上嘀趟,根據(jù)數(shù)據(jù)庫的schema再生成一層package,最終生成的類放在這個package下愈诚,默認為false -->
<property name="enableSubPackages" value="true"/>
<!-- for MyBatis3 / MyBatis3Simple
是否創(chuàng)建一個不可變的類她按,如果為true,
那么MBG會創(chuàng)建一個沒有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的基礎上慷妙,根據(jù)數(shù)據(jù)庫的schema再生成一層package,最終生成的類放在這個package下允悦,默認為false -->
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 對于mybatis來說膝擂,即生成Mapper接口,注意,如果沒有配置該元素架馋,那么默認不會生成Mapper接口
targetPackage/targetProject:同javaModelGenerator
type:選擇怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):
1狞山,ANNOTATEDMAPPER:會生成使用Mapper接口+Annotation的方式創(chuàng)建(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的基礎上,根據(jù)數(shù)據(jù)庫的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厉萝,一個用戶生成動態(tài)查詢的條件類(selectByExample, deleteByExample),可選榨崩;
6谴垫,Mapper接口(可選)
tableName(必要):要生成對象的表名;
注意:大小寫敏感問題母蛛。正常情況下翩剪,MBG會自動的去識別數(shù)據(jù)庫標識符的大小寫敏感度,在一般情況下彩郊,MBG會
根據(jù)設置的schema前弯,catalog或tablename去查詢數(shù)據(jù)表舞肆,按照下面的流程:
1,如果schema博杖,catalog或tablename中有空格椿胯,那么設置的是什么格式,就精確的使用指定的大小寫格式去查詢剃根;
2哩盲,否則,如果數(shù)據(jù)庫的標識符使用大寫的狈醉,那么MBG自動把表名變成大寫再查找廉油;
3,否則苗傅,如果數(shù)據(jù)庫的標識符使用小寫的抒线,那么MBG自動把表名變成小寫再查找;
4渣慕,否則嘶炭,使用指定的大小寫格式查詢;
另外的逊桦,如果在創(chuàng)建表的時候眨猎,使用的""把數(shù)據(jù)庫對象規(guī)定大小寫,就算數(shù)據(jù)庫標識符是使用的大寫强经,在這種情況下也會使用給定的大小寫來創(chuàng)建表名睡陪;
這個時候,請設置delimitIdentifiers="true"即可保留大小寫格式匿情;
可選:
1兰迫,schema:數(shù)據(jù)庫的schema;
2炬称,catalog:數(shù)據(jù)庫的catalog汁果;
3,alias:為數(shù)據(jù)表設置的別名转砖,如果設置了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,指定是否生成動態(tài)查詢語句劳坑;
8毕谴,enableUpdateByPrimaryKey(默認true):指定是否生成按照主鍵修改對象的語句(即update);
9距芬,enableDeleteByPrimaryKey(默認true):指定是否生成按照主鍵刪除對象的語句(即delete)涝开;
10,enableDeleteByExample(默認true):MyBatis3Simple為false框仔,指定是否生成動態(tài)刪除語句舀武;
11,enableCountByExample(默認true):MyBatis3Simple為false离斩,指定是否生成動態(tài)查詢總條數(shù)語句(用于分頁的總條數(shù)查詢)银舱;
12,enableUpdateByExample(默認true):MyBatis3Simple為false跛梗,指定是否生成動態(tài)修改語句(只修改對象中不為空的屬性)纵朋;
13靶擦,modelType:參考context元素的defaultModelType容燕,相當于覆蓋;
14请毛,delimitIdentifiers:參考tableName的解釋宪祥,注意聂薪,默認的delimitIdentifiers是雙引號,如果類似MYSQL這樣的數(shù)據(jù)庫蝗羊,使用的是`(反引號藏澳,那么還需要設置context的beginningDelimiter和endingDelimiter屬性)
15,delimitAllColumns:設置是否所有生成的SQL中的列名都使用標識符引起來耀找。默認為false翔悠,delimitIdentifiers參考context的屬性
注意,table里面很多參數(shù)都是對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=""/>
-->
<!--
該元素會在根據(jù)表中列名計算對象屬性名之前先重命名列名辉词,非常適合用于表中的列都有公用的前綴字符串的時候,
比如列名為: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}的參數(shù)描述
<property name="jdbcType" value=""/>
-->
<!-- 參考table元素的delimitAllColumns配置,默認為false
<property name="delimitedColumnName" value=""/>
-->
</columnOverride>
<!-- ignoreColumn設置一個MGB忽略的列脐瑰,如果設置了改列妖枚,那么在生成的domain中,生成的SQL中苍在,都不會有該列出現(xiàn)
column:指定要忽略的列的名字绝页;
delimitedColumnName:參考table元素的delimitAllColumns配置,默認為false
注意寂恬,一個table元素中可以有多個ignoreColumn元素
<ignoreColumn column="deptId" delimitedColumnName=""/>
-->
</table>
</context>
</generatorConfiguration>