创建并使用maven archetype的随笔

maven骨架archetype的意义在于一些项目的基础项：如引入的maven组件，例如eureka，ribben等，不希望每次新建项目都重复做一遍，还有例如公司规范的log格式，单元测试工具等，在新建项目的时候，希望可以将这些自定义的东西一键生成。这里就简单的讲解一下maven管理的java Spring Boot的项目，如何建立骨架并使用。

建立样例项目

参见Spring boot的官网，然后可以引入一些需要的组件，并做一些必要的修改。

生成项目骨架

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

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

<addDefaultExcludes>false</addDefaultExcludes>

</configuration>

</plugin>

使用命令行，在项目根目录调用：mvn archetype：create-from-project
生成target目录，target目录下：target/generated-sources/archetype就是真正的骨架项目，有对应的pom文件，src下有生成骨架相关的resource资源，这些资源就来自于原项目

如果要调整骨架中生成的具体项目文件，需要更改对应的文件

示例：/user-user/user-user-server/pom.xml

<groupId>com.hzphfin.user.user</groupId>

<version>${project.version}</version>

</dependency>

<groupId>com.hzphfin.user.user</groupId>

<artifactId>user-user-service</artifactId>

<version>${project.version}</version>

</dependency>

在骨架中被手工修改为：

<groupId>${groupId}</groupId>

<artifactId>${rootArtifactId}-api</artifactId>

<version>${project.version}</version>

</dependency>

<groupId>${groupId}</groupId>

<artifactId>${rootArtifactId}-service</artifactId>

<version>${project.version}</version>

</dependency>

如对目录及原忽略一些文件，要修改/target/generated-sources/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml

示例：modules相关目录修改如下

</module>

</module>

</module>

</module>

</modules>

maven archetype默认会有以下一些build-in的变量，用这些变量替换文件中的原有的值

${rootArtifactId}	controller
${artifactId}	controller-(api,dao,server,service)
${package}
${packageInPathFormat}
${groupId}	com.hzphfin.app
${version}	0.0.1-SNAPSHOT

示例：

<groupId>com.hzphfin.app</groupId>

<artifactId>controller</artifactId>

<version>0.0.1-SNAPSHOT</version>

变为：

<groupId>${groupId}</groupId>

<artifactId>${artifactId}</artifactId>

<version>${version}</version>

如果是目录名更改时使用变量，使用类似这样的结构：__artifactId__
如果要自定义一些替换的变量，需在/target/generated-sources/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml加入如下的key-value

</requiredProperty>

</requiredProperties>