Maven Archetype使用——自定義項目模板

Maven Archetype可以理解成Maven項目的模板，相信各位或多或少都是用過。我們剛開始學習maven創建項目時，經常會使用常規的Maven項目模板，例如maven-archetype-quickstart、maven-archetype-webapp；你只需要提供基本的元素（如groupId,artifactId與version等），項目模板就能生成項目的基本結構與POM文件。

在日常工作開發中，項目架手腳搭建是很常見，每次新起一個項目，我們就要進行各種項目配置，其實本質來說項目的基礎架構都是大同小異的，所以一般公司開發都會自定義自己的項目模板，有了自定義項目模板，可以快速搭建我們的項目。

一.Maven archetype plugin的瞭解與使用

注：以下內容是基於Maven 3進行說明

1.使用archetype的一些步驟

Maven使用archetype命令 mvn archetype:generate

在控制檯輸入該命令可以看到Archetype插件會輸出一個Archetype列表供用戶選擇，默認是maven-archetype-quickstart模板。使用maven-archetype-quickstart按回車，下一步就是需要提供一些基本的參數，主要有：

groupId：想要創建項目的groupId
artifactId：想要創建項目的artifactId
version：想要創建項目的version
package：想要創建項目默認的包名

上述的參數是最常規的，當我們自定義Archetype時，還可以配置額外的配置參數。

根據提示填寫好配置後，Archetype插件就會生成項目的骨架。

2.批處理方式使用archetype

有時候用戶覺得交互式使用Archetype很麻煩，想一次性輸入指令來生成項目架構而不想被交互式破壞。用戶可以使用mvn命令的-B選項，要求maven-archetype-plugin以批處理方式運行。不過這樣用戶要顯示聲明要使用的Archetype座標信息，以及要創建項目的groupId、artifactId、version、package等信息，若是Archetype是自定義的，還要輸入自己的額外配置參數。例如：

mvn archetype:generate -B \
-DgroupId=com.yibaiwu.demo \
-DartifactId=demo \ 
-Dversion=1.0.0-SNAPSHOT \
-Dpackage=com.yibaiwu.demo \ 
-DarchetypeArtifactId=yibaiwu-archetype-plugin \
-DarchetypeGroupId=com.alias \
-DarchetypeVersion=1.0-SNAPSHOT \

archetypeArtifactId：Archetype的groupId
archetypeGroupId：Archetype的artifactId
archetypeVersion：Archetype的version

3.編寫Archetype

下面就介紹一個自定義Archetype的例子。

如上圖所示，一個典型的Archetype Maven項目主要包括這幾個部分：

pom.xm：Archetype自身的POM
src/main/resources/achetype-resource/pom.xml：基於該Archetype生成的項目的POM原型
src/main/resources/META-INF/maven/achetype-metadata.xml：Archetype的描述文件。
src/main/resources/archetype-resources/**：其他需要包含在Archetype中的內容，常規的有我們自定編寫的一些樣例代碼、配置文件等。

和其他Maven項目一樣，Archetype項目本省也是需要pom.xml文件，該文件包含Archetype的座標信息，這樣Maven才能定位使用它。

<?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.alias</groupId>
    <artifactId>yibaiwu-archetype-plugin</artifactId>
    <version>1.0-SNAPSHOT</version>
</project>

接下來，就是配置Archetype所包含的項目骨架信息，一般編寫Archetype時預定義好其要包含的目錄結構和文件，同時在必要的地方使用可配置的屬性聲明代替硬編碼。例如，我們的項目座標信息一般是可配置的。以下是一個簡單的POM原型：

<?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>${groupId}</groupId>
    <artifactId>${artifactId}</artifactId>
    <version>${version}</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-source-plugin</artifactId>
                    <version>3.0.1</version>
                </plugin>
                <plugin>
                    <artifactId>maven-deploy-plugin</artifactId>
                    <configuration>
                        <skip>true</skip>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

接下來就是Archetype最核心的部分，archetype-metadata.xml描述符文件，它位於Archetype項目資源目錄的META-INF/maven/子目錄下，其主要作用是：一聲明哪些目錄及文件應該包含在Archetype中；二是這個Archetype使用哪些屬性參數。以下是一個Archetype描述符文件。

<?xml version="1.0" encoding="UTF-8"?>
<archetype-descriptor name="sample">
    <fileSets>
        <fileSet filtered="true" packaged="true">
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.java</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" packaged="true">
            <directory>src/test/java</directory>
            <includes>
                <include>**/*.java</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" packaged="false">
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
            </includes>
        </fileSet>
    </fileSets>
    <requiredProperties>
        <requiredProperty key="groupId">
            <defaultValue>com.yibaiwu</defaultValue>
        </requiredProperty>
    </requiredProperties>
</archetype-descriptor>

如果fileSet的packaged屬性值爲true，diretory的值爲X，那麼archetype-resources下的X目錄就會對應地在生成的項目中被創建，在生成的X目錄下還會生成一個包目錄（及我們輸入的package）。如果fileSet的packaged屬性值爲false，那麼Archetype中X目錄下的內容會直接被複制到項目的X目錄下。一般來說，Java代碼都需要放到包路徑下，而項目資源文件則不需要。因此，對應的項目資源文件的fileSet的packaged屬性爲false。

fileSet的filtered屬性標識使用參數值替換屬性聲明，如下文件所示。

package ${package};

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication(scanBasePackages = {"${package}"})
@MapperScan("${package}.repository")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Archetype編寫完成後，使用maven install將其安裝到本地倉庫，也可以打包上傳到私服。接着用戶就可以通過制定該Archetype的座標用它生成項目了：

mvn archetype:generate \
-DgroupId=com.yibaiwu.demo -DartifactId=demo \ 
-Dversion=1.0.0-SNAPSHOT \
-Dpackage=com.yibaiwu.demo \ 
-DarchetypeArtifactId=yibaiwu-archetype-plugin \
-DarchetypeGroupId=com.alias \
-DarchetypeVersion=1.0-SNAPSHOT \

4.配置archetype-metadata.xml生成多項目模塊代碼

有時候，我們在搭建項目時，對項目進行拆分，劃分成不同的模塊。此處，我們修改archetype-metadata.xml文件，使之支持生成多個子模塊。參考文章：Multi-Module Maven Archetypes

生成多個子模塊的訣竅在於使用rootArtifactId,Archetype在生成應用時，將使用artifactId來替換他。

多模塊archetype的示例結構如下:

example-archetype
├── pom.xml
└── src
    ├── main
       └── resources
           ├── META-INF
           │   └── maven
           │       └── archetype-metadata.xml
           └── archetype-resources
               ├── __rootArtifactId__-module1
               │   ├── pom.xml
               │   └── src
               │       ├── main
               │       │   ├── java
               │       │   └── resources
               │       └── test
               │           └── java
               │           └── resources
               ├── __rootArtifactId__-module2
               │   ├── pom.xml
               │   └── src
               │       ├── main
               │       │   ├── java
               │       │   └── resources
               │       └── test
               │           └── java
               │           └── resources
               └── pom.xml

archetype-resources目錄下，被創建的項目的父pom文件：

<groupId>${groupId}</groupId>
<artifactId>${artifactId}</artifactId>
<version>${version}</version>
<packaging>pom</packaging>

<modules>
    <module>${rootArtifactId}-module1</module>
    <module>${rootArtifactId}-module2</module>
</modules>

子模塊1的POM文件：

<parent>
    <groupId>${groupId}</groupId>
    <artifactId>${rootArtifactId}</artifactId>
    <version>${version}</version>
</parent>

<artifactId>${artifactId}</artifactId>
<packaging>jar</packaging>

子模塊2的POM文件

<parent>
    <groupId>${groupId}</groupId>
    <artifactId>${rootArtifactId}</artifactId>
    <version>${version}</version>
</parent>

<artifactId>${artifactId}</artifactId>
<packaging>jar</packaging>

<dependencies>
    <dependency>
        <groupId>${groupId}</groupId>
        <artifactId>${rootArtifactId}-module1</artifactId>
        <version>${version}</version>
    </dependency>
</dependencies>

archetype-metadata.xml文件：

<archetype-descriptor name="${artifactId}">
  <modules>
    <module id="${rootArtifactId}-module1" dir="__rootArtifactId__-module1" name="${rootArtifactId}-module1">
        <fileSets>
            <fileSet filtered="true" packaged="true" encoding="UTF-8">
                <directory>src/main/java</directory>
            </fileSet>
            <fileSet encoding="UTF-8">
                <directory>src/main/resources</directory>
            </fileSet>
            <fileSet filtered="true" packaged="true" encoding="UTF-8">
                <directory>src/test/java</directory>
            </fileSet>
             <fileSet encoding="UTF-8">
                <directory>src/test/resources</directory>
             </fileSet>
        </fileSets>
    </module>
    <module id="${rootArtifactId}-module2" dir="__rootArtifactId__-module2" name="${rootArtifactId}-module2">
        <fileSets>
            <fileSet filtered="true" packaged="true" encoding="UTF-8">
                <directory>src/main/java</directory>
            </fileSet>
            <fileSet encoding="UTF-8">
                <directory>src/main/resources</directory>
            </fileSet>
            <fileSet filtered="true" packaged="true" encoding="UTF-8">
                <directory>src/test/java</directory>
            </fileSet>
             <fileSet encoding="UTF-8">
                <directory>src/test/resources</directory>
             </fileSet>
        </fileSets>
    </module>
  </modules>
</archetype-descriptor>

id：相當於工程的artifactId.
dir：相當於工程源文件在archetype-resources裏對應的directory.
name：模塊的名字.

修改完成後，使用方法也和上面一樣，將項目install到本地，然後執行mvn archetype：generate命令：

mvn archetype:generate \
-DgroupId=com.yibaiwu.demo \
-DartifactId=demo \ 
-Dversion=1.0.0-SNAPSHOT \
-Dpackage=com.yibaiwu.demo \ 
-DarchetypeArtifactId=yibaiwu-archetype-plugin \
-DarchetypeGroupId=com.alias \
-DarchetypeVersion=1.0-SNAPSHOT \

Maven Archetype使用——自定義項目模板

一.Maven archetype plugin的瞭解與使用

1.使用archetype的一些步驟

2.批處理方式使用archetype

3.編寫Archetype

4.配置archetype-metadata.xml生成多項目模塊代碼

多模塊archetype的示例結構如下:

archetype-resources目錄下，被創建的項目的父pom文件：

子模塊1的POM文件：

子模塊2的POM文件

archetype-metadata.xml文件：

這個網絡爬蟲代碼，拿到數據之後如何存到csv文件中去？

即刻放大鏡。跟隨鼠標，屏幕任意位置放大

【面試準備】【SQL】數據庫有哪些約束？

.NET開源強大、易於使用的緩存框架 - FusionCache

BGE M3-Embedding 模型介紹

面試，有時候是個運氣活

Linux上安裝mysql8.0.19

CnetOS7搭建Nexus3.X構建maven私服

微服務註冊中心之Eureka、Zookeeper、Consul

Consul UI訪問不了原因

Linux上安裝Consul

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結