自定义maven archetype

我们创建一个新的项目的时候，总免不了从原来做过的熟悉的项目copy文件过来，而且项目做多了，总会有一些习惯和经验要沉淀下来。所以我们可以做一个基础的代码框架，里面只有一些通用的文件，这时采用maven的archetype是一个很好的选择。

流程

创建包含基础文件和目录的项目->转换成archetype项目->安装到本地或者远程仓库->创建新项目的时候选择archetype

环境

jkd 1.8

maven 3.3.9

操作步骤

1.创建包含基础文件和目录的项目。

手动创建一个标准的maven web项目，名字暂且叫做web-archetype，目录如下

手动创建挺烦的，你可以用ide创建。目录里面最好是放一些你自己认为通用的文件，例如一些spring的配置文件什么的，如果目录是空的话，新生成的项目是不会创建这个目录的，我觉得这挺SB的。如果你没有什么可放，又想生成这个目录，那可以放一个readme.txt，来说明这个目录是干什么的，尽管这样做更SB。

编写pom.xml

<?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.jyz</groupId>
    <artifactId>web-base</artifactId>
    <version>1.0-SNAPSHOT</version>
	<packaging>war</packaging>
    
    <properties>
        <spring.version></spring.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    
    <dependencies>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>2.6</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>2.1</version>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <includeTypes>jar</includeTypes>
                    <overWriteSnapshots>true</overWriteSnapshots>
                    <type>jar</type>
                    <outputDirectory>${project.build.directory}/lib</outputDirectory>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-archetype-plugin</artifactId>
                <version>3.0.1</version>
            </plugin>
        </plugins>
    </build>

</project>

起决定作用的是maven-archetype-plugin这个插件，如果你不加的话， mvn archetype:create-from-project 这条命令无法执行，因为他不知道用哪个程序执行。

2.把上一步生成的代码框架转换成archetype项目

在项目根目录也就是有pom.xml的目录打开控制台执行mvn archetype:create-from-project，完后在自动生成的target\generated-sources\archetype目录下面执行mvn install,这会把archetype项目安装到本地仓库，同时在.m2\repository目录下面生成一个archetype-catalog.xml

这个文件在maven2中会生成在.m2目录，不知为何在maven3中要放到这个目录，导致后来遇到一个问题，就是基于archetype创建项目的时候找不到新生成的archetype，所以我们要把他copy到.m2目录

如果想让其他人也用到这个archetype，可以执行mvn deploy把他发布到远程仓库

如果要卸载这个archetype，那只需要在文件中删除相应的archetype

3.基于archetype创建项目。在你要创建新项目的目录下面执行mvn archetype:generate -DarchetypeCatalog=local,archetypeCatalog=local是让maven从本地仓库寻找archetype，这个参数有几个可选的值

local represents the ~/.m2/archetype-catalog.xml catalog file.
remote represents the http://repo.maven.apache.org/maven2/archetype-catalog.xml catalog file.

internal maven自带的archetype

还可以这样写

file://path/to/archetype-catalog.xml ：使用本地指定路径的文件.

http://url/to/archetype-catalog.xml ：使用远程路径的文件.

你根据提示填写数字或者标准格式com.jyz.web-base-archetype，这里需要注意的是，如果你没有把上面说到的archetype-catalog.xml文件放到.m2目录下面，他是无法显示你创建的archetype的，比较坑爹。根据提示一路操作下来项目就创建成功了。

如果使用 intellj idea，应该也能创建项目创建项目的时候可以看到archetype

在这个界面添加一个archetypeCatalog参数

但我用的时候出现一个问题，我已经让他从本地仓库寻找了，还是要从远程仓库寻找，这应该是idea的bug

操作就到这里，当然我创建的是一个最基本的web项目，你可以自己去完善属于自己的archetype