Maven Archetype脚手架制作

Maven 脚手架开发

maven的功能都是基于插件来实现的，脚手架也是maven的一个插件：Maven Archetype Plugin，
使用者可以选择是交互式还是批处理的方式调用脚手架来生成java工程目录及文件结构

源文件模板

源文件模板路径：resources/archetype-resources，下面的文件可以作为模板生成目标文件，其中模板文件里面可以表达式变量如：${package}

脚手架配置文件

脚手架配置文件文件路径：resources/META-INF.maven/archetype-metadata.xml，文件格式如下：

<?xml version="1.0" encoding="UTF-8" ?>
<archetype-descriptor name="sample">
    <fileSets>
        <!-- filtered=true表示对该目录下应用表达式替换参数，packaged=true表示要放在src/main/java/${package}下面 -->
        <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>**/*.*</include>
            </includes>
        </fileSet>
        <fileSet filtered="true" packaged="false">
            <directory></directory>
            <includes>
                <!-- 生下划线开头结尾表示文件名要用变量替换 -->
                <include>__gitignore__</include>
            </includes>
        </fileSet>
    </fileSets>

    <requiredProperties>
        <requiredProperty key="groupId">
            <!-- 设置默认值 -->
            <defaultValue>me.tuyou.xxx</defaultValue>
        </requiredProperty>
        <requiredProperty key="gitignore">
            <defaultValue>.gitignore</defaultValue>
        </requiredProperty>
    </requiredProperties>
</archetype-descriptor>

安装脚手架

mvn clean install

自动索引本地仓库的脚手架

扫描本地repository的所有jar包，生成脚手架列表，生成的文件位置$MAVEN_HOME/repository/archetype-catalog.xml

mvn archetype:crawl

从脚手架创建工程

无参命令会让出现一个列表，让你选择从哪个脚手架创建，并用交互的方式填入一些参数

mvn archetype:generate

直接从远程的脚手架创建

mvn archetype:generate -DarchetypeGroupId=me.tuyou.xxx -DarchetypeArtifactId=my-maven-archetype -DarchetypeVersion=1.0.0-SNAPSHOT -DarchetypeCatalog=internal

archetypeCatalog的可能值

• internal：表示内置的脚手架列表，约58个
• local：表示~/.m2/archetype-catalog.xml配置的脚手架列表
• remote：表示中央仓库配置的脚手架列表
• file://xxxx：本机任意位置的archetype-catalog.xml文件
• http://xxxx：远程任意位置的archetype-catalog.xml文件

编写本地的脚手架列表

用于在执行mvn archetype:generate时候选择的列表，文件路径：~/.m2/archetype-catalog.xml，就是如下文件提供：

<?xml version="1.0" encoding="UTF-8"?>
<archetype-catalog xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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">
    <archetypes>
        <archetype>
            <groupId>me.tuyou.maven.archetype</groupId>
            <artifactId>my-maven-archetype</artifactId>
            <version>1.0-SNAPSHOT</version>
        </archetype>
    </archetypes>
</archetype-catalog>

架手架实例：https://gitee.com/tuyouyr/maven-archetype