栏目分类

热点资讯

你的位置:欧冠体育下载首页注册 > 行业新闻 >

Maven Archetype 多 Module 自定义代码脚手架

发布日期:2022-08-07 09:19    点击次数:142

大部份公司都市有一个通用的模板名目,协助你倏地创立一个名目。平日,这个名目需求集成一些公司外部的中央件、单元测试、标准的代码名目、通用的代码分层等等。

来日诰日,就行使 Maven 的 Archetype 插件来简俭朴现这一功用。

经由过程上面的图很清楚可以或许看到,理论行使这个插件机制就俭朴的几个步伐:

archetype:create-from-project ,痛处自身的名目代码生成原型名目

经由过程 install 等敕令生成原型文件

archetype:generate,经由过程原型生成目标名目

看起来挺俭朴的,然则你会缔造你用网上搜到的材料来玩的话,你生成的名目特殊傻X,蕴含平易近间的文档,我也真是没搞显然他们为什么那末牛逼,一步两步。。就他妈好了?

一堆成就,比喻 module 名称不会变、包名变了代码中没变,寄托报错一大堆成就,照旧有须要说下中央要怎么做的。

创立Archetype

首先,操办好我们自身的模板名目,担保代码都是OK的。

进入名目根目录,执行敕令:

mvn archetype:create-from-project 

尔后名目根目录下会生成target文件夹,这个很俭朴,不会有任何阴碍,你看上面的图,留心看每个模块的名字,这是我自新的!!

你生成该当会缔造他不长这样,这就是成就啊!接着往下看吧。

这里最焦点的部份就在于怎么编削target/generated-sources/src/main/resources/archetype-resources下的文件。

假定不编削间接延续的话,终究生成的名目会缔造module的名称不会变,包名也不会变,代码里引用的会有一堆报错。

接着,行业新闻我们看看咋改的,这一堆破成就。

编削父pom

首先,找到根目录的pom文件,会缔造缺乏module信息,这个必须加之。

<modules>  <module>${rootArtifactId}-client</module>  <module>${rootArtifactId}-co妹妹on</module>  <module>${rootArtifactId}-service</module>  <module>${rootArtifactId}-facade</module>  <module>${rootArtifactId}-starter</module> </modules

 

父pom寄托引用的每个module也要编削,groupId 和 artifactId 根据我给出的要领来改,不要写死!!

<dependencyManagement>   <dependencies>    <dependency>     <groupId>${groupId}</groupId>     <artifactId>${rootArtifactId}-client</artifactId>     <version>${project.version}</version>    </dependency>    ... ...   </dependencies>  </dependencyManagement

 

 

编削module

这个就是图中的成就,默认生成的module可以或许就是模板名目标名字,需求编削成近似__rootArtifactId__-client这类模式,留心是双下划线。

尔后module中的彼此引用 groupId 和 artifactId 根据父 pom 的要领对应编削。

archetype-metadata 编削

找到META-INF/maven/archetype-metadata.xml文件,编削modules相干的部份,重点留心看 id 、dir、name 的编削要领。

<modules>     <module id="${rootArtifactId}-client" dir="__rootArtifactId__-client" name="${rootArtifactId}-client">       <fileSets>         <fileSet filtered="true" packaged="true" encoding="UTF-8">           <directory>src/main/java</directory>           <includes>             <include>**/*.java</include>           </includes>         </fileSet>       </fileSets>     </module>     ... ... </modules>     

 

编削实现当前,进入 target/generated-sources/archetype目录,执行敕令:

mvn install 

顺便执行下mvn deploy上传到nexus。

运用Archetype

颠末上面的步伐,原型 Archetype 已经创立实现,着实最大的坑也就是上面那部份,花了老半天时候,几近坑爹啊。

上面看看怎么运用吧,两种运用要领。

敕令行

恣意进入你想生活生涯名目标门路,执行敕令。

mvn archetype:generate -DarchetypeCatalog=local 

顺次根据提示输入 groupId、artifactId 即可实现创立。

那怎么给其余人运用?

你的外埠maven货仓旅馆目录(比喻~/.m2/repository)有一个文件archetype-catalog.xml,同享给其余人就好了。

<?xml version="1.0" encoding="UTF-8"?> <archetype-catalog xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0 http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd"     xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0"     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">   <archetypes>     <archetype>       <groupId>com.example</groupId>       <artifactId>template-archetype</artifactId>       <version>1.0.0-SNAPSHOT</version>       <description>Example Project</description>     </archetype>   </archetypes> </archetype-catalog> 

 

 

 

IDEA

新建名目,抉择 Maven,勾选 Create from archetype,抉择 Add Archetype...

接着,输入我们自定义的 Archetype 的 GroupId、ArtifactId、Version 信息。

 

Add 告成当前就能在列表中看到我们自身的 archetype,尔后根据流程创立即可。

 



我的网站