（转）Maven之自定义archetype生成项目骨架

2022-09-11 16:03:40

背景：最近在开发一个项目的基础构件，在以后项目的开发过程中可以直接使用该构件快速的生成项目骨架进行开发。

摘要：使用过Maven的人都知道maven中有许多功能都是通过插件来提供的，今天我们来说一下其中的一个插件：maven-archetype-plugin

，通过该插件可以自定义符合我们自己需求的archetype。

一:什么是Archetype

总之，原型是一个Maven项目模板工具包，也就是一个模板工程。

二：使用archetype创建项目

mvn archetype:generate

上面的命令执行后会输出很多maven官方提供的archetype，但是这些archetype生成的项目骨架都不能够满足我们的需求，所以这就需要我们自己开发一个archetype来满足我们自己的开发需求，下面我把我自己自定义这个archetype的过程记录一下方便日后回忆。

三：创建自定义的archetype项目

1.首先使用sts(spring的一款开发工具，下载地址到spring官网)创建一个maven project，然后把配置好的一些公用的东西放到相应的目录下面比如说会将一些常用的java代码存放到src/main/java目录下面；会将一些通用的配置文件放到src/main/resources目录下面；如果是javeEE工程，还会有一些jsp等等的文件存放到src/main/webapp目录下面，如下图所示:

2.然后在创建的maven project的pom.xml文件中添加archetype插件，如下面所示：

<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>  

    <parent>

        <groupId>org.micaicms</groupId>

        <artifactId>micaicms-pom</artifactId>

        <version>1.0</version>

    </parent>  

    <artifactId>micaicms-web-archetype</artifactId>

    <packaging>jar</packaging>  

    <name>micaicms web archetype</name>

    <description>micaicms-web-archetype</description>  

    <distributionManagement>

        <repository>

            <id>releases</id>

            <name>Micaicms Releases</name>

            <url>http://127.0.0.1:8081/nexus/content/repositories/releases/</url>

        </repository>

        <snapshotRepository>

            <id>snapshots</id>

            <name>Micaicms Releases</name>

            <url>http://127.0.0.1:8081/nexus/content/repositories/snapshots/</url>

        </snapshotRepository>

    </distributionManagement>  

    <build>

        <pluginManagement>

            <plugins>

                <plugin>

                    <groupId>org.apache.maven.plugins</groupId>

                    <artifactId>maven-archetype-plugin</artifactId>

                    <version>2.2</version>

                </plugin>

                <plugin>

                    <groupId>org.apache.maven.plugins</groupId>

                    <artifactId>maven-compiler-plugin</artifactId>

                    <configuration>

                        <source>1.5</source>

                        <target>1.5</target>

                    </configuration>

                </plugin>

                <plugin>

                    <groupId>org.apache.maven.plugins</groupId>

                    <artifactId>maven-resources-plugin</artifactId>

                    <configuration>

                        <encoding>UTF-8</encoding>

                    </configuration>

                </plugin>

            </plugins>

        </pluginManagement>

    </build>  

</project>

3.运行你自己配置好的自定义的archetype项目

先执行

mvn clean install

安装该archetype项目到你的本地仓库

发布该archetype项目到你的本地私服(nexus)
ps：这里如果你需要发布这个archetype到你的本地私服上去，那么需要在maven里面配置权限，主要是maven里面的settings.xml文件，我
的settings.xml文件配置如下，配置好以后就可以执行发布命令了

再执行

mvn deploy

4.查看你刚才发布到nexus私服上去的archetype，如下图：

四：在eclipse/sts开发工具中配置你发布到私服上的自定义的archetype

1.打开你的开发工具，eclipse或者sts，我这里是sts

2.选择Window->Preferences->Maven->Archetypes

3.点击Add Remote Catalog，输入你的nexus私服中archetype的地址，我这里是
http://127.0.0.1:8081/nexus/content/groups/public/archetype-catalog.xml
输入Description，随便输入都可以，我这里是micaicms-web-archetype